list_endpoint_access ¶

def list_endpoint_access(
    self,
    *,
    config_overrides: Optional[RedshiftServerlessClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
    workgroup_name: Optional[str] = None,
    vpc_id: Optional[str] = None,
    owner_account: Optional[
        "capo_redshift_serverless.types.owner_account.OwnerAccount"
    ] = None,
) -> "capo_redshift_serverless.types.list_endpoint_access_response.ListEndpointAccessResponse":
    """<p>Returns an array of <code>EndpointAccess</code> objects and relevant information.</p>

    Args:
        next_token: <p>If your initial <code>ListEndpointAccess</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in following <code>ListEndpointAccess</code> operations, which returns results in the next page.</p>
        max_results: <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to display the next page of results.</p>
        workgroup_name: <p>The name of the workgroup associated with the VPC endpoint to return.</p>
        vpc_id: <p>The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.</p>
        owner_account: <p>The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.</p>

    Raises:
        capo_redshift_serverless.errors.conflict_exception.ConflictException: <p>The submitted action has conflicts.</p>
        capo_redshift_serverless.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_redshift_serverless.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_redshift_serverless.errors.validation_exception.ValidationException: <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_redshift_serverless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_redshift_serverless.types.list_endpoint_access_request.ListEndpointAccessRequest]",
    ) -> OperationResponse[
        "capo_redshift_serverless.types.list_endpoint_access_response.ListEndpointAccessResponse"
    ]:
        import capo_redshift_serverless._operations.redshift_serverless.list_endpoint_access

        output, http_response = (
            capo_redshift_serverless._operations.redshift_serverless.list_endpoint_access.list_endpoint_access(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEndpointAccess")
    )
    input_: capo_redshift_serverless.types.list_endpoint_access_request.ListEndpointAccessRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if workgroup_name is not None:
        input_["workgroup_name"] = workgroup_name
    if vpc_id is not None:
        input_["vpc_id"] = vpc_id
    if owner_account is not None:
        input_["owner_account"] = owner_account

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