Skip to content

describe_chime_webhook_configurations

describe_chime_webhook_configurations(
    *,
    config_overrides: Optional[chatbotClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[PaginationToken] = None,
    chat_configuration_arn: Optional[ChatConfigurationArn] = None,
) -> DescribeChimeWebhookConfigurationsResult

Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn

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.

  • chat_configuration_arn (Optional[ChatConfigurationArn], default: None ) –

    An optional Amazon Resource Name (ARN) of a ChimeWebhookConfiguration to describe.

Raises:

Source code in docs_src/capo_chatbot/_services/chatbot.py
def describe_chime_webhook_configurations(
    self,
    *,
    config_overrides: Optional[chatbotClientConfig] = None,
    max_results: Optional["capo_chatbot.types.max_results.MaxResults"] = None,
    next_token: Optional[
        "capo_chatbot.types.pagination_token.PaginationToken"
    ] = None,
    chat_configuration_arn: Optional[
        "capo_chatbot.types.chat_configuration_arn.ChatConfigurationArn"
    ] = None,
) -> "capo_chatbot.types.describe_chime_webhook_configurations_result.DescribeChimeWebhookConfigurationsResult":
    """<p>Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn</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>
        chat_configuration_arn: <p>An optional Amazon Resource Name (ARN) of a ChimeWebhookConfiguration to describe.</p>

    Raises:
        capo_chatbot.errors.describe_chime_webhook_configurations_exception.DescribeChimeWebhookConfigurationsException: <p>We can’t process your request right now because of a server issue. Try again later.</p>
        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.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_chatbot.types.describe_chime_webhook_configurations_request.DescribeChimeWebhookConfigurationsRequest]",
    ) -> OperationResponse[
        "capo_chatbot.types.describe_chime_webhook_configurations_result.DescribeChimeWebhookConfigurationsResult"
    ]:
        import capo_chatbot._operations.wheatley_orchestration_20171011.describe_chime_webhook_configurations

        output, http_response = (
            capo_chatbot._operations.wheatley_orchestration_20171011.describe_chime_webhook_configurations.describe_chime_webhook_configurations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

        return capo_chatbot.types.describe_chime_webhook_configurations_result.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "DescribeChimeWebhookConfigurations", redact_output=_redact_output
        ),
    )
    input_: capo_chatbot.types.describe_chime_webhook_configurations_request.DescribeChimeWebhookConfigurationsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if chat_configuration_arn is not None:
        input_["chat_configuration_arn"] = chat_configuration_arn

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output