Skip to content

describe_ac_ls

describe_ac_ls(
    *,
    config_overrides: Optional[MemoryDBClientConfig] = None,
    acl_name: Optional[String] = None,
    max_results: Optional[IntegerOptional] = None,
    next_token: Optional[String] = None,
) -> DescribeACLsResponse

Returns a list of ACLs.

Parameters:

  • acl_name (Optional[String], default: None ) –

    The name of the ACL.

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

    The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

  • next_token (Optional[String], default: None ) –

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Raises:

Source code in docs_src/capo_memorydb/_services/memory_db.py
def describe_ac_ls(
    self,
    *,
    config_overrides: Optional[MemoryDBClientConfig] = None,
    acl_name: Optional["capo_memorydb.types.string.String"] = None,
    max_results: Optional[
        "capo_memorydb.types.integer_optional.IntegerOptional"
    ] = None,
    next_token: Optional["capo_memorydb.types.string.String"] = None,
) -> "capo_memorydb.types.describe_ac_ls_response.DescribeACLsResponse":
    """<p>Returns a list of ACLs.</p>

    Args:
        acl_name: <p>The name of the ACL.</p>
        max_results: <p>The maximum number of records to include in the response. If more records 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 argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. </p>

    Raises:
        capo_memorydb.errors.acl_not_found_fault.ACLNotFoundFault: <p>The specified ACL does not exist.</p>
        capo_memorydb.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>The specified parameter combination is not valid.</p>
        capo_memorydb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_memorydb.types.describe_ac_ls_request.DescribeACLsRequest]",
    ) -> OperationResponse[
        "capo_memorydb.types.describe_ac_ls_response.DescribeACLsResponse"
    ]:
        import capo_memorydb._operations.amazon_memory_db.describe_ac_ls

        output, http_response = (
            capo_memorydb._operations.amazon_memory_db.describe_ac_ls.describe_ac_ls(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeACLs")
    )
    input_: capo_memorydb.types.describe_ac_ls_request.DescribeACLsRequest = {}
    if acl_name is not None:
        input_["acl_name"] = acl_name
    if max_results is not None:
        input_["max_results"] = max_results
    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