Struct aws_sdk_eks::client::Client

source · [−]
pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }
Expand description

Client for Amazon Elastic Kubernetes Service

Client for invoking operations on Amazon Elastic Kubernetes Service. Each operation on Amazon Elastic Kubernetes Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_eks::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_eks::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_eks::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the AssociateEncryptionConfig operation.

Constructs a fluent builder for the AssociateIdentityProviderConfig operation.

Constructs a fluent builder for the CreateAddon operation.

Constructs a fluent builder for the CreateCluster operation.

Constructs a fluent builder for the CreateFargateProfile operation.

Constructs a fluent builder for the CreateNodegroup operation.

Constructs a fluent builder for the DeleteAddon operation.

Constructs a fluent builder for the DeleteCluster operation.

Constructs a fluent builder for the DeleteFargateProfile operation.

Constructs a fluent builder for the DeleteNodegroup operation.

Constructs a fluent builder for the DeregisterCluster operation.

Constructs a fluent builder for the DescribeAddon operation.

Constructs a fluent builder for the DescribeAddonVersions operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the DescribeCluster operation.

Constructs a fluent builder for the DescribeFargateProfile operation.

Constructs a fluent builder for the DescribeIdentityProviderConfig operation.

Constructs a fluent builder for the DescribeNodegroup operation.

Constructs a fluent builder for the DescribeUpdate operation.

Constructs a fluent builder for the DisassociateIdentityProviderConfig operation.

Constructs a fluent builder for the ListAddons operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):

      The name of the cluster.

    • max_results(i32) / set_max_results(Option<i32>):

      The maximum number of add-on results returned by ListAddonsRequest in paginated output. When you use this parameter, ListAddonsRequest returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListAddonsRequest request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListAddonsRequest returns up to 100 results and a nextToken value, if applicable.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      The nextToken value returned from a previous paginated ListAddonsRequest where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

  • On success, responds with ListAddonsOutput with field(s):
    • addons(Option<Vec<String>>):

      A list of available add-ons.

    • next_token(Option<String>):

      The nextToken value returned from a previous paginated ListAddonsResponse where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

  • On failure, responds with SdkError<ListAddonsError>

Constructs a fluent builder for the ListClusters operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • max_results(i32) / set_max_results(Option<i32>):

      The maximum number of cluster results returned by ListClusters in paginated output. When you use this parameter, ListClusters returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListClusters returns up to 100 results and a nextToken value if applicable.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

    • include(Vec<String>) / set_include(Option<Vec<String>>):

      Indicates whether external clusters are included in the returned list. Use ‘all’ to return connected clusters, or blank to return only Amazon EKS clusters. ‘all’ must be in lowercase otherwise an error occurs.

  • On success, responds with ListClustersOutput with field(s):
    • clusters(Option<Vec<String>>):

      A list of all of the clusters for your account in the specified Region.

    • next_token(Option<String>):

      The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

  • On failure, responds with SdkError<ListClustersError>

Constructs a fluent builder for the ListFargateProfiles operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):

      The name of the Amazon EKS cluster that you would like to list Fargate profiles in.

    • max_results(i32) / set_max_results(Option<i32>):

      The maximum number of Fargate profile results returned by ListFargateProfiles in paginated output. When you use this parameter, ListFargateProfiles returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListFargateProfiles request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListFargateProfiles returns up to 100 results and a nextToken value if applicable.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      The nextToken value returned from a previous paginated ListFargateProfiles request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

  • On success, responds with ListFargateProfilesOutput with field(s):
    • fargate_profile_names(Option<Vec<String>>):

      A list of all of the Fargate profiles associated with the specified cluster.

    • next_token(Option<String>):

      The nextToken value to include in a future ListFargateProfiles request. When the results of a ListFargateProfiles request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

  • On failure, responds with SdkError<ListFargateProfilesError>

Constructs a fluent builder for the ListIdentityProviderConfigs operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):

      The cluster name that you want to list identity provider configurations for.

    • max_results(i32) / set_max_results(Option<i32>):

      The maximum number of identity provider configurations returned by ListIdentityProviderConfigs in paginated output. When you use this parameter, ListIdentityProviderConfigs returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListIdentityProviderConfigs request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListIdentityProviderConfigs returns up to 100 results and a nextToken value, if applicable.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      The nextToken value returned from a previous paginated IdentityProviderConfigsRequest where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

  • On success, responds with ListIdentityProviderConfigsOutput with field(s):
  • On failure, responds with SdkError<ListIdentityProviderConfigsError>

Constructs a fluent builder for the ListNodegroups operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):

      The name of the Amazon EKS cluster that you would like to list node groups in.

    • max_results(i32) / set_max_results(Option<i32>):

      The maximum number of node group results returned by ListNodegroups in paginated output. When you use this parameter, ListNodegroups returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListNodegroups request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListNodegroups returns up to 100 results and a nextToken value if applicable.

    • next_token(impl Into<String>) / set_next_token(Option<String>):

      The nextToken value returned from a previous paginated ListNodegroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

  • On success, responds with ListNodegroupsOutput with field(s):
    • nodegroups(Option<Vec<String>>):

      A list of all of the node groups associated with the specified cluster.

    • next_token(Option<String>):

      The nextToken value to include in a future ListNodegroups request. When the results of a ListNodegroups request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

  • On failure, responds with SdkError<ListNodegroupsError>

Constructs a fluent builder for the ListTagsForResource operation.

Constructs a fluent builder for the ListUpdates operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the RegisterCluster operation.

Constructs a fluent builder for the TagResource operation.

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the UpdateAddon operation.

Constructs a fluent builder for the UpdateClusterConfig operation.

Constructs a fluent builder for the UpdateClusterVersion operation.

Constructs a fluent builder for the UpdateNodegroupConfig operation.

Constructs a fluent builder for the UpdateNodegroupVersion operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more