pub struct Client { /* private fields */ }
Expand description
Client for Amazon EMR Containers
Client for invoking operations on Amazon EMR Containers. Each operation on Amazon EMR Containers 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_emrcontainers::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_emrcontainers::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 CancelJobRun
operation has
a Client::cancel_job_run
, 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.cancel_job_run()
.id("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§
Source§impl Client
impl Client
Sourcepub fn cancel_job_run(&self) -> CancelJobRunFluentBuilder
pub fn cancel_job_run(&self) -> CancelJobRunFluentBuilder
Constructs a fluent builder for the CancelJobRun
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the job run to cancel.
virtual_cluster_id(impl Into<String>)
/set_virtual_cluster_id(Option<String>)
:
required: trueThe ID of the virtual cluster for which the job run will be canceled.
- On success, responds with
CancelJobRunOutput
with field(s):id(Option<String>)
:The output contains the ID of the cancelled job run.
virtual_cluster_id(Option<String>)
:The output contains the virtual cluster ID for which the job run is cancelled.
- On failure, responds with
SdkError<CancelJobRunError>
Source§impl Client
impl Client
Sourcepub fn create_job_template(&self) -> CreateJobTemplateFluentBuilder
pub fn create_job_template(&self) -> CreateJobTemplateFluentBuilder
Constructs a fluent builder for the CreateJobTemplate
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe specified name of the job template.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: trueThe client token of the job template.
job_template_data(JobTemplateData)
/set_job_template_data(Option<JobTemplateData>)
:
required: trueThe job template data which holds values of StartJobRun API request.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags that are associated with the job template.
kms_key_arn(impl Into<String>)
/set_kms_key_arn(Option<String>)
:
required: falseThe KMS key ARN used to encrypt the job template.
- On success, responds with
CreateJobTemplateOutput
with field(s):id(Option<String>)
:This output display the created job template ID.
name(Option<String>)
:This output displays the name of the created job template.
arn(Option<String>)
:This output display the ARN of the created job template.
created_at(Option<DateTime>)
:This output displays the date and time when the job template was created.
- On failure, responds with
SdkError<CreateJobTemplateError>
Source§impl Client
impl Client
Sourcepub fn create_managed_endpoint(&self) -> CreateManagedEndpointFluentBuilder
pub fn create_managed_endpoint(&self) -> CreateManagedEndpointFluentBuilder
Constructs a fluent builder for the CreateManagedEndpoint
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the managed endpoint.
virtual_cluster_id(impl Into<String>)
/set_virtual_cluster_id(Option<String>)
:
required: trueThe ID of the virtual cluster for which a managed endpoint is created.
r#type(impl Into<String>)
/set_type(Option<String>)
:
required: trueThe type of the managed endpoint.
release_label(impl Into<String>)
/set_release_label(Option<String>)
:
required: trueThe Amazon EMR release version.
execution_role_arn(impl Into<String>)
/set_execution_role_arn(Option<String>)
:
required: trueThe ARN of the execution role.
certificate_arn(impl Into<String>)
/set_certificate_arn(Option<String>)
:
required: falseThe certificate ARN provided by users for the managed endpoint. This field is under deprecation and will be removed in future releases.
configuration_overrides(ConfigurationOverrides)
/set_configuration_overrides(Option<ConfigurationOverrides>)
:
required: falseThe configuration settings that will be used to override existing configurations.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: trueThe client idempotency token for this create call.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags of the managed endpoint.
- On success, responds with
CreateManagedEndpointOutput
with field(s):id(Option<String>)
:The output contains the ID of the managed endpoint.
name(Option<String>)
:The output contains the name of the managed endpoint.
arn(Option<String>)
:The output contains the ARN of the managed endpoint.
virtual_cluster_id(Option<String>)
:The output contains the ID of the virtual cluster.
- On failure, responds with
SdkError<CreateManagedEndpointError>
Source§impl Client
impl Client
Sourcepub fn create_security_configuration(
&self,
) -> CreateSecurityConfigurationFluentBuilder
pub fn create_security_configuration( &self, ) -> CreateSecurityConfigurationFluentBuilder
Constructs a fluent builder for the CreateSecurityConfiguration
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: trueThe client idempotency token to use when creating the security configuration.
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the security configuration.
security_configuration_data(SecurityConfigurationData)
/set_security_configuration_data(Option<SecurityConfigurationData>)
:
required: trueSecurity configuration input for the request.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags to add to the security configuration.
- On success, responds with
CreateSecurityConfigurationOutput
with field(s):id(Option<String>)
:The ID of the security configuration.
name(Option<String>)
:The name of the security configuration.
arn(Option<String>)
:The ARN (Amazon Resource Name) of the security configuration.
- On failure, responds with
SdkError<CreateSecurityConfigurationError>
Source§impl Client
impl Client
Sourcepub fn create_virtual_cluster(&self) -> CreateVirtualClusterFluentBuilder
pub fn create_virtual_cluster(&self) -> CreateVirtualClusterFluentBuilder
Constructs a fluent builder for the CreateVirtualCluster
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe specified name of the virtual cluster.
container_provider(ContainerProvider)
/set_container_provider(Option<ContainerProvider>)
:
required: trueThe container provider of the virtual cluster.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: trueThe client token of the virtual cluster.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags assigned to the virtual cluster.
security_configuration_id(impl Into<String>)
/set_security_configuration_id(Option<String>)
:
required: falseThe ID of the security configuration.
- On success, responds with
CreateVirtualClusterOutput
with field(s):id(Option<String>)
:This output contains the virtual cluster ID.
name(Option<String>)
:This output contains the name of the virtual cluster.
arn(Option<String>)
:This output contains the ARN of virtual cluster.
- On failure, responds with
SdkError<CreateVirtualClusterError>
Source§impl Client
impl Client
Sourcepub fn delete_job_template(&self) -> DeleteJobTemplateFluentBuilder
pub fn delete_job_template(&self) -> DeleteJobTemplateFluentBuilder
Constructs a fluent builder for the DeleteJobTemplate
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the job template that will be deleted.
- On success, responds with
DeleteJobTemplateOutput
with field(s):id(Option<String>)
:This output contains the ID of the job template that was deleted.
- On failure, responds with
SdkError<DeleteJobTemplateError>
Source§impl Client
impl Client
Sourcepub fn delete_managed_endpoint(&self) -> DeleteManagedEndpointFluentBuilder
pub fn delete_managed_endpoint(&self) -> DeleteManagedEndpointFluentBuilder
Constructs a fluent builder for the DeleteManagedEndpoint
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the managed endpoint.
virtual_cluster_id(impl Into<String>)
/set_virtual_cluster_id(Option<String>)
:
required: trueThe ID of the endpoint’s virtual cluster.
- On success, responds with
DeleteManagedEndpointOutput
with field(s):id(Option<String>)
:The output displays the ID of the managed endpoint.
virtual_cluster_id(Option<String>)
:The output displays the ID of the endpoint’s virtual cluster.
- On failure, responds with
SdkError<DeleteManagedEndpointError>
Source§impl Client
impl Client
Sourcepub fn delete_virtual_cluster(&self) -> DeleteVirtualClusterFluentBuilder
pub fn delete_virtual_cluster(&self) -> DeleteVirtualClusterFluentBuilder
Constructs a fluent builder for the DeleteVirtualCluster
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the virtual cluster that will be deleted.
- On success, responds with
DeleteVirtualClusterOutput
with field(s):id(Option<String>)
:This output contains the ID of the virtual cluster that will be deleted.
- On failure, responds with
SdkError<DeleteVirtualClusterError>
Source§impl Client
impl Client
Sourcepub fn describe_job_run(&self) -> DescribeJobRunFluentBuilder
pub fn describe_job_run(&self) -> DescribeJobRunFluentBuilder
Constructs a fluent builder for the DescribeJobRun
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the job run request.
virtual_cluster_id(impl Into<String>)
/set_virtual_cluster_id(Option<String>)
:
required: trueThe ID of the virtual cluster for which the job run is submitted.
- On success, responds with
DescribeJobRunOutput
with field(s):job_run(Option<JobRun>)
:The output displays information about a job run.
- On failure, responds with
SdkError<DescribeJobRunError>
Source§impl Client
impl Client
Sourcepub fn describe_job_template(&self) -> DescribeJobTemplateFluentBuilder
pub fn describe_job_template(&self) -> DescribeJobTemplateFluentBuilder
Constructs a fluent builder for the DescribeJobTemplate
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the job template that will be described.
- On success, responds with
DescribeJobTemplateOutput
with field(s):job_template(Option<JobTemplate>)
:This output displays information about the specified job template.
- On failure, responds with
SdkError<DescribeJobTemplateError>
Source§impl Client
impl Client
Sourcepub fn describe_managed_endpoint(&self) -> DescribeManagedEndpointFluentBuilder
pub fn describe_managed_endpoint(&self) -> DescribeManagedEndpointFluentBuilder
Constructs a fluent builder for the DescribeManagedEndpoint
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThis output displays ID of the managed endpoint.
virtual_cluster_id(impl Into<String>)
/set_virtual_cluster_id(Option<String>)
:
required: trueThe ID of the endpoint’s virtual cluster.
- On success, responds with
DescribeManagedEndpointOutput
with field(s):endpoint(Option<Endpoint>)
:This output displays information about a managed endpoint.
- On failure, responds with
SdkError<DescribeManagedEndpointError>
Source§impl Client
impl Client
Sourcepub fn describe_security_configuration(
&self,
) -> DescribeSecurityConfigurationFluentBuilder
pub fn describe_security_configuration( &self, ) -> DescribeSecurityConfigurationFluentBuilder
Constructs a fluent builder for the DescribeSecurityConfiguration
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the security configuration.
- On success, responds with
DescribeSecurityConfigurationOutput
with field(s):security_configuration(Option<SecurityConfiguration>)
:Details of the security configuration.
- On failure, responds with
SdkError<DescribeSecurityConfigurationError>
Source§impl Client
impl Client
Sourcepub fn describe_virtual_cluster(&self) -> DescribeVirtualClusterFluentBuilder
pub fn describe_virtual_cluster(&self) -> DescribeVirtualClusterFluentBuilder
Constructs a fluent builder for the DescribeVirtualCluster
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the virtual cluster that will be described.
- On success, responds with
DescribeVirtualClusterOutput
with field(s):virtual_cluster(Option<VirtualCluster>)
:This output displays information about the specified virtual cluster.
- On failure, responds with
SdkError<DescribeVirtualClusterError>
Source§impl Client
impl Client
Sourcepub fn get_managed_endpoint_session_credentials(
&self,
) -> GetManagedEndpointSessionCredentialsFluentBuilder
pub fn get_managed_endpoint_session_credentials( &self, ) -> GetManagedEndpointSessionCredentialsFluentBuilder
Constructs a fluent builder for the GetManagedEndpointSessionCredentials
operation.
- The fluent builder is configurable:
endpoint_identifier(impl Into<String>)
/set_endpoint_identifier(Option<String>)
:
required: trueThe ARN of the managed endpoint for which the request is submitted.
virtual_cluster_identifier(impl Into<String>)
/set_virtual_cluster_identifier(Option<String>)
:
required: trueThe ARN of the Virtual Cluster which the Managed Endpoint belongs to.
execution_role_arn(impl Into<String>)
/set_execution_role_arn(Option<String>)
:
required: trueThe IAM Execution Role ARN that will be used by the job run.
credential_type(impl Into<String>)
/set_credential_type(Option<String>)
:
required: trueType of the token requested. Currently supported and default value of this field is “TOKEN.”
duration_in_seconds(i32)
/set_duration_in_seconds(Option<i32>)
:
required: falseDuration in seconds for which the session token is valid. The default duration is 15 minutes and the maximum is 12 hours.
log_context(impl Into<String>)
/set_log_context(Option<String>)
:
required: falseString identifier used to separate sections of the execution logs uploaded to S3.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseThe client idempotency token of the job run request.
- On success, responds with
GetManagedEndpointSessionCredentialsOutput
with field(s):id(Option<String>)
:The identifier of the session token returned.
credentials(Option<Credentials>)
:The structure containing the session credentials.
expires_at(Option<DateTime>)
:The date and time when the session token will expire.
- On failure, responds with
SdkError<GetManagedEndpointSessionCredentialsError>
Source§impl Client
impl Client
Sourcepub fn list_job_runs(&self) -> ListJobRunsFluentBuilder
pub fn list_job_runs(&self) -> ListJobRunsFluentBuilder
Constructs a fluent builder for the ListJobRuns
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
virtual_cluster_id(impl Into<String>)
/set_virtual_cluster_id(Option<String>)
:
required: trueThe ID of the virtual cluster for which to list the job run.
created_before(DateTime)
/set_created_before(Option<DateTime>)
:
required: falseThe date and time before which the job runs were submitted.
created_after(DateTime)
/set_created_after(Option<DateTime>)
:
required: falseThe date and time after which the job runs were submitted.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the job run.
states(JobRunState)
/set_states(Option<Vec::<JobRunState>>)
:
required: falseThe states of the job run.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of job runs that can be listed.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token for the next set of job runs to return.
- On success, responds with
ListJobRunsOutput
with field(s):job_runs(Option<Vec::<JobRun>>)
:This output lists information about the specified job runs.
next_token(Option<String>)
:This output displays the token for the next set of job runs.
- On failure, responds with
SdkError<ListJobRunsError>
Source§impl Client
impl Client
Sourcepub fn list_job_templates(&self) -> ListJobTemplatesFluentBuilder
pub fn list_job_templates(&self) -> ListJobTemplatesFluentBuilder
Constructs a fluent builder for the ListJobTemplates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
created_after(DateTime)
/set_created_after(Option<DateTime>)
:
required: falseThe date and time after which the job templates were created.
created_before(DateTime)
/set_created_before(Option<DateTime>)
:
required: falseThe date and time before which the job templates were created.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of job templates that can be listed.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token for the next set of job templates to return.
- On success, responds with
ListJobTemplatesOutput
with field(s):templates(Option<Vec::<JobTemplate>>)
:This output lists information about the specified job templates.
next_token(Option<String>)
:This output displays the token for the next set of job templates.
- On failure, responds with
SdkError<ListJobTemplatesError>
Source§impl Client
impl Client
Sourcepub fn list_managed_endpoints(&self) -> ListManagedEndpointsFluentBuilder
pub fn list_managed_endpoints(&self) -> ListManagedEndpointsFluentBuilder
Constructs a fluent builder for the ListManagedEndpoints
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
virtual_cluster_id(impl Into<String>)
/set_virtual_cluster_id(Option<String>)
:
required: trueThe ID of the virtual cluster.
created_before(DateTime)
/set_created_before(Option<DateTime>)
:
required: falseThe date and time before which the endpoints are created.
created_after(DateTime)
/set_created_after(Option<DateTime>)
:
required: falseThe date and time after which the endpoints are created.
types(impl Into<String>)
/set_types(Option<Vec::<String>>)
:
required: falseThe types of the managed endpoints.
states(EndpointState)
/set_states(Option<Vec::<EndpointState>>)
:
required: falseThe states of the managed endpoints.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of managed endpoints that can be listed.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token for the next set of managed endpoints to return.
- On success, responds with
ListManagedEndpointsOutput
with field(s):endpoints(Option<Vec::<Endpoint>>)
:The managed endpoints to be listed.
next_token(Option<String>)
:The token for the next set of endpoints to return.
- On failure, responds with
SdkError<ListManagedEndpointsError>
Source§impl Client
impl Client
Sourcepub fn list_security_configurations(
&self,
) -> ListSecurityConfigurationsFluentBuilder
pub fn list_security_configurations( &self, ) -> ListSecurityConfigurationsFluentBuilder
Constructs a fluent builder for the ListSecurityConfigurations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
created_after(DateTime)
/set_created_after(Option<DateTime>)
:
required: falseThe date and time after which the security configuration was created.
created_before(DateTime)
/set_created_before(Option<DateTime>)
:
required: falseThe date and time before which the security configuration was created.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of security configurations the operation can list.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token for the next set of security configurations to return.
- On success, responds with
ListSecurityConfigurationsOutput
with field(s):security_configurations(Option<Vec::<SecurityConfiguration>>)
:The list of returned security configurations.
next_token(Option<String>)
:The token for the next set of security configurations to return.
- On failure, responds with
SdkError<ListSecurityConfigurationsError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of tagged resources.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:The tags assigned to resources.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn list_virtual_clusters(&self) -> ListVirtualClustersFluentBuilder
pub fn list_virtual_clusters(&self) -> ListVirtualClustersFluentBuilder
Constructs a fluent builder for the ListVirtualClusters
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
container_provider_id(impl Into<String>)
/set_container_provider_id(Option<String>)
:
required: falseThe container provider ID of the virtual cluster.
container_provider_type(ContainerProviderType)
/set_container_provider_type(Option<ContainerProviderType>)
:
required: falseThe container provider type of the virtual cluster. Amazon EKS is the only supported type as of now.
created_after(DateTime)
/set_created_after(Option<DateTime>)
:
required: falseThe date and time after which the virtual clusters are created.
created_before(DateTime)
/set_created_before(Option<DateTime>)
:
required: falseThe date and time before which the virtual clusters are created.
states(VirtualClusterState)
/set_states(Option<Vec::<VirtualClusterState>>)
:
required: falseThe states of the requested virtual clusters.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of virtual clusters that can be listed.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token for the next set of virtual clusters to return.
eks_access_entry_integrated(bool)
/set_eks_access_entry_integrated(Option<bool>)
:
required: falseOptional Boolean that specifies whether the operation should return the virtual clusters that have the access entry integration enabled or disabled. If not specified, the operation returns all applicable virtual clusters.
- On success, responds with
ListVirtualClustersOutput
with field(s):virtual_clusters(Option<Vec::<VirtualCluster>>)
:This output lists the specified virtual clusters.
next_token(Option<String>)
:This output displays the token for the next set of virtual clusters.
- On failure, responds with
SdkError<ListVirtualClustersError>
Source§impl Client
impl Client
Sourcepub fn start_job_run(&self) -> StartJobRunFluentBuilder
pub fn start_job_run(&self) -> StartJobRunFluentBuilder
Constructs a fluent builder for the StartJobRun
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the job run.
virtual_cluster_id(impl Into<String>)
/set_virtual_cluster_id(Option<String>)
:
required: trueThe virtual cluster ID for which the job run request is submitted.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: trueThe client idempotency token of the job run request.
execution_role_arn(impl Into<String>)
/set_execution_role_arn(Option<String>)
:
required: falseThe execution role ARN for the job run.
release_label(impl Into<String>)
/set_release_label(Option<String>)
:
required: falseThe Amazon EMR release version to use for the job run.
job_driver(JobDriver)
/set_job_driver(Option<JobDriver>)
:
required: falseThe job driver for the job run.
configuration_overrides(ConfigurationOverrides)
/set_configuration_overrides(Option<ConfigurationOverrides>)
:
required: falseThe configuration overrides for the job run.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe tags assigned to job runs.
job_template_id(impl Into<String>)
/set_job_template_id(Option<String>)
:
required: falseThe job template ID to be used to start the job run.
job_template_parameters(impl Into<String>, impl Into<String>)
/set_job_template_parameters(Option<HashMap::<String, String>>)
:
required: falseThe values of job template parameters to start a job run.
retry_policy_configuration(RetryPolicyConfiguration)
/set_retry_policy_configuration(Option<RetryPolicyConfiguration>)
:
required: falseThe retry policy configuration for the job run.
- On success, responds with
StartJobRunOutput
with field(s):id(Option<String>)
:This output displays the started job run ID.
name(Option<String>)
:This output displays the name of the started job run.
arn(Option<String>)
:This output lists the ARN of job run.
virtual_cluster_id(Option<String>)
:This output displays the virtual cluster ID for which the job run was submitted.
- On failure, responds with
SdkError<StartJobRunError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
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: trueThe ARN of resources.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueThe tags assigned to resources.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
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: trueThe ARN of resources.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe tag keys of the resources.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
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
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
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 thesleep_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 thehttp_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, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);