describe_endpoint_access `async` ¶

describe_endpoint_access(
    *,
    config_overrides: Optional[AsyncRedshiftClientConfig] = None,
    cluster_identifier: Optional[String] = None,
    resource_owner: Optional[String] = None,
    endpoint_name: Optional[String] = None,
    vpc_id: Optional[String] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> EndpointAccessList

Describes a Redshift-managed VPC endpoint.

Parameters:

cluster_identifier (Optional[String], default: None ) –

The cluster identifier associated with the described endpoint.
resource_owner (Optional[String], default: None ) –

The Amazon Web Services account ID of the owner of the cluster.
endpoint_name (Optional[String], default: None ) –

The name of the endpoint to be described.
vpc_id (Optional[String], default: None ) –

The virtual private cloud (VPC) identifier with access to the cluster.
max_records (Optional[IntegerOptional], default: None ) –

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a Marker is included in the response so that the remaining results can be retrieved.
marker (Optional[String], default: None ) –

An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Raises:

ClusterNotFoundFault –

The ClusterIdentifier parameter does not refer to an existing cluster.
EndpointNotFoundFault –

The endpoint name doesn't refer to an existing endpoint.
InvalidClusterStateFault –

The specified cluster is not in the available state.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_redshift/_services/async_redshift.py

async def describe_endpoint_access(
    self,
    *,
    config_overrides: Optional[AsyncRedshiftClientConfig] = None,
    cluster_identifier: Optional["capo_redshift.types.string.String"] = None,
    resource_owner: Optional["capo_redshift.types.string.String"] = None,
    endpoint_name: Optional["capo_redshift.types.string.String"] = None,
    vpc_id: Optional["capo_redshift.types.string.String"] = None,
    max_records: Optional[
        "capo_redshift.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_redshift.types.string.String"] = None,
) -> "capo_redshift.types.endpoint_access_list.EndpointAccessList":
    """<p>Describes a Redshift-managed VPC endpoint.</p>

    Args:
        cluster_identifier: <p>The cluster identifier associated with the described endpoint.</p>
        resource_owner: <p>The Amazon Web Services account ID of the owner of the cluster.</p>
        endpoint_name: <p>The name of the endpoint to be described.</p>
        vpc_id: <p>The virtual private cloud (VPC) identifier with access to the cluster.</p>
        max_records: <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a <code>Marker</code> is included in the response so that the remaining results can be retrieved.</p>
        marker: <p>An optional pagination token provided by a previous <code>DescribeEndpointAccess</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the <code>MaxRecords</code> parameter.</p>

    Raises:
        capo_redshift.errors.cluster_not_found_fault.ClusterNotFoundFault: <p>The <code>ClusterIdentifier</code> parameter does not refer to an existing cluster. </p>
        capo_redshift.errors.endpoint_not_found_fault.EndpointNotFoundFault: <p>The endpoint name doesn't refer to an existing endpoint.</p>
        capo_redshift.errors.invalid_cluster_state_fault.InvalidClusterStateFault: <p>The specified cluster is not in the <code>available</code> state. </p>
        capo_redshift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_redshift.types.describe_endpoint_access_message.DescribeEndpointAccessMessage]",
    ) -> AsyncOperationResponse[
        "capo_redshift.types.endpoint_access_list.EndpointAccessList"
    ]:
        import capo_redshift._operations.redshift_service_version20121201.describe_endpoint_access

        (
            output,
            http_response,
        ) = await capo_redshift._operations.redshift_service_version20121201.describe_endpoint_access.async_describe_endpoint_access(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEndpointAccess")
    )
    input_: capo_redshift.types.describe_endpoint_access_message.DescribeEndpointAccessMessage = {}
    if cluster_identifier is not None:
        input_["cluster_identifier"] = cluster_identifier
    if resource_owner is not None:
        input_["resource_owner"] = resource_owner
    if endpoint_name is not None:
        input_["endpoint_name"] = endpoint_name
    if vpc_id is not None:
        input_["vpc_id"] = vpc_id
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

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

describe_endpoint_access async ¶

describe_endpoint_access `async` ¶