pub struct Client { /* private fields */ }
Expand description
Client for Amazon SageMaker geospatial capabilities
Client for invoking operations on Amazon SageMaker geospatial capabilities. Each operation on Amazon SageMaker geospatial capabilities 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_sagemakergeospatial::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_sagemakergeospatial::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 DeleteEarthObservationJob
operation has
a Client::delete_earth_observation_job
, 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.delete_earth_observation_job()
.arn("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 delete_earth_observation_job(
&self,
) -> DeleteEarthObservationJobFluentBuilder
pub fn delete_earth_observation_job( &self, ) -> DeleteEarthObservationJobFluentBuilder
Constructs a fluent builder for the DeleteEarthObservationJob
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Earth Observation job being deleted.
- On success, responds with
DeleteEarthObservationJobOutput
- On failure, responds with
SdkError<DeleteEarthObservationJobError>
Source§impl Client
impl Client
Sourcepub fn delete_vector_enrichment_job(
&self,
) -> DeleteVectorEnrichmentJobFluentBuilder
pub fn delete_vector_enrichment_job( &self, ) -> DeleteVectorEnrichmentJobFluentBuilder
Constructs a fluent builder for the DeleteVectorEnrichmentJob
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Vector Enrichment job being deleted.
- On success, responds with
DeleteVectorEnrichmentJobOutput
- On failure, responds with
SdkError<DeleteVectorEnrichmentJobError>
Source§impl Client
impl Client
Sourcepub fn export_earth_observation_job(
&self,
) -> ExportEarthObservationJobFluentBuilder
pub fn export_earth_observation_job( &self, ) -> ExportEarthObservationJobFluentBuilder
Constructs a fluent builder for the ExportEarthObservationJob
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe input Amazon Resource Name (ARN) of the Earth Observation job being exported.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique token that guarantees that the call to this API is idempotent.
execution_role_arn(impl Into<String>)
/set_execution_role_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the IAM role that you specified for the job.
output_config(OutputConfigInput)
/set_output_config(Option<OutputConfigInput>)
:
required: trueAn object containing information about the output file.
export_source_images(bool)
/set_export_source_images(Option<bool>)
:
required: falseThe source images provided to the Earth Observation job being exported.
- On success, responds with
ExportEarthObservationJobOutput
with field(s):arn(String)
:The output Amazon Resource Name (ARN) of the Earth Observation job being exported.
creation_time(DateTime)
:The creation time.
export_status(EarthObservationJobExportStatus)
:The status of the results of the Earth Observation job being exported.
execution_role_arn(String)
:The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
output_config(Option<OutputConfigInput>)
:An object containing information about the output file.
export_source_images(Option<bool>)
:The source images provided to the Earth Observation job being exported.
- On failure, responds with
SdkError<ExportEarthObservationJobError>
Source§impl Client
impl Client
Sourcepub fn export_vector_enrichment_job(
&self,
) -> ExportVectorEnrichmentJobFluentBuilder
pub fn export_vector_enrichment_job( &self, ) -> ExportVectorEnrichmentJobFluentBuilder
Constructs a fluent builder for the ExportVectorEnrichmentJob
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Vector Enrichment job.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique token that guarantees that the call to this API is idempotent.
execution_role_arn(impl Into<String>)
/set_execution_role_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the IAM rolewith permission to upload to the location in OutputConfig.
output_config(ExportVectorEnrichmentJobOutputConfig)
/set_output_config(Option<ExportVectorEnrichmentJobOutputConfig>)
:
required: trueOutput location information for exporting Vector Enrichment Job results.
- On success, responds with
ExportVectorEnrichmentJobOutput
with field(s):arn(String)
:The Amazon Resource Name (ARN) of the Vector Enrichment job being exported.
creation_time(DateTime)
:The creation time.
execution_role_arn(String)
:The Amazon Resource Name (ARN) of the IAM role with permission to upload to the location in OutputConfig.
export_status(VectorEnrichmentJobExportStatus)
:The status of the results the Vector Enrichment job being exported.
output_config(Option<ExportVectorEnrichmentJobOutputConfig>)
:Output location information for exporting Vector Enrichment Job results.
- On failure, responds with
SdkError<ExportVectorEnrichmentJobError>
Source§impl Client
impl Client
Sourcepub fn get_earth_observation_job(&self) -> GetEarthObservationJobFluentBuilder
pub fn get_earth_observation_job(&self) -> GetEarthObservationJobFluentBuilder
Constructs a fluent builder for the GetEarthObservationJob
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Earth Observation job.
- On success, responds with
GetEarthObservationJobOutput
with field(s):arn(String)
:The Amazon Resource Name (ARN) of the Earth Observation job.
name(String)
:The name of the Earth Observation job.
creation_time(DateTime)
:The creation time of the initiated Earth Observation job.
duration_in_seconds(i32)
:The duration of Earth Observation job, in seconds.
status(EarthObservationJobStatus)
:The status of a previously initiated Earth Observation job.
kms_key_id(Option<String>)
:The Key Management Service key ID for server-side encryption.
input_config(Option<InputConfigOutput>)
:Input data for the Earth Observation job.
job_config(Option<JobConfigInput>)
:An object containing information about the job configuration.
output_bands(Option<Vec::<OutputBand>>)
:Bands available in the output of an operation.
execution_role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
error_details(Option<EarthObservationJobErrorDetails>)
:Details about the errors generated during the Earth Observation job.
export_status(Option<EarthObservationJobExportStatus>)
:The status of the Earth Observation job.
export_error_details(Option<ExportErrorDetails>)
:Details about the errors generated during ExportEarthObservationJob.
tags(Option<HashMap::<String, String>>)
:Each tag consists of a key and a value.
- On failure, responds with
SdkError<GetEarthObservationJobError>
Source§impl Client
impl Client
Sourcepub fn get_raster_data_collection(&self) -> GetRasterDataCollectionFluentBuilder
pub fn get_raster_data_collection(&self) -> GetRasterDataCollectionFluentBuilder
Constructs a fluent builder for the GetRasterDataCollection
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the raster data collection.
- On success, responds with
GetRasterDataCollectionOutput
with field(s):name(String)
:The name of the raster data collection.
arn(String)
:The Amazon Resource Name (ARN) of the raster data collection.
r#type(DataCollectionType)
:The raster data collection type.
description(String)
:A description of the raster data collection.
description_page_url(String)
:The URL of the description page.
supported_filters(Vec::<Filter>)
:The filters supported by the raster data collection.
image_source_bands(Vec::<String>)
:The list of image source bands in the raster data collection.
tags(Option<HashMap::<String, String>>)
:Each tag consists of a key and a value.
- On failure, responds with
SdkError<GetRasterDataCollectionError>
Source§impl Client
impl Client
Sourcepub fn get_tile(&self) -> GetTileFluentBuilder
pub fn get_tile(&self) -> GetTileFluentBuilder
Constructs a fluent builder for the GetTile
operation.
- The fluent builder is configurable:
x(i32)
/set_x(Option<i32>)
:
required: trueThe x coordinate of the tile input.
y(i32)
/set_y(Option<i32>)
:
required: trueThe y coordinate of the tile input.
z(i32)
/set_z(Option<i32>)
:
required: trueThe z coordinate of the tile input.
image_assets(impl Into<String>)
/set_image_assets(Option<Vec::<String>>)
:
required: trueThe particular assets or bands to tile.
target(TargetOptions)
/set_target(Option<TargetOptions>)
:
required: trueDetermines what part of the Earth Observation job to tile. ‘INPUT’ or ‘OUTPUT’ are the valid options.
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the tile operation.
image_mask(bool)
/set_image_mask(Option<bool>)
:
required: falseDetermines whether or not to return a valid data mask.
output_format(impl Into<String>)
/set_output_format(Option<String>)
:
required: falseThe data format of the output tile. The formats include .npy, .png and .jpg.
time_range_filter(impl Into<String>)
/set_time_range_filter(Option<String>)
:
required: falseTime range filter applied to imagery to find the images to tile.
property_filters(impl Into<String>)
/set_property_filters(Option<String>)
:
required: falseProperty filters for the imagery to tile.
output_data_type(OutputType)
/set_output_data_type(Option<OutputType>)
:
required: falseThe output data type of the tile operation.
execution_role_arn(impl Into<String>)
/set_execution_role_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the IAM role that you specify.
- On success, responds with
GetTileOutput
with field(s):binary_file(ByteStream)
:The output binary file.
- On failure, responds with
SdkError<GetTileError>
Source§impl Client
impl Client
Sourcepub fn get_vector_enrichment_job(&self) -> GetVectorEnrichmentJobFluentBuilder
pub fn get_vector_enrichment_job(&self) -> GetVectorEnrichmentJobFluentBuilder
Constructs a fluent builder for the GetVectorEnrichmentJob
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Vector Enrichment job.
- On success, responds with
GetVectorEnrichmentJobOutput
with field(s):arn(String)
:The Amazon Resource Name (ARN) of the Vector Enrichment job.
r#type(VectorEnrichmentJobType)
:The type of the Vector Enrichment job being initiated.
name(String)
:The name of the Vector Enrichment job.
creation_time(DateTime)
:The creation time.
duration_in_seconds(i32)
:The duration of the Vector Enrichment job, in seconds.
status(VectorEnrichmentJobStatus)
:The status of the initiated Vector Enrichment job.
kms_key_id(Option<String>)
:The Key Management Service key ID for server-side encryption.
input_config(Option<VectorEnrichmentJobInputConfig>)
:Input configuration information for the Vector Enrichment job.
job_config(Option<VectorEnrichmentJobConfig>)
:An object containing information about the job configuration.
execution_role_arn(String)
:The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
error_details(Option<VectorEnrichmentJobErrorDetails>)
:Details about the errors generated during the Vector Enrichment job.
export_status(Option<VectorEnrichmentJobExportStatus>)
:The export status of the Vector Enrichment job being initiated.
export_error_details(Option<VectorEnrichmentJobExportErrorDetails>)
:Details about the errors generated during the ExportVectorEnrichmentJob.
tags(Option<HashMap::<String, String>>)
:Each tag consists of a key and a value.
- On failure, responds with
SdkError<GetVectorEnrichmentJobError>
Source§impl Client
impl Client
Sourcepub fn list_earth_observation_jobs(
&self,
) -> ListEarthObservationJobsFluentBuilder
pub fn list_earth_observation_jobs( &self, ) -> ListEarthObservationJobsFluentBuilder
Constructs a fluent builder for the ListEarthObservationJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
status_equals(EarthObservationJobStatus)
/set_status_equals(Option<EarthObservationJobStatus>)
:
required: falseA filter that retrieves only jobs with a specific status.
sort_order(SortOrder)
/set_sort_order(Option<SortOrder>)
:
required: falseAn optional value that specifies whether you want the results sorted in
Ascending
orDescending
order.sort_by(impl Into<String>)
/set_sort_by(Option<String>)
:
required: falseThe parameter by which to sort the results.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe total number of items to return.
- On success, responds with
ListEarthObservationJobsOutput
with field(s):earth_observation_job_summaries(Vec::<ListEarthObservationJobOutputConfig>)
:Contains summary information about the Earth Observation jobs.
next_token(Option<String>)
:If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
- On failure, responds with
SdkError<ListEarthObservationJobsError>
Source§impl Client
impl Client
Sourcepub fn list_raster_data_collections(
&self,
) -> ListRasterDataCollectionsFluentBuilder
pub fn list_raster_data_collections( &self, ) -> ListRasterDataCollectionsFluentBuilder
Constructs a fluent builder for the ListRasterDataCollections
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe total number of items to return.
- On success, responds with
ListRasterDataCollectionsOutput
with field(s):raster_data_collection_summaries(Vec::<RasterDataCollectionMetadata>)
:Contains summary information about the raster data collection.
next_token(Option<String>)
:If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
- On failure, responds with
SdkError<ListRasterDataCollectionsError>
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 Amazon Resource Name (ARN) of the resource you want to tag.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:Each tag consists of a key and a value.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn list_vector_enrichment_jobs(
&self,
) -> ListVectorEnrichmentJobsFluentBuilder
pub fn list_vector_enrichment_jobs( &self, ) -> ListVectorEnrichmentJobsFluentBuilder
Constructs a fluent builder for the ListVectorEnrichmentJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
status_equals(impl Into<String>)
/set_status_equals(Option<String>)
:
required: falseA filter that retrieves only jobs with a specific status.
sort_order(SortOrder)
/set_sort_order(Option<SortOrder>)
:
required: falseAn optional value that specifies whether you want the results sorted in
Ascending
orDescending
order.sort_by(impl Into<String>)
/set_sort_by(Option<String>)
:
required: falseThe parameter by which to sort the results.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of items to return.
- On success, responds with
ListVectorEnrichmentJobsOutput
with field(s):vector_enrichment_job_summaries(Vec::<ListVectorEnrichmentJobOutputConfig>)
:Contains summary information about the Vector Enrichment jobs.
next_token(Option<String>)
:If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
- On failure, responds with
SdkError<ListVectorEnrichmentJobsError>
Source§impl Client
impl Client
Sourcepub fn search_raster_data_collection(
&self,
) -> SearchRasterDataCollectionFluentBuilder
pub fn search_raster_data_collection( &self, ) -> SearchRasterDataCollectionFluentBuilder
Constructs a fluent builder for the SearchRasterDataCollection
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the raster data collection.
raster_data_collection_query(RasterDataCollectionQueryWithBandFilterInput)
/set_raster_data_collection_query(Option<RasterDataCollectionQueryWithBandFilterInput>)
:
required: trueRasterDataCollectionQuery consisting of AreaOfInterest(AOI), PropertyFilters and TimeRangeFilterInput used in SearchRasterDataCollection.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
- On success, responds with
SearchRasterDataCollectionOutput
with field(s):approximate_result_count(i32)
:Approximate number of results in the response.
next_token(Option<String>)
:If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
items(Option<Vec::<ItemSource>>)
:List of items matching the Raster DataCollectionQuery.
- On failure, responds with
SdkError<SearchRasterDataCollectionError>
Source§impl Client
impl Client
Sourcepub fn start_earth_observation_job(
&self,
) -> StartEarthObservationJobFluentBuilder
pub fn start_earth_observation_job( &self, ) -> StartEarthObservationJobFluentBuilder
Constructs a fluent builder for the StartEarthObservationJob
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the Earth Observation job.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique token that guarantees that the call to this API is idempotent.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:
required: falseThe Key Management Service key ID for server-side encryption.
input_config(InputConfigInput)
/set_input_config(Option<InputConfigInput>)
:
required: trueInput configuration information for the Earth Observation job.
job_config(JobConfigInput)
/set_job_config(Option<JobConfigInput>)
:
required: trueAn object containing information about the job configuration.
execution_role_arn(impl Into<String>)
/set_execution_role_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the IAM role that you specified for the job.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseEach tag consists of a key and a value.
- On success, responds with
StartEarthObservationJobOutput
with field(s):name(String)
:The name of the Earth Observation job.
arn(String)
:The Amazon Resource Name (ARN) of the Earth Observation job.
creation_time(DateTime)
:The creation time.
duration_in_seconds(i32)
:The duration of the session, in seconds.
status(EarthObservationJobStatus)
:The status of the Earth Observation job.
kms_key_id(Option<String>)
:The Key Management Service key ID for server-side encryption.
input_config(Option<InputConfigOutput>)
:Input configuration information for the Earth Observation job.
job_config(Option<JobConfigInput>)
:An object containing information about the job configuration.
execution_role_arn(String)
:The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
tags(Option<HashMap::<String, String>>)
:Each tag consists of a key and a value.
- On failure, responds with
SdkError<StartEarthObservationJobError>
Source§impl Client
impl Client
Sourcepub fn start_vector_enrichment_job(
&self,
) -> StartVectorEnrichmentJobFluentBuilder
pub fn start_vector_enrichment_job( &self, ) -> StartVectorEnrichmentJobFluentBuilder
Constructs a fluent builder for the StartVectorEnrichmentJob
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the Vector Enrichment job.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique token that guarantees that the call to this API is idempotent.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:
required: falseThe Key Management Service key ID for server-side encryption.
input_config(VectorEnrichmentJobInputConfig)
/set_input_config(Option<VectorEnrichmentJobInputConfig>)
:
required: trueInput configuration information for the Vector Enrichment job.
job_config(VectorEnrichmentJobConfig)
/set_job_config(Option<VectorEnrichmentJobConfig>)
:
required: trueAn object containing information about the job configuration.
execution_role_arn(impl Into<String>)
/set_execution_role_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the IAM role that you specified for the job.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseEach tag consists of a key and a value.
- On success, responds with
StartVectorEnrichmentJobOutput
with field(s):name(String)
:The name of the Vector Enrichment job.
arn(String)
:The Amazon Resource Name (ARN) of the Vector Enrichment job.
r#type(VectorEnrichmentJobType)
:The type of the Vector Enrichment job.
creation_time(DateTime)
:The creation time.
duration_in_seconds(i32)
:The duration of the Vector Enrichment job, in seconds.
status(VectorEnrichmentJobStatus)
:The status of the Vector Enrichment job being started.
kms_key_id(Option<String>)
:The Key Management Service key ID for server-side encryption.
input_config(Option<VectorEnrichmentJobInputConfig>)
:Input configuration information for starting the Vector Enrichment job.
job_config(Option<VectorEnrichmentJobConfig>)
:An object containing information about the job configuration.
execution_role_arn(String)
:The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
tags(Option<HashMap::<String, String>>)
:Each tag consists of a key and a value.
- On failure, responds with
SdkError<StartVectorEnrichmentJobError>
Source§impl Client
impl Client
Sourcepub fn stop_earth_observation_job(&self) -> StopEarthObservationJobFluentBuilder
pub fn stop_earth_observation_job(&self) -> StopEarthObservationJobFluentBuilder
Constructs a fluent builder for the StopEarthObservationJob
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Earth Observation job being stopped.
- On success, responds with
StopEarthObservationJobOutput
- On failure, responds with
SdkError<StopEarthObservationJobError>
Source§impl Client
impl Client
Sourcepub fn stop_vector_enrichment_job(&self) -> StopVectorEnrichmentJobFluentBuilder
pub fn stop_vector_enrichment_job(&self) -> StopVectorEnrichmentJobFluentBuilder
Constructs a fluent builder for the StopVectorEnrichmentJob
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Vector Enrichment job.
- On success, responds with
StopVectorEnrichmentJobOutput
- On failure, responds with
SdkError<StopVectorEnrichmentJobError>
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 Amazon Resource Name (ARN) of the resource you want to tag.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueEach tag consists of a key and a value.
- 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 Amazon Resource Name (ARN) of the resource you want to untag.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueKeys of the tags you want to remove.
- 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);