AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . chatbot ]

get-microsoft-teams-channel-configuration

Description

Returns a Microsoft Teams channel configuration in an AWS account.

See also: AWS API Documentation

Synopsis

  get-microsoft-teams-channel-configuration
--chat-configuration-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--chat-configuration-arn (string)

The Amazon Resource Number (ARN) of the MicrosoftTeamsChannelConfiguration to retrieve.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

ChannelConfiguration -> (structure)

The configuration for a Microsoft Teams channel configured with AWS Chatbot.

ChannelId -> (string)

The ID of the Microsoft Teams channel.

ChannelName -> (string)

The name of the Microsoft Teams channel.

TeamId -> (string)

The ID of the Microsoft Teams 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 information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide .

TeamName -> (string)

The name of the Microsoft Teams Team.

TenantId -> (string)

The ID of the Microsoft Teams tenant.

ChatConfigurationArn -> (string)

The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

IamRoleArn -> (string)

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide .

SnsTopicArns -> (list)

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

(string)

ConfigurationName -> (string)

The name of the configuration.

LoggingLevel -> (string)

Logging levels include ERROR , INFO , or NONE .

GuardrailPolicyArns -> (list)

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.

(string)

UserAuthorizationRequired -> (boolean)

Enables use of a user role requirement in your chat configuration.

Tags -> (list)

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

(structure)

A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

Warning

Do not include confidential or sensitive information in this field.

For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .

TagKey -> (string)

The key of the tag.

TagValue -> (string)

The value of the tag.