Struct aws_sdk_appfabric::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AppFabric
Client for invoking operations on AppFabric. Each operation on AppFabric 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_appfabric::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 Config
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_appfabric::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 BatchGetUserAccessTasks
operation has
a Client::batch_get_user_access_tasks
, 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.batch_get_user_access_tasks()
.app_bundle_identifier("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 batch_get_user_access_tasks(
&self
) -> BatchGetUserAccessTasksFluentBuilder
pub fn batch_get_user_access_tasks( &self ) -> BatchGetUserAccessTasksFluentBuilder
Constructs a fluent builder for the BatchGetUserAccessTasks
operation.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
task_id_list(impl Into<String>)
/set_task_id_list(Option<Vec::<String>>)
:
required: trueThe tasks IDs to use for the request.
- On success, responds with
BatchGetUserAccessTasksOutput
with field(s):user_access_results_list(Option<Vec::<UserAccessResultItem>>)
:Contains a list of user access results.
- On failure, responds with
SdkError<BatchGetUserAccessTasksError>
source§impl Client
impl Client
Constructs a fluent builder for the ConnectAppAuthorization
operation.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle that contains the app authorization to use for the request.
app_authorization_identifier(impl Into<String>)
/set_app_authorization_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
auth_request(AuthRequest)
/set_auth_request(Option<AuthRequest>)
:
required: falseContains OAuth2 authorization information.
This is required if the app authorization for the request is configured with an OAuth2 (
oauth2
) authorization type.
- On success, responds with
ConnectAppAuthorizationOutput
with field(s):app_authorization_summary(Option<AppAuthorizationSummary>)
:Contains a summary of the app authorization.
- On failure, responds with
SdkError<ConnectAppAuthorizationError>
source§impl Client
impl Client
Constructs a fluent builder for the CreateAppAuthorization
operation.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
app(impl Into<String>)
/set_app(Option<String>)
:
required: trueThe name of the application.
Valid values are:
-
SLACK
-
ASANA
-
JIRA
-
M365
-
M365AUDITLOGS
-
ZOOM
-
ZENDESK
-
OKTA
-
GOOGLE
-
DROPBOX
-
SMARTSHEET
-
CISCO
-
credential(Credential)
/set_credential(Option<Credential>)
:
required: trueContains credentials for the application, such as an API key or OAuth2 client ID and secret.
Specify credentials that match the authorization type for your request. For example, if the authorization type for your request is OAuth2 (
oauth2
), then you should provide only the OAuth2 credentials.tenant(Tenant)
/set_tenant(Option<Tenant>)
:
required: trueContains information about an application tenant, such as the application display name and identifier.
auth_type(AuthType)
/set_auth_type(Option<AuthType>)
:
required: trueThe authorization type for the app authorization.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseSpecifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don’t provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same
ClientToken
, but with different parameters, the retry fails with anIdempotentParameterMismatch
error.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA map of the key-value pairs of the tag or tags to assign to the resource.
- On success, responds with
CreateAppAuthorizationOutput
with field(s):app_authorization(Option<AppAuthorization>)
:Contains information about an app authorization.
- On failure, responds with
SdkError<CreateAppAuthorizationError>
source§impl Client
impl Client
sourcepub fn create_app_bundle(&self) -> CreateAppBundleFluentBuilder
pub fn create_app_bundle(&self) -> CreateAppBundleFluentBuilder
Constructs a fluent builder for the CreateAppBundle
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseSpecifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don’t provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same
ClientToken
, but with different parameters, the retry fails with anIdempotentParameterMismatch
error.customer_managed_key_identifier(impl Into<String>)
/set_customer_managed_key_identifier(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use to encrypt the application data. If this is not specified, an Amazon Web Services owned key is used for encryption.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA map of the key-value pairs of the tag or tags to assign to the resource.
- On success, responds with
CreateAppBundleOutput
with field(s):app_bundle(Option<AppBundle>)
:Contains information about an app bundle.
- On failure, responds with
SdkError<CreateAppBundleError>
source§impl Client
impl Client
sourcepub fn create_ingestion(&self) -> CreateIngestionFluentBuilder
pub fn create_ingestion(&self) -> CreateIngestionFluentBuilder
Constructs a fluent builder for the CreateIngestion
operation.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
app(impl Into<String>)
/set_app(Option<String>)
:
required: trueThe name of the application.
Valid values are:
-
SLACK
-
ASANA
-
JIRA
-
M365
-
M365AUDITLOGS
-
ZOOM
-
ZENDESK
-
OKTA
-
GOOGLE
-
DROPBOX
-
SMARTSHEET
-
CISCO
-
tenant_id(impl Into<String>)
/set_tenant_id(Option<String>)
:
required: trueThe ID of the application tenant.
ingestion_type(IngestionType)
/set_ingestion_type(Option<IngestionType>)
:
required: trueThe ingestion type.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseSpecifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don’t provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same
ClientToken
, but with different parameters, the retry fails with anIdempotentParameterMismatch
error.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA map of the key-value pairs of the tag or tags to assign to the resource.
- On success, responds with
CreateIngestionOutput
with field(s):ingestion(Option<Ingestion>)
:Contains information about an ingestion.
- On failure, responds with
SdkError<CreateIngestionError>
source§impl Client
impl Client
sourcepub fn create_ingestion_destination(
&self
) -> CreateIngestionDestinationFluentBuilder
pub fn create_ingestion_destination( &self ) -> CreateIngestionDestinationFluentBuilder
Constructs a fluent builder for the CreateIngestionDestination
operation.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
ingestion_identifier(impl Into<String>)
/set_ingestion_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
processing_configuration(ProcessingConfiguration)
/set_processing_configuration(Option<ProcessingConfiguration>)
:
required: trueContains information about how ingested data is processed.
destination_configuration(DestinationConfiguration)
/set_destination_configuration(Option<DestinationConfiguration>)
:
required: trueContains information about the destination of ingested data.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseSpecifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don’t provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same
ClientToken
, but with different parameters, the retry fails with anIdempotentParameterMismatch
error.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA map of the key-value pairs of the tag or tags to assign to the resource.
- On success, responds with
CreateIngestionDestinationOutput
with field(s):ingestion_destination(Option<IngestionDestination>)
:Contains information about an ingestion destination.
- On failure, responds with
SdkError<CreateIngestionDestinationError>
source§impl Client
impl Client
Constructs a fluent builder for the DeleteAppAuthorization
operation.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
app_authorization_identifier(impl Into<String>)
/set_app_authorization_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
- On success, responds with
DeleteAppAuthorizationOutput
- On failure, responds with
SdkError<DeleteAppAuthorizationError>
source§impl Client
impl Client
sourcepub fn delete_app_bundle(&self) -> DeleteAppBundleFluentBuilder
pub fn delete_app_bundle(&self) -> DeleteAppBundleFluentBuilder
Constructs a fluent builder for the DeleteAppBundle
operation.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe ID or Amazon Resource Name (ARN) of the app bundle that needs to be deleted.
- On success, responds with
DeleteAppBundleOutput
- On failure, responds with
SdkError<DeleteAppBundleError>
source§impl Client
impl Client
sourcepub fn delete_ingestion(&self) -> DeleteIngestionFluentBuilder
pub fn delete_ingestion(&self) -> DeleteIngestionFluentBuilder
Constructs a fluent builder for the DeleteIngestion
operation.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
ingestion_identifier(impl Into<String>)
/set_ingestion_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
- On success, responds with
DeleteIngestionOutput
- On failure, responds with
SdkError<DeleteIngestionError>
source§impl Client
impl Client
sourcepub fn delete_ingestion_destination(
&self
) -> DeleteIngestionDestinationFluentBuilder
pub fn delete_ingestion_destination( &self ) -> DeleteIngestionDestinationFluentBuilder
Constructs a fluent builder for the DeleteIngestionDestination
operation.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
ingestion_identifier(impl Into<String>)
/set_ingestion_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
ingestion_destination_identifier(impl Into<String>)
/set_ingestion_destination_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.
- On success, responds with
DeleteIngestionDestinationOutput
- On failure, responds with
SdkError<DeleteIngestionDestinationError>
source§impl Client
impl Client
Constructs a fluent builder for the GetAppAuthorization
operation.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
app_authorization_identifier(impl Into<String>)
/set_app_authorization_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
- On success, responds with
GetAppAuthorizationOutput
with field(s):app_authorization(Option<AppAuthorization>)
:Contains information about an app authorization.
- On failure, responds with
SdkError<GetAppAuthorizationError>
source§impl Client
impl Client
sourcepub fn get_app_bundle(&self) -> GetAppBundleFluentBuilder
pub fn get_app_bundle(&self) -> GetAppBundleFluentBuilder
Constructs a fluent builder for the GetAppBundle
operation.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
- On success, responds with
GetAppBundleOutput
with field(s):app_bundle(Option<AppBundle>)
:Contains information about an app bundle.
- On failure, responds with
SdkError<GetAppBundleError>
source§impl Client
impl Client
sourcepub fn get_ingestion(&self) -> GetIngestionFluentBuilder
pub fn get_ingestion(&self) -> GetIngestionFluentBuilder
Constructs a fluent builder for the GetIngestion
operation.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
ingestion_identifier(impl Into<String>)
/set_ingestion_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
- On success, responds with
GetIngestionOutput
with field(s):ingestion(Option<Ingestion>)
:Contains information about an ingestion.
- On failure, responds with
SdkError<GetIngestionError>
source§impl Client
impl Client
sourcepub fn get_ingestion_destination(&self) -> GetIngestionDestinationFluentBuilder
pub fn get_ingestion_destination(&self) -> GetIngestionDestinationFluentBuilder
Constructs a fluent builder for the GetIngestionDestination
operation.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
ingestion_identifier(impl Into<String>)
/set_ingestion_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
ingestion_destination_identifier(impl Into<String>)
/set_ingestion_destination_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.
- On success, responds with
GetIngestionDestinationOutput
with field(s):ingestion_destination(Option<IngestionDestination>)
:Contains information about an ingestion destination.
- On failure, responds with
SdkError<GetIngestionDestinationError>
source§impl Client
impl Client
Constructs a fluent builder for the ListAppAuthorizations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned per call. You can use
nextToken
to obtain further pages of results.This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. 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 will return an HTTP 400 InvalidToken error.
- On success, responds with
ListAppAuthorizationsOutput
with field(s):app_authorization_summary_list(Vec::<AppAuthorizationSummary>)
:Contains a list of app authorization summaries.
next_token(Option<String>)
:If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. 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 will return an HTTP 400 InvalidToken error.
- On failure, responds with
SdkError<ListAppAuthorizationsError>
source§impl Client
impl Client
sourcepub fn list_app_bundles(&self) -> ListAppBundlesFluentBuilder
pub fn list_app_bundles(&self) -> ListAppBundlesFluentBuilder
Constructs a fluent builder for the ListAppBundles
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned per call. You can use
nextToken
to obtain further pages of results.This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. 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 will return an HTTP 400 InvalidToken error.
- On success, responds with
ListAppBundlesOutput
with field(s):app_bundle_summary_list(Vec::<AppBundleSummary>)
:Contains a list of app bundle summaries.
next_token(Option<String>)
:If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. 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 will return an HTTP 400 InvalidToken error.
- On failure, responds with
SdkError<ListAppBundlesError>
source§impl Client
impl Client
sourcepub fn list_ingestion_destinations(
&self
) -> ListIngestionDestinationsFluentBuilder
pub fn list_ingestion_destinations( &self ) -> ListIngestionDestinationsFluentBuilder
Constructs a fluent builder for the ListIngestionDestinations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
ingestion_identifier(impl Into<String>)
/set_ingestion_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned per call. You can use
nextToken
to obtain further pages of results.This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. 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 will return an HTTP 400 InvalidToken error.
- On success, responds with
ListIngestionDestinationsOutput
with field(s):ingestion_destinations(Vec::<IngestionDestinationSummary>)
:Contains a list of ingestion destination summaries.
next_token(Option<String>)
:If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. 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 will return an HTTP 400 InvalidToken error.
- On failure, responds with
SdkError<ListIngestionDestinationsError>
source§impl Client
impl Client
sourcepub fn list_ingestions(&self) -> ListIngestionsFluentBuilder
pub fn list_ingestions(&self) -> ListIngestionsFluentBuilder
Constructs a fluent builder for the ListIngestions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results that are returned per call. You can use
nextToken
to obtain further pages of results.This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. 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 will return an HTTP 400 InvalidToken error.
- On success, responds with
ListIngestionsOutput
with field(s):ingestions(Vec::<IngestionSummary>)
:Contains a list of ingestion summaries.
next_token(Option<String>)
:If
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. 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 will return an HTTP 400 InvalidToken error.
- On failure, responds with
SdkError<ListIngestionsError>
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 for which you want to retrieve tags.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec::<Tag>>)
:A map of the key-value pairs for the tag or tags assigned to the specified resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn start_ingestion(&self) -> StartIngestionFluentBuilder
pub fn start_ingestion(&self) -> StartIngestionFluentBuilder
Constructs a fluent builder for the StartIngestion
operation.
- The fluent builder is configurable:
ingestion_identifier(impl Into<String>)
/set_ingestion_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
- On success, responds with
StartIngestionOutput
- On failure, responds with
SdkError<StartIngestionError>
source§impl Client
impl Client
sourcepub fn start_user_access_tasks(&self) -> StartUserAccessTasksFluentBuilder
pub fn start_user_access_tasks(&self) -> StartUserAccessTasksFluentBuilder
Constructs a fluent builder for the StartUserAccessTasks
operation.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
email(impl Into<String>)
/set_email(Option<String>)
:
required: trueThe email address of the target user.
- On success, responds with
StartUserAccessTasksOutput
with field(s):user_access_tasks_list(Option<Vec::<UserAccessTaskItem>>)
:Contains a list of user access task information.
- On failure, responds with
SdkError<StartUserAccessTasksError>
source§impl Client
impl Client
sourcepub fn stop_ingestion(&self) -> StopIngestionFluentBuilder
pub fn stop_ingestion(&self) -> StopIngestionFluentBuilder
Constructs a fluent builder for the StopIngestion
operation.
- The fluent builder is configurable:
ingestion_identifier(impl Into<String>)
/set_ingestion_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
- On success, responds with
StopIngestionOutput
- On failure, responds with
SdkError<StopIngestionError>
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 that you want to tag.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueA map of the key-value pairs of the tag or tags to assign to the resource.
- 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 that you want to untag.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe keys of the key-value pairs for the tag or tags you want to remove from the specified resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
Constructs a fluent builder for the UpdateAppAuthorization
operation.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
app_authorization_identifier(impl Into<String>)
/set_app_authorization_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.
credential(Credential)
/set_credential(Option<Credential>)
:
required: falseContains credentials for the application, such as an API key or OAuth2 client ID and secret.
Specify credentials that match the authorization type of the app authorization to update. For example, if the authorization type of the app authorization is OAuth2 (
oauth2
), then you should provide only the OAuth2 credentials.tenant(Tenant)
/set_tenant(Option<Tenant>)
:
required: falseContains information about an application tenant, such as the application display name and identifier.
- On success, responds with
UpdateAppAuthorizationOutput
with field(s):app_authorization(Option<AppAuthorization>)
:Contains information about an app authorization.
- On failure, responds with
SdkError<UpdateAppAuthorizationError>
source§impl Client
impl Client
sourcepub fn update_ingestion_destination(
&self
) -> UpdateIngestionDestinationFluentBuilder
pub fn update_ingestion_destination( &self ) -> UpdateIngestionDestinationFluentBuilder
Constructs a fluent builder for the UpdateIngestionDestination
operation.
- The fluent builder is configurable:
app_bundle_identifier(impl Into<String>)
/set_app_bundle_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
ingestion_identifier(impl Into<String>)
/set_ingestion_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.
ingestion_destination_identifier(impl Into<String>)
/set_ingestion_destination_identifier(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.
destination_configuration(DestinationConfiguration)
/set_destination_configuration(Option<DestinationConfiguration>)
:
required: trueContains information about the destination of ingested data.
- On success, responds with
UpdateIngestionDestinationOutput
with field(s):ingestion_destination(Option<IngestionDestination>)
:Contains information about an ingestion destination.
- On failure, responds with
SdkError<UpdateIngestionDestinationError>
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> 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 more