describe_connection_aliases ¶

def describe_connection_aliases(
    self,
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
    alias_ids: Optional[
        "capo_workspaces.types.connection_alias_id_list.ConnectionAliasIdList"
    ] = None,
    resource_id: Optional[
        "capo_workspaces.types.non_empty_string.NonEmptyString"
    ] = None,
    limit: Optional["capo_workspaces.types.limit.Limit"] = None,
    next_token: Optional[
        "capo_workspaces.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_workspaces.types.describe_connection_aliases_result.DescribeConnectionAliasesResult":
    """<p>Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html"> Cross-Region Redirection for Amazon WorkSpaces</a>.</p>

    Args:
        alias_ids: <p>The identifiers of the connection aliases to describe.</p>
        resource_id: <p>The identifier of the directory associated with the connection alias.</p>
        limit: <p>The maximum number of connection aliases to return.</p>
        next_token: <p>If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results. </p>

    Raises:
        capo_workspaces.errors.access_denied_exception.AccessDeniedException: <p>The user is not authorized to access a resource.</p>
        capo_workspaces.errors.invalid_parameter_values_exception.InvalidParameterValuesException: <p>One or more parameter values are not valid.</p>
        capo_workspaces.errors.operation_not_supported_exception.OperationNotSupportedException: <p>This operation is not supported.</p>
        capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces.types.describe_connection_aliases_request.DescribeConnectionAliasesRequest]",
    ) -> OperationResponse[
        "capo_workspaces.types.describe_connection_aliases_result.DescribeConnectionAliasesResult"
    ]:
        import capo_workspaces._operations.workspaces_service.describe_connection_aliases

        output, http_response = (
            capo_workspaces._operations.workspaces_service.describe_connection_aliases.describe_connection_aliases(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeConnectionAliases")
    )
    input_: capo_workspaces.types.describe_connection_aliases_request.DescribeConnectionAliasesRequest = {}
    if alias_ids is not None:
        input_["alias_ids"] = alias_ids
    if resource_id is not None:
        input_["resource_id"] = resource_id
    if limit is not None:
        input_["limit"] = limit
    if next_token is not None:
        input_["next_token"] = next_token

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