Skip to content

list_microsoft_teams_channel_configurations async

list_microsoft_teams_channel_configurations(
    *,
    config_overrides: Optional[AsyncchatbotClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[PaginationToken] = None,
    team_id: Optional[UUID] = None,
) -> ListTeamsChannelConfigurationsResult

Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS account.

Parameters:

  • max_results (Optional[MaxResults], default: None ) –

    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 (Optional[PaginationToken], default: None ) –

    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 (Optional[UUID], default: None ) –

    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.

Raises:

Source code in docs_src/capo_chatbot/_services/async_chatbot.py
async def list_microsoft_teams_channel_configurations(
    self,
    *,
    config_overrides: Optional[AsyncchatbotClientConfig] = None,
    max_results: Optional["capo_chatbot.types.max_results.MaxResults"] = None,
    next_token: Optional[
        "capo_chatbot.types.pagination_token.PaginationToken"
    ] = None,
    team_id: Optional["capo_chatbot.types.uuid.UUID"] = None,
) -> "capo_chatbot.types.list_teams_channel_configurations_result.ListTeamsChannelConfigurationsResult":
    """<p>Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS account.</p>

    Args:
        max_results: <p>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.</p>
        next_token: <p>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.</p>
        team_id: <p> The ID of the Microsoft Teams authorized with AWS Chatbot.</p> <p>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 <a href="https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html#teams-client-setup">Step 1: Configure a Microsoft Teams client</a> in the <i> AWS Chatbot Administrator Guide</i>. </p>

    Raises:
        capo_chatbot.errors.invalid_parameter_exception.InvalidParameterException: <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
        capo_chatbot.errors.invalid_request_exception.InvalidRequestException: <p>Your request input doesn't meet the constraints required by AWS Chatbot.</p>
        capo_chatbot.errors.list_teams_channel_configurations_exception.ListTeamsChannelConfigurationsException: <p>We can’t process your request right now because of a server issue. Try again later.</p>
        capo_chatbot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chatbot.types.list_teams_channel_configurations_request.ListTeamsChannelConfigurationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_chatbot.types.list_teams_channel_configurations_result.ListTeamsChannelConfigurationsResult"
    ]:
        import capo_chatbot._operations.wheatley_orchestration_20171011.list_microsoft_teams_channel_configurations

        (
            output,
            http_response,
        ) = await capo_chatbot._operations.wheatley_orchestration_20171011.list_microsoft_teams_channel_configurations.async_list_microsoft_teams_channel_configurations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_chatbot.types.list_teams_channel_configurations_result.ListTeamsChannelConfigurationsResult",
    ) -> dict[str, Any]:
        import capo_chatbot.types.list_teams_channel_configurations_result

        return capo_chatbot.types.list_teams_channel_configurations_result.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListMicrosoftTeamsChannelConfigurations", redact_output=_redact_output
        ),
    )
    input_: capo_chatbot.types.list_teams_channel_configurations_request.ListTeamsChannelConfigurationsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if team_id is not None:
        input_["team_id"] = team_id

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output