Struct Client

pub struct Client { /* private fields */ }

Client for AWS Parallel Computing Service

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

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_pcs::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_pcs::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateCluster operation has a Client::create_cluster, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_cluster()
    .cluster_name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_cluster(&self) -> CreateClusterFluentBuilder

Constructs a fluent builder for the CreateCluster operation.

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

    A name to identify the cluster. Example: MyCluster

    
    
  • scheduler(SchedulerRequest) / set_scheduler(Option<SchedulerRequest>):
    required: true
    

    The cluster management and job scheduling software associated with the cluster.

    
    
  • size(Size) / set_size(Option<Size>):
    required: true
    

    A value that determines the maximum number of compute nodes in the cluster and the maximum number of jobs (active and queued).

    • SMALL: 32 compute nodes and 256 jobs

    • MEDIUM: 512 compute nodes and 8192 jobs

    • LARGE: 2048 compute nodes and 16,384 jobs

    
    
  • networking(NetworkingRequest) / set_networking(Option<NetworkingRequest>):
    required: true
    

    The networking configuration used to set up the cluster’s control plane.

    
    
  • slurm_configuration(ClusterSlurmConfigurationRequest) / set_slurm_configuration(Option<ClusterSlurmConfigurationRequest>):
    required: false
    

    Additional options related to the Slurm scheduler.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don’t specify a client token, the CLI and SDK automatically generate 1 for you.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

    
    
• On success, responds with CreateClusterOutput with field(s):
  • cluster(Option<Cluster>):

    The cluster resource.

• On failure, responds with SdkError<CreateClusterError>

impl Client

pub fn create_compute_node_group(&self) -> CreateComputeNodeGroupFluentBuilder

Constructs a fluent builder for the CreateComputeNodeGroup operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The name or ID of the cluster to create a compute node group in.

    
    
  • compute_node_group_name(impl Into<String>) / set_compute_node_group_name(Option<String>):
    required: true
    

    A name to identify the cluster. Example: MyCluster

    
    
  • ami_id(impl Into<String>) / set_ami_id(Option<String>):
    required: false
    

    The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes (Amazon EC2 instances). If you don’t provide this value, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: true
    

    The list of subnet IDs where the compute node group launches instances. Subnets must be in the same VPC as the cluster.

    
    
  • purchase_option(PurchaseOption) / set_purchase_option(Option<PurchaseOption>):
    required: false
    

    Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don’t provide this option, it defaults to On-Demand.

    
    
  • custom_launch_template(CustomLaunchTemplate) / set_custom_launch_template(Option<CustomLaunchTemplate>):
    required: true
    

    An Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.

    
    
  • iam_instance_profile_arn(impl Into<String>) / set_iam_instance_profile_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance permission. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.

    Examples

    • arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1

    • arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2

    
    
  • scaling_configuration(ScalingConfigurationRequest) / set_scaling_configuration(Option<ScalingConfigurationRequest>):
    required: true
    

    Specifies the boundaries of the compute node group auto scaling.

    
    
  • instance_configs(InstanceConfig) / set_instance_configs(Option<Vec::<InstanceConfig>>):
    required: true
    

    A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.

    
    
  • spot_options(SpotOptions) / set_spot_options(Option<SpotOptions>):
    required: false
    

    Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.

    
    
  • slurm_configuration(ComputeNodeGroupSlurmConfigurationRequest) / set_slurm_configuration(Option<ComputeNodeGroupSlurmConfigurationRequest>):
    required: false
    

    Additional options related to the Slurm scheduler.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don’t specify a client token, the CLI and SDK automatically generate 1 for you.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

    
    
• On success, responds with CreateComputeNodeGroupOutput with field(s):
  • compute_node_group(Option<ComputeNodeGroup>):

    A compute node group associated with a cluster.

• On failure, responds with SdkError<CreateComputeNodeGroupError>

impl Client

pub fn create_queue(&self) -> CreateQueueFluentBuilder

Constructs a fluent builder for the CreateQueue operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The name or ID of the cluster for which to create a queue.

    
    
  • queue_name(impl Into<String>) / set_queue_name(Option<String>):
    required: true
    

    A name to identify the queue.

    
    
  • compute_node_group_configurations(ComputeNodeGroupConfiguration) / set_compute_node_group_configurations(Option<Vec::<ComputeNodeGroupConfiguration>>):
    required: false
    

    The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don’t specify a client token, the CLI and SDK automatically generate 1 for you.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

    
    
• On success, responds with CreateQueueOutput with field(s):
  • queue(Option<Queue>):

    A queue resource.

• On failure, responds with SdkError<CreateQueueError>

impl Client

pub fn delete_cluster(&self) -> DeleteClusterFluentBuilder

Constructs a fluent builder for the DeleteCluster operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The name or ID of the cluster to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don’t specify a client token, the CLI and SDK automatically generate 1 for you.

    
    
• On success, responds with DeleteClusterOutput
• On failure, responds with SdkError<DeleteClusterError>

impl Client

pub fn delete_compute_node_group(&self) -> DeleteComputeNodeGroupFluentBuilder

Constructs a fluent builder for the DeleteComputeNodeGroup operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The name or ID of the cluster of the compute node group.

    
    
  • compute_node_group_identifier(impl Into<String>) / set_compute_node_group_identifier(Option<String>):
    required: true
    

    The name or ID of the compute node group to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don’t specify a client token, the CLI and SDK automatically generate 1 for you.

    
    
• On success, responds with DeleteComputeNodeGroupOutput
• On failure, responds with SdkError<DeleteComputeNodeGroupError>

impl Client

pub fn delete_queue(&self) -> DeleteQueueFluentBuilder

Constructs a fluent builder for the DeleteQueue operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The name or ID of the cluster of the queue.

    
    
  • queue_identifier(impl Into<String>) / set_queue_identifier(Option<String>):
    required: true
    

    The name or ID of the queue to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don’t specify a client token, the CLI and SDK automatically generate 1 for you.

    
    
• On success, responds with DeleteQueueOutput
• On failure, responds with SdkError<DeleteQueueError>

impl Client

pub fn get_cluster(&self) -> GetClusterFluentBuilder

Constructs a fluent builder for the GetCluster operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The name or ID of the cluster of the queue.

    
    
• On success, responds with GetClusterOutput with field(s):
  • cluster(Option<Cluster>):

    The cluster resource.

• On failure, responds with SdkError<GetClusterError>

impl Client

pub fn get_compute_node_group(&self) -> GetComputeNodeGroupFluentBuilder

Constructs a fluent builder for the GetComputeNodeGroup operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The name or ID of the cluster.

    
    
  • compute_node_group_identifier(impl Into<String>) / set_compute_node_group_identifier(Option<String>):
    required: true
    

    The name or ID of the compute node group.

    
    
• On success, responds with GetComputeNodeGroupOutput with field(s):
  • compute_node_group(Option<ComputeNodeGroup>):

    A compute node group associated with a cluster.

• On failure, responds with SdkError<GetComputeNodeGroupError>

impl Client

pub fn get_queue(&self) -> GetQueueFluentBuilder

Constructs a fluent builder for the GetQueue operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The name or ID of the cluster of the queue.

    
    
  • queue_identifier(impl Into<String>) / set_queue_identifier(Option<String>):
    required: true
    

    The name or ID of the queue.

    
    
• On success, responds with GetQueueOutput with field(s):
  • queue(Option<Queue>):

    A queue resource.

• On failure, responds with SdkError<GetQueueError>

impl Client

pub fn list_clusters(&self) -> ListClustersFluentBuilder

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

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.

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

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses the default.

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

    The list of clusters.

  • next_token(Option<String>):

    The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.

• On failure, responds with SdkError<ListClustersError>

impl Client

pub fn list_compute_node_groups(&self) -> ListComputeNodeGroupsFluentBuilder

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

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The name or ID of the cluster to list compute node groups for.

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

    The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.

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

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses the default.

    
    
• On success, responds with ListComputeNodeGroupsOutput with field(s):
  • compute_node_groups(Vec::<ComputeNodeGroupSummary>):

    The list of compute node groups for the cluster.

  • next_token(Option<String>):

    The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.

• On failure, responds with SdkError<ListComputeNodeGroupsError>

impl Client

pub fn list_queues(&self) -> ListQueuesFluentBuilder

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

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The name or ID of the cluster to list queues for.

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

    The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.

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

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses the default.

    
    
• On success, responds with ListQueuesOutput with field(s):
  • queues(Vec::<QueueSummary>):

    The list of queues associated with the cluster.

  • next_token(Option<String>):

    The value of nextToken is a unique pagination token for each page of results returned. If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an HTTP 400 InvalidToken error.

• On failure, responds with SdkError<ListQueuesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource for which to list tags.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn register_compute_node_group_instance( &self, ) -> RegisterComputeNodeGroupInstanceFluentBuilder

Constructs a fluent builder for the RegisterComputeNodeGroupInstance operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The name or ID of the cluster to register the compute node group instance in.

    
    
  • bootstrap_id(impl Into<String>) / set_bootstrap_id(Option<String>):
    required: true
    

    The client-generated token to allow for retries.

    
    
• On success, responds with RegisterComputeNodeGroupInstanceOutput with field(s):
  • node_id(String):

    The scheduler node ID for this instance.

  • shared_secret(String):

    For the Slurm scheduler, this is the shared Munge key the scheduler uses to authenticate compute node group instances.

  • endpoints(Vec::<Endpoint>):

    The list of endpoints available for interaction with the scheduler.

• On failure, responds with SdkError<RegisterComputeNodeGroupInstanceError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    1 or more tag keys to remove from the resource. Specify only tag keys and not tag values.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_compute_node_group(&self) -> UpdateComputeNodeGroupFluentBuilder

Constructs a fluent builder for the UpdateComputeNodeGroup operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The name or ID of the cluster of the compute node group.

    
    
  • compute_node_group_identifier(impl Into<String>) / set_compute_node_group_identifier(Option<String>):
    required: true
    

    The name or ID of the compute node group.

    
    
  • ami_id(impl Into<String>) / set_ami_id(Option<String>):
    required: false
    

    The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: false
    

    The list of subnet IDs where the compute node group provisions instances. The subnets must be in the same VPC as the cluster.

    
    
  • custom_launch_template(CustomLaunchTemplate) / set_custom_launch_template(Option<CustomLaunchTemplate>):
    required: false
    

    An Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.

    
    
  • purchase_option(PurchaseOption) / set_purchase_option(Option<PurchaseOption>):
    required: false
    

    Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see Instance purchasing options in the Amazon Elastic Compute Cloud User Guide. If you don’t provide this option, it defaults to On-Demand.

    
    
  • spot_options(SpotOptions) / set_spot_options(Option<SpotOptions>):
    required: false
    

    Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.

    
    
  • scaling_configuration(ScalingConfigurationRequest) / set_scaling_configuration(Option<ScalingConfigurationRequest>):
    required: false
    

    Specifies the boundaries of the compute node group auto scaling.

    
    
  • iam_instance_profile_arn(impl Into<String>) / set_iam_instance_profile_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance permission. The resource identifier of the ARN must start with AWSPCS or it must have /aws-pcs/ in its path.

    Examples

    • arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1

    • arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2

    
    
  • slurm_configuration(UpdateComputeNodeGroupSlurmConfigurationRequest) / set_slurm_configuration(Option<UpdateComputeNodeGroupSlurmConfigurationRequest>):
    required: false
    

    Additional options related to the Slurm scheduler.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don’t specify a client token, the CLI and SDK automatically generate 1 for you.

    
    
• On success, responds with UpdateComputeNodeGroupOutput with field(s):
  • compute_node_group(Option<ComputeNodeGroup>):

    A compute node group associated with a cluster.

• On failure, responds with SdkError<UpdateComputeNodeGroupError>

impl Client

pub fn update_queue(&self) -> UpdateQueueFluentBuilder

Constructs a fluent builder for the UpdateQueue operation.

• The fluent builder is configurable:
  • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):
    required: true
    

    The name or ID of the cluster of the queue.

    
    
  • queue_identifier(impl Into<String>) / set_queue_identifier(Option<String>):
    required: true
    

    The name or ID of the queue.

    
    
  • compute_node_group_configurations(ComputeNodeGroupConfiguration) / set_compute_node_group_configurations(Option<Vec::<ComputeNodeGroupConfiguration>>):
    required: false
    

    The list of compute node group configurations to associate with the queue. Queues assign jobs to associated compute node groups.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don’t specify a client token, the CLI and SDK automatically generate 1 for you.

    
    
• On success, responds with UpdateQueueOutput with field(s):
  • queue(Option<Queue>):

    A queue resource.

• On failure, responds with SdkError<UpdateQueueError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.