Skip to content

list_graphql_apis async

list_graphql_apis(
    *,
    config_overrides: Optional[AsyncAppSyncClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxResults] = None,
    api_type: Optional[GraphQLApiType] = None,
    owner: Optional[Ownership] = None,
) -> ListGraphqlApisResponse

Lists your GraphQL APIs.

Parameters:

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

    An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

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

    The maximum number of results that you want the request to return.

  • api_type (Optional[GraphQLApiType], default: None ) –

    The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

  • owner (Optional[Ownership], default: None ) –

    The account owner of the GraphQL API.

Raises:

  • BadRequestException –

    The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

  • InternalFailureException –

    An internal AppSync error occurred. Try your request again.

  • UnauthorizedException –

    You aren't authorized to perform this operation.

  • UnknownServiceError –

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

Source code in docs_src/capo_appsync/_services/async_app_sync.py
async def list_graphql_apis(
    self,
    *,
    config_overrides: Optional[AsyncAppSyncClientConfig] = None,
    next_token: Optional[
        "capo_appsync.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional["capo_appsync.types.max_results.MaxResults"] = None,
    api_type: Optional[
        "capo_appsync.types.graph_ql_api_type.GraphQLApiType"
    ] = None,
    owner: Optional["capo_appsync.types.ownership.Ownership"] = None,
) -> "capo_appsync.types.list_graphql_apis_response.ListGraphqlApisResponse":
    """<p>Lists your GraphQL APIs.</p>

    Args:
        next_token: <p>An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.</p>
        max_results: <p>The maximum number of results that you want the request to return.</p>
        api_type: <p>The value that indicates whether the GraphQL API is a standard API (<code>GRAPHQL</code>) or merged API (<code>MERGED</code>).</p>
        owner: <p>The account owner of the GraphQL API.</p>

    Raises:
        capo_appsync.errors.bad_request_exception.BadRequestException: <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.</p>
        capo_appsync.errors.internal_failure_exception.InternalFailureException: <p>An internal AppSync error occurred. Try your request again.</p>
        capo_appsync.errors.unauthorized_exception.UnauthorizedException: <p>You aren't authorized to perform this operation.</p>
        capo_appsync.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_appsync.types.list_graphql_apis_request.ListGraphqlApisRequest]",
    ) -> AsyncOperationResponse[
        "capo_appsync.types.list_graphql_apis_response.ListGraphqlApisResponse"
    ]:
        import capo_appsync._operations.aws_deepdish_control_plane_service.list_graphql_apis

        (
            output,
            http_response,
        ) = await capo_appsync._operations.aws_deepdish_control_plane_service.list_graphql_apis.async_list_graphql_apis(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListGraphqlApis")
    )
    input_: capo_appsync.types.list_graphql_apis_request.ListGraphqlApisRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if api_type is not None:
        input_["api_type"] = api_type
    if owner is not None:
        input_["owner"] = owner

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