list_types `async` ¶

list_types(
    api_id: String,
    format: TypeDefinitionFormat,
    *,
    config_overrides: Optional[AsyncAppSyncClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListTypesResponse

Lists the types for a given API.

Parameters:

api_id (String) –

The API ID.
format (TypeDefinitionFormat) –

The type format: SDL or JSON.
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.

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.
ConcurrentModificationException –

Another modification is in progress at this time and it must complete before you can make your change.
InternalFailureException –

An internal AppSync error occurred. Try your request again.
NotFoundException –

The resource specified in the request was not found. Check the resource, and then try 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_types(
    self,
    api_id: "capo_appsync.types.string.String",
    format: "capo_appsync.types.type_definition_format.TypeDefinitionFormat",
    *,
    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,
) -> "capo_appsync.types.list_types_response.ListTypesResponse":
    """<p>Lists the types for a given API.</p>

    Args:
        api_id: <p>The API ID.</p>
        format: <p>The type format: SDL or JSON.</p>
        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>

    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.concurrent_modification_exception.ConcurrentModificationException: <p>Another modification is in progress at this time and it must complete before you can make your change.</p>
        capo_appsync.errors.internal_failure_exception.InternalFailureException: <p>An internal AppSync error occurred. Try your request again.</p>
        capo_appsync.errors.not_found_exception.NotFoundException: <p>The resource specified in the request was not found. Check the resource, and then try 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_types_request.ListTypesRequest]",
    ) -> AsyncOperationResponse[
        "capo_appsync.types.list_types_response.ListTypesResponse"
    ]:
        import capo_appsync._operations.aws_deepdish_control_plane_service.list_types

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTypes")
    )
    input_: capo_appsync.types.list_types_request.ListTypesRequest = {
        "api_id": api_id,
        "format": format,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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

list_types async ¶

list_types `async` ¶