A list all Microsoft Teams user identities with a mapped role.
Parameters:
-
chat_configuration_arn
(Optional[ChatConfigurationArn], default:
None
)
–
The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.
-
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.
-
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.
Raises:
Source code in docs_src/capo_chatbot/_services/chatbot.py
| def list_microsoft_teams_user_identities(
self,
*,
config_overrides: Optional[chatbotClientConfig] = None,
chat_configuration_arn: Optional[
"capo_chatbot.types.chat_configuration_arn.ChatConfigurationArn"
] = None,
next_token: Optional[
"capo_chatbot.types.pagination_token.PaginationToken"
] = None,
max_results: Optional["capo_chatbot.types.max_results.MaxResults"] = None,
) -> "capo_chatbot.types.list_microsoft_teams_user_identities_result.ListMicrosoftTeamsUserIdentitiesResult":
"""<p>A list all Microsoft Teams user identities with a mapped role.</p>
Args:
chat_configuration_arn: <p>The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.</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>
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>
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_microsoft_teams_user_identities_exception.ListMicrosoftTeamsUserIdentitiesException: <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.
"""
def _handler(
req: "OperationRequest[capo_chatbot.types.list_microsoft_teams_user_identities_request.ListMicrosoftTeamsUserIdentitiesRequest]",
) -> OperationResponse[
"capo_chatbot.types.list_microsoft_teams_user_identities_result.ListMicrosoftTeamsUserIdentitiesResult"
]:
import capo_chatbot._operations.wheatley_orchestration_20171011.list_microsoft_teams_user_identities
output, http_response = (
capo_chatbot._operations.wheatley_orchestration_20171011.list_microsoft_teams_user_identities.list_microsoft_teams_user_identities(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListMicrosoftTeamsUserIdentities")
)
input_: capo_chatbot.types.list_microsoft_teams_user_identities_request.ListMicrosoftTeamsUserIdentitiesRequest = {}
if chat_configuration_arn is not None:
input_["chat_configuration_arn"] = chat_configuration_arn
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|