Struct aws_sdk_chatbot::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS Chatbot
Client for invoking operations on AWS Chatbot. Each operation on AWS Chatbot 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_chatbot::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_chatbot::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 CreateChimeWebhookConfiguration
operation has
a Client::create_chime_webhook_configuration
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.create_chime_webhook_configuration()
.webhook_description("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 create_chime_webhook_configuration(
&self
) -> CreateChimeWebhookConfigurationFluentBuilder
pub fn create_chime_webhook_configuration( &self ) -> CreateChimeWebhookConfigurationFluentBuilder
Constructs a fluent builder for the CreateChimeWebhookConfiguration
operation.
- The fluent builder is configurable:
webhook_description(impl Into<String>)
/set_webhook_description(Option<String>)
:
required: true
Description of the webhook. Recommend using the conventionRoomName/WebhookName
. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.webhook_url(impl Into<String>)
/set_webhook_url(Option<String>)
:
required: true
URL for the Chime webhook.sns_topic_arns(impl Into<String>)
/set_sns_topic_arns(Option<Vec::<String>>)
:
required: true
The ARNs of the SNS topics that deliver notifications to AWS Chatbot.iam_role_arn(impl Into<String>)
/set_iam_role_arn(Option<String>)
:
required: true
This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.configuration_name(impl Into<String>)
/set_configuration_name(Option<String>)
:
required: true
The name of the configuration.logging_level(impl Into<String>)
/set_logging_level(Option<String>)
:
required: false
Logging levels include ERROR, INFO, or NONE.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: false
A list of tags to apply to the configuration.
- On success, responds with
CreateChimeWebhookConfigurationOutput
with field(s):webhook_configuration(Option<ChimeWebhookConfiguration>)
: Chime webhook configuration.
- On failure, responds with
SdkError<CreateChimeWebhookConfigurationError>
source§impl Client
impl Client
sourcepub fn create_microsoft_teams_channel_configuration(
&self
) -> CreateMicrosoftTeamsChannelConfigurationFluentBuilder
pub fn create_microsoft_teams_channel_configuration( &self ) -> CreateMicrosoftTeamsChannelConfigurationFluentBuilder
Constructs a fluent builder for the CreateMicrosoftTeamsChannelConfiguration
operation.
- The fluent builder is configurable:
channel_id(impl Into<String>)
/set_channel_id(Option<String>)
:
required: true
The ID of the Microsoft Teams channel.channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: false
The name of the Microsoft Teams channel.team_id(impl Into<String>)
/set_team_id(Option<String>)
:
required: true
The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.team_name(impl Into<String>)
/set_team_name(Option<String>)
:
required: false
The name of the Microsoft Teams Team.tenant_id(impl Into<String>)
/set_tenant_id(Option<String>)
:
required: true
The ID of the Microsoft Teams tenant.sns_topic_arns(impl Into<String>)
/set_sns_topic_arns(Option<Vec::<String>>)
:
required: false
The ARNs of the SNS topics that deliver notifications to AWS Chatbot.iam_role_arn(impl Into<String>)
/set_iam_role_arn(Option<String>)
:
required: true
The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.configuration_name(impl Into<String>)
/set_configuration_name(Option<String>)
:
required: true
The name of the configuration.logging_level(impl Into<String>)
/set_logging_level(Option<String>)
:
required: false
Logging levels include ERROR, INFO, or NONE.guardrail_policy_arns(impl Into<String>)
/set_guardrail_policy_arns(Option<Vec::<String>>)
:
required: false
The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed ‘AdministratorAccess’ policy is applied by default if this is not set.user_authorization_required(bool)
/set_user_authorization_required(Option<bool>)
:
required: false
Enables use of a user role requirement in your chat configuration.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: false
A list of tags to apply to the configuration.
- On success, responds with
CreateMicrosoftTeamsChannelConfigurationOutput
with field(s):channel_configuration(Option<TeamsChannelConfiguration>)
: The configuration for a Microsoft Teams channel configured with AWS Chatbot.
- On failure, responds with
SdkError<CreateMicrosoftTeamsChannelConfigurationError>
source§impl Client
impl Client
sourcepub fn create_slack_channel_configuration(
&self
) -> CreateSlackChannelConfigurationFluentBuilder
pub fn create_slack_channel_configuration( &self ) -> CreateSlackChannelConfigurationFluentBuilder
Constructs a fluent builder for the CreateSlackChannelConfiguration
operation.
- The fluent builder is configurable:
slack_team_id(impl Into<String>)
/set_slack_team_id(Option<String>)
:
required: true
The ID of the Slack workspace authorized with AWS Chatbot.slack_channel_id(impl Into<String>)
/set_slack_channel_id(Option<String>)
:
required: true
The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.slack_channel_name(impl Into<String>)
/set_slack_channel_name(Option<String>)
:
required: false
The name of the Slack Channel.sns_topic_arns(impl Into<String>)
/set_sns_topic_arns(Option<Vec::<String>>)
:
required: false
The ARNs of the SNS topics that deliver notifications to AWS Chatbot.iam_role_arn(impl Into<String>)
/set_iam_role_arn(Option<String>)
:
required: true
The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.configuration_name(impl Into<String>)
/set_configuration_name(Option<String>)
:
required: true
The name of the configuration.logging_level(impl Into<String>)
/set_logging_level(Option<String>)
:
required: false
Logging levels include ERROR, INFO, or NONE.guardrail_policy_arns(impl Into<String>)
/set_guardrail_policy_arns(Option<Vec::<String>>)
:
required: false
The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed ‘AdministratorAccess’ policy is applied by default if this is not set.user_authorization_required(bool)
/set_user_authorization_required(Option<bool>)
:
required: false
Enables use of a user role requirement in your chat configuration.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: false
A list of tags to apply to the configuration.
- On success, responds with
CreateSlackChannelConfigurationOutput
with field(s):channel_configuration(Option<SlackChannelConfiguration>)
: The configuration for a Slack channel configured with AWS Chatbot.
- On failure, responds with
SdkError<CreateSlackChannelConfigurationError>
source§impl Client
impl Client
sourcepub fn delete_chime_webhook_configuration(
&self
) -> DeleteChimeWebhookConfigurationFluentBuilder
pub fn delete_chime_webhook_configuration( &self ) -> DeleteChimeWebhookConfigurationFluentBuilder
Constructs a fluent builder for the DeleteChimeWebhookConfiguration
operation.
- The fluent builder is configurable:
chat_configuration_arn(impl Into<String>)
/set_chat_configuration_arn(Option<String>)
:
required: true
The ARN of the ChimeWebhookConfiguration to delete.
- On success, responds with
DeleteChimeWebhookConfigurationOutput
- On failure, responds with
SdkError<DeleteChimeWebhookConfigurationError>
source§impl Client
impl Client
sourcepub fn delete_microsoft_teams_channel_configuration(
&self
) -> DeleteMicrosoftTeamsChannelConfigurationFluentBuilder
pub fn delete_microsoft_teams_channel_configuration( &self ) -> DeleteMicrosoftTeamsChannelConfigurationFluentBuilder
Constructs a fluent builder for the DeleteMicrosoftTeamsChannelConfiguration
operation.
- The fluent builder is configurable:
chat_configuration_arn(impl Into<String>)
/set_chat_configuration_arn(Option<String>)
:
required: true
The ARN of the MicrosoftTeamsChannelConfiguration to delete.
- On success, responds with
DeleteMicrosoftTeamsChannelConfigurationOutput
- On failure, responds with
SdkError<DeleteMicrosoftTeamsChannelConfigurationError>
source§impl Client
impl Client
sourcepub fn delete_microsoft_teams_configured_team(
&self
) -> DeleteMicrosoftTeamsConfiguredTeamFluentBuilder
pub fn delete_microsoft_teams_configured_team( &self ) -> DeleteMicrosoftTeamsConfiguredTeamFluentBuilder
Constructs a fluent builder for the DeleteMicrosoftTeamsConfiguredTeam
operation.
- The fluent builder is configurable:
team_id(impl Into<String>)
/set_team_id(Option<String>)
:
required: true
The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
- On success, responds with
DeleteMicrosoftTeamsConfiguredTeamOutput
- On failure, responds with
SdkError<DeleteMicrosoftTeamsConfiguredTeamError>
source§impl Client
impl Client
sourcepub fn delete_microsoft_teams_user_identity(
&self
) -> DeleteMicrosoftTeamsUserIdentityFluentBuilder
pub fn delete_microsoft_teams_user_identity( &self ) -> DeleteMicrosoftTeamsUserIdentityFluentBuilder
Constructs a fluent builder for the DeleteMicrosoftTeamsUserIdentity
operation.
- The fluent builder is configurable:
chat_configuration_arn(impl Into<String>)
/set_chat_configuration_arn(Option<String>)
:
required: true
The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: true
Id from Microsoft Teams for user.
- On success, responds with
DeleteMicrosoftTeamsUserIdentityOutput
- On failure, responds with
SdkError<DeleteMicrosoftTeamsUserIdentityError>
source§impl Client
impl Client
sourcepub fn delete_slack_channel_configuration(
&self
) -> DeleteSlackChannelConfigurationFluentBuilder
pub fn delete_slack_channel_configuration( &self ) -> DeleteSlackChannelConfigurationFluentBuilder
Constructs a fluent builder for the DeleteSlackChannelConfiguration
operation.
- The fluent builder is configurable:
chat_configuration_arn(impl Into<String>)
/set_chat_configuration_arn(Option<String>)
:
required: true
The ARN of the SlackChannelConfiguration to delete.
- On success, responds with
DeleteSlackChannelConfigurationOutput
- On failure, responds with
SdkError<DeleteSlackChannelConfigurationError>
source§impl Client
impl Client
sourcepub fn delete_slack_user_identity(&self) -> DeleteSlackUserIdentityFluentBuilder
pub fn delete_slack_user_identity(&self) -> DeleteSlackUserIdentityFluentBuilder
Constructs a fluent builder for the DeleteSlackUserIdentity
operation.
- The fluent builder is configurable:
chat_configuration_arn(impl Into<String>)
/set_chat_configuration_arn(Option<String>)
:
required: true
The ARN of the SlackChannelConfiguration associated with the user identity to delete.slack_team_id(impl Into<String>)
/set_slack_team_id(Option<String>)
:
required: true
The ID of the Slack workspace authorized with AWS Chatbot.slack_user_id(impl Into<String>)
/set_slack_user_id(Option<String>)
:
required: true
The ID of the user in Slack.
- On success, responds with
DeleteSlackUserIdentityOutput
- On failure, responds with
SdkError<DeleteSlackUserIdentityError>
source§impl Client
impl Client
Constructs a fluent builder for the DeleteSlackWorkspaceAuthorization
operation.
- The fluent builder is configurable:
slack_team_id(impl Into<String>)
/set_slack_team_id(Option<String>)
:
required: true
The ID of the Slack workspace authorized with AWS Chatbot.
- On success, responds with
DeleteSlackWorkspaceAuthorizationOutput
- On failure, responds with
SdkError<DeleteSlackWorkspaceAuthorizationError>
source§impl Client
impl Client
sourcepub fn describe_chime_webhook_configurations(
&self
) -> DescribeChimeWebhookConfigurationsFluentBuilder
pub fn describe_chime_webhook_configurations( &self ) -> DescribeChimeWebhookConfigurationsFluentBuilder
Constructs a fluent builder for the DescribeChimeWebhookConfigurations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.chat_configuration_arn(impl Into<String>)
/set_chat_configuration_arn(Option<String>)
:
required: false
An optional ARN of a ChimeWebhookConfiguration to describe.
- On success, responds with
DescribeChimeWebhookConfigurationsOutput
with field(s):next_token(Option<String>)
: An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.webhook_configurations(Option<Vec::<ChimeWebhookConfiguration>>)
: A list of Chime webhooks associated with the account.
- On failure, responds with
SdkError<DescribeChimeWebhookConfigurationsError>
source§impl Client
impl Client
sourcepub fn describe_slack_channel_configurations(
&self
) -> DescribeSlackChannelConfigurationsFluentBuilder
pub fn describe_slack_channel_configurations( &self ) -> DescribeSlackChannelConfigurationsFluentBuilder
Constructs a fluent builder for the DescribeSlackChannelConfigurations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.chat_configuration_arn(impl Into<String>)
/set_chat_configuration_arn(Option<String>)
:
required: false
An optional ARN of a SlackChannelConfiguration to describe.
- On success, responds with
DescribeSlackChannelConfigurationsOutput
with field(s):next_token(Option<String>)
: An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.slack_channel_configurations(Option<Vec::<SlackChannelConfiguration>>)
: A list of Slack channel configurations.
- On failure, responds with
SdkError<DescribeSlackChannelConfigurationsError>
source§impl Client
impl Client
sourcepub fn describe_slack_user_identities(
&self
) -> DescribeSlackUserIdentitiesFluentBuilder
pub fn describe_slack_user_identities( &self ) -> DescribeSlackUserIdentitiesFluentBuilder
Constructs a fluent builder for the DescribeSlackUserIdentities
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
chat_configuration_arn(impl Into<String>)
/set_chat_configuration_arn(Option<String>)
:
required: false
The ARN of the SlackChannelConfiguration associated with the user identities to describe.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.max_results(i32)
/set_max_results(Option<i32>)
:
required: false
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
- On success, responds with
DescribeSlackUserIdentitiesOutput
with field(s):slack_user_identities(Option<Vec::<SlackUserIdentity>>)
: A list of Slack User Identities.next_token(Option<String>)
: An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
- On failure, responds with
SdkError<DescribeSlackUserIdentitiesError>
source§impl Client
impl Client
sourcepub fn describe_slack_workspaces(&self) -> DescribeSlackWorkspacesFluentBuilder
pub fn describe_slack_workspaces(&self) -> DescribeSlackWorkspacesFluentBuilder
Constructs a fluent builder for the DescribeSlackWorkspaces
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
- On success, responds with
DescribeSlackWorkspacesOutput
with field(s):slack_workspaces(Option<Vec::<SlackWorkspace>>)
: A list of Slack Workspaces registered with AWS Chatbot.next_token(Option<String>)
: An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
- On failure, responds with
SdkError<DescribeSlackWorkspacesError>
source§impl Client
impl Client
sourcepub fn get_account_preferences(&self) -> GetAccountPreferencesFluentBuilder
pub fn get_account_preferences(&self) -> GetAccountPreferencesFluentBuilder
Constructs a fluent builder for the GetAccountPreferences
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetAccountPreferencesOutput
with field(s):account_preferences(Option<AccountPreferences>)
: Preferences which apply for AWS Chatbot usage in the calling AWS account.
- On failure, responds with
SdkError<GetAccountPreferencesError>
source§impl Client
impl Client
sourcepub fn get_microsoft_teams_channel_configuration(
&self
) -> GetMicrosoftTeamsChannelConfigurationFluentBuilder
pub fn get_microsoft_teams_channel_configuration( &self ) -> GetMicrosoftTeamsChannelConfigurationFluentBuilder
Constructs a fluent builder for the GetMicrosoftTeamsChannelConfiguration
operation.
- The fluent builder is configurable:
chat_configuration_arn(impl Into<String>)
/set_chat_configuration_arn(Option<String>)
:
required: true
The ARN of the MicrosoftTeamsChannelConfiguration to retrieve.
- On success, responds with
GetMicrosoftTeamsChannelConfigurationOutput
with field(s):channel_configuration(Option<TeamsChannelConfiguration>)
: The configuration for a Microsoft Teams channel configured with AWS Chatbot.
- On failure, responds with
SdkError<GetMicrosoftTeamsChannelConfigurationError>
source§impl Client
impl Client
sourcepub fn list_microsoft_teams_channel_configurations(
&self
) -> ListMicrosoftTeamsChannelConfigurationsFluentBuilder
pub fn list_microsoft_teams_channel_configurations( &self ) -> ListMicrosoftTeamsChannelConfigurationsFluentBuilder
Constructs a fluent builder for the ListMicrosoftTeamsChannelConfigurations
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.team_id(impl Into<String>)
/set_team_id(Option<String>)
:
required: false
The ID of the Microsoft Team authorized with AWS Chatbot. To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
- On success, responds with
ListMicrosoftTeamsChannelConfigurationsOutput
with field(s):next_token(Option<String>)
: An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.team_channel_configurations(Option<Vec::<TeamsChannelConfiguration>>)
: A list of AWS Chatbot channel configurations for Microsoft Teams.
- On failure, responds with
SdkError<ListMicrosoftTeamsChannelConfigurationsError>
source§impl Client
impl Client
sourcepub fn list_microsoft_teams_configured_teams(
&self
) -> ListMicrosoftTeamsConfiguredTeamsFluentBuilder
pub fn list_microsoft_teams_configured_teams( &self ) -> ListMicrosoftTeamsConfiguredTeamsFluentBuilder
Constructs a fluent builder for the ListMicrosoftTeamsConfiguredTeams
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: false
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
- On success, responds with
ListMicrosoftTeamsConfiguredTeamsOutput
with field(s):configured_teams(Option<Vec::<ConfiguredTeam>>)
: A list of teams in Microsoft Teams that have been configured with AWS Chatbot.next_token(Option<String>)
: An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
- On failure, responds with
SdkError<ListMicrosoftTeamsConfiguredTeamsError>
source§impl Client
impl Client
sourcepub fn list_microsoft_teams_user_identities(
&self
) -> ListMicrosoftTeamsUserIdentitiesFluentBuilder
pub fn list_microsoft_teams_user_identities( &self ) -> ListMicrosoftTeamsUserIdentitiesFluentBuilder
Constructs a fluent builder for the ListMicrosoftTeamsUserIdentities
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
chat_configuration_arn(impl Into<String>)
/set_chat_configuration_arn(Option<String>)
:
required: false
The ARN of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: false
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.max_results(i32)
/set_max_results(Option<i32>)
:
required: false
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
- On success, responds with
ListMicrosoftTeamsUserIdentitiesOutput
with field(s):teams_user_identities(Option<Vec::<TeamsUserIdentity>>)
: User level permissions associated to a channel configuration.next_token(Option<String>)
: An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
- On failure, responds with
SdkError<ListMicrosoftTeamsUserIdentitiesError>
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: true
The ARN of the configuration.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec::<Tag>>)
: A list of tags applied to the configuration.
- On failure, responds with
SdkError<ListTagsForResourceError>
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: true
The ARN of the configuration.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: true
A list of tags to apply to the configuration.
- 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: true
The ARN of the configuration.tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: true
A list of tag keys to remove from the configuration.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_account_preferences(
&self
) -> UpdateAccountPreferencesFluentBuilder
pub fn update_account_preferences( &self ) -> UpdateAccountPreferencesFluentBuilder
Constructs a fluent builder for the UpdateAccountPreferences
operation.
- The fluent builder is configurable:
user_authorization_required(bool)
/set_user_authorization_required(Option<bool>)
:
required: false
Enables use of a user role requirement in your chat configuration.training_data_collection_enabled(bool)
/set_training_data_collection_enabled(Option<bool>)
:
required: false
Turns on training data collection. This helps improve the AWS Chatbot experience by allowing AWS Chatbot to store and use your customer information, such as AWS Chatbot configurations, notifications, user inputs, AWS Chatbot generated responses, and interaction data. This data helps us to continuously improve and develop Artificial Intelligence (AI) technologies. Your data is not shared with any third parties and is protected using sophisticated controls to prevent unauthorized access and misuse. AWS Chatbot does not store or use interactions in chat channels with Amazon Q for training AWS Chatbot’s AI technologies.
- On success, responds with
UpdateAccountPreferencesOutput
with field(s):account_preferences(Option<AccountPreferences>)
: Preferences which apply for AWS Chatbot usage in the calling AWS account.
- On failure, responds with
SdkError<UpdateAccountPreferencesError>
source§impl Client
impl Client
sourcepub fn update_chime_webhook_configuration(
&self
) -> UpdateChimeWebhookConfigurationFluentBuilder
pub fn update_chime_webhook_configuration( &self ) -> UpdateChimeWebhookConfigurationFluentBuilder
Constructs a fluent builder for the UpdateChimeWebhookConfiguration
operation.
- The fluent builder is configurable:
chat_configuration_arn(impl Into<String>)
/set_chat_configuration_arn(Option<String>)
:
required: true
The ARN of the ChimeWebhookConfiguration to update.webhook_description(impl Into<String>)
/set_webhook_description(Option<String>)
:
required: false
Description of the webhook. Recommend using the conventionRoomName/WebhookName
. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.webhook_url(impl Into<String>)
/set_webhook_url(Option<String>)
:
required: false
URL for the Chime webhook.sns_topic_arns(impl Into<String>)
/set_sns_topic_arns(Option<Vec::<String>>)
:
required: false
The ARNs of the SNS topics that deliver notifications to AWS Chatbot.iam_role_arn(impl Into<String>)
/set_iam_role_arn(Option<String>)
:
required: false
The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.logging_level(impl Into<String>)
/set_logging_level(Option<String>)
:
required: false
Logging levels include ERROR, INFO, or NONE.
- On success, responds with
UpdateChimeWebhookConfigurationOutput
with field(s):webhook_configuration(Option<ChimeWebhookConfiguration>)
: Chime webhook configuration.
- On failure, responds with
SdkError<UpdateChimeWebhookConfigurationError>
source§impl Client
impl Client
sourcepub fn update_microsoft_teams_channel_configuration(
&self
) -> UpdateMicrosoftTeamsChannelConfigurationFluentBuilder
pub fn update_microsoft_teams_channel_configuration( &self ) -> UpdateMicrosoftTeamsChannelConfigurationFluentBuilder
Constructs a fluent builder for the UpdateMicrosoftTeamsChannelConfiguration
operation.
- The fluent builder is configurable:
chat_configuration_arn(impl Into<String>)
/set_chat_configuration_arn(Option<String>)
:
required: true
The ARN of the MicrosoftTeamsChannelConfiguration to update.channel_id(impl Into<String>)
/set_channel_id(Option<String>)
:
required: true
The ID of the Microsoft Teams channel.channel_name(impl Into<String>)
/set_channel_name(Option<String>)
:
required: false
The name of the Microsoft Teams channel.sns_topic_arns(impl Into<String>)
/set_sns_topic_arns(Option<Vec::<String>>)
:
required: false
The ARNs of the SNS topics that deliver notifications to AWS Chatbot.iam_role_arn(impl Into<String>)
/set_iam_role_arn(Option<String>)
:
required: false
The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.logging_level(impl Into<String>)
/set_logging_level(Option<String>)
:
required: false
Logging levels include ERROR, INFO, or NONE.guardrail_policy_arns(impl Into<String>)
/set_guardrail_policy_arns(Option<Vec::<String>>)
:
required: false
The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed ‘AdministratorAccess’ policy is applied by default if this is not set.user_authorization_required(bool)
/set_user_authorization_required(Option<bool>)
:
required: false
Enables use of a user role requirement in your chat configuration.
- On success, responds with
UpdateMicrosoftTeamsChannelConfigurationOutput
with field(s):channel_configuration(Option<TeamsChannelConfiguration>)
: The configuration for a Microsoft Teams channel configured with AWS Chatbot.
- On failure, responds with
SdkError<UpdateMicrosoftTeamsChannelConfigurationError>
source§impl Client
impl Client
sourcepub fn update_slack_channel_configuration(
&self
) -> UpdateSlackChannelConfigurationFluentBuilder
pub fn update_slack_channel_configuration( &self ) -> UpdateSlackChannelConfigurationFluentBuilder
Constructs a fluent builder for the UpdateSlackChannelConfiguration
operation.
- The fluent builder is configurable:
chat_configuration_arn(impl Into<String>)
/set_chat_configuration_arn(Option<String>)
:
required: true
The ARN of the SlackChannelConfiguration to update.slack_channel_id(impl Into<String>)
/set_slack_channel_id(Option<String>)
:
required: true
The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.slack_channel_name(impl Into<String>)
/set_slack_channel_name(Option<String>)
:
required: false
The name of the Slack Channel.sns_topic_arns(impl Into<String>)
/set_sns_topic_arns(Option<Vec::<String>>)
:
required: false
The ARNs of the SNS topics that deliver notifications to AWS Chatbot.iam_role_arn(impl Into<String>)
/set_iam_role_arn(Option<String>)
:
required: false
The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.logging_level(impl Into<String>)
/set_logging_level(Option<String>)
:
required: false
Logging levels include ERROR, INFO, or NONE.guardrail_policy_arns(impl Into<String>)
/set_guardrail_policy_arns(Option<Vec::<String>>)
:
required: false
The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed ‘AdministratorAccess’ policy is applied by default if this is not set.user_authorization_required(bool)
/set_user_authorization_required(Option<bool>)
:
required: false
Enables use of a user role requirement in your chat configuration.
- On success, responds with
UpdateSlackChannelConfigurationOutput
with field(s):channel_configuration(Option<SlackChannelConfiguration>)
: The configuration for a Slack channel configured with AWS Chatbot.
- On failure, responds with
SdkError<UpdateSlackChannelConfigurationError>
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