create_api¶

ApiGatewayV2.Client.create_api(**kwargs)¶

Creates an Api resource.

Request Syntax

response = client.create_api(
    ApiKeySelectionExpression='string',
    CorsConfiguration={
        'AllowCredentials': True|False,
        'AllowHeaders': [
            'string',
        ],
        'AllowMethods': [
            'string',
        ],
        'AllowOrigins': [
            'string',
        ],
        'ExposeHeaders': [
            'string',
        ],
        'MaxAge': 123
    },
    CredentialsArn='string',
    Description='string',
    DisableSchemaValidation=True|False,
    DisableExecuteApiEndpoint=True|False,
    Name='string',
    ProtocolType='WEBSOCKET'|'HTTP',
    RouteKey='string',
    RouteSelectionExpression='string',
    Tags={
        'string': 'string'
    },
    Target='string',
    Version='string'
)

Parameters

ApiKeySelectionExpression (string) -- An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
CorsConfiguration (dict) --
A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
- AllowCredentials (boolean) --
  Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
- AllowHeaders (list) --
  Represents a collection of allowed headers. Supported only for HTTP APIs.
  - (string) --
- AllowMethods (list) --
  Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
  - (string) --
    A string with a length between [1-64].
- AllowOrigins (list) --
  Represents a collection of allowed origins. Supported only for HTTP APIs.
  - (string) --
- ExposeHeaders (list) --
  Represents a collection of exposed headers. Supported only for HTTP APIs.
  - (string) --
- MaxAge (integer) --
  The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
CredentialsArn (string) -- This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
Description (string) -- The description of the API.
DisableSchemaValidation (boolean) -- Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
DisableExecuteApiEndpoint (boolean) -- Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
Name (string) --
[REQUIRED]

The name of the API.
ProtocolType (string) --
[REQUIRED]

The API protocol.
RouteKey (string) -- This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
RouteSelectionExpression (string) -- The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
Tags (dict) --
The collection of tags. Each tag element is associated with a given resource.
- (string) --
  - (string) --
    A string with a length between [0-1600].
Target (string) -- This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
Version (string) -- A version identifier for the API.

Return type

dict

Returns

Response Syntax

{
    'ApiEndpoint': 'string',
    'ApiGatewayManaged': True|False,
    'ApiId': 'string',
    'ApiKeySelectionExpression': 'string',
    'CorsConfiguration': {
        'AllowCredentials': True|False,
        'AllowHeaders': [
            'string',
        ],
        'AllowMethods': [
            'string',
        ],
        'AllowOrigins': [
            'string',
        ],
        'ExposeHeaders': [
            'string',
        ],
        'MaxAge': 123
    },
    'CreatedDate': datetime(2015, 1, 1),
    'Description': 'string',
    'DisableSchemaValidation': True|False,
    'DisableExecuteApiEndpoint': True|False,
    'ImportInfo': [
        'string',
    ],
    'Name': 'string',
    'ProtocolType': 'WEBSOCKET'|'HTTP',
    'RouteSelectionExpression': 'string',
    'Tags': {
        'string': 'string'
    },
    'Version': 'string',
    'Warnings': [
        'string',
    ]
}

Response Structure

(dict) --

The request has succeeded and has resulted in the creation of a resource.
- ApiEndpoint (string) --
  
  The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
- ApiGatewayManaged (boolean) --
  
  Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
- ApiId (string) --
  
  The API ID.
- ApiKeySelectionExpression (string) --
  
  An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
- CorsConfiguration (dict) --
  
  A CORS configuration. Supported only for HTTP APIs.
  - AllowCredentials (boolean) --
    
    Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
  - AllowHeaders (list) --
    
    Represents a collection of allowed headers. Supported only for HTTP APIs.
    - (string) --
  - AllowMethods (list) --
    
    Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
    - (string) --
      
      A string with a length between [1-64].
  - AllowOrigins (list) --
    
    Represents a collection of allowed origins. Supported only for HTTP APIs.
    - (string) --
  - ExposeHeaders (list) --
    
    Represents a collection of exposed headers. Supported only for HTTP APIs.
    - (string) --
  - MaxAge (integer) --
    
    The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
- CreatedDate (datetime) --
  
  The timestamp when the API was created.
- Description (string) --
  
  The description of the API.
- DisableSchemaValidation (boolean) --
  
  Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
- DisableExecuteApiEndpoint (boolean) --
  
  Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
- ImportInfo (list) --
  
  The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
  - (string) --
- Name (string) --
  
  The name of the API.
- ProtocolType (string) --
  
  The API protocol.
- RouteSelectionExpression (string) --
  
  The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
- Tags (dict) --
  
  A collection of tags associated with the API.
  - (string) --
    - (string) --
      
      A string with a length between [0-1600].
- Version (string) --
  
  A version identifier for the API.
- Warnings (list) --
  
  The warning messages reported when failonwarnings is turned on during API import.
  - (string) --

Exceptions

ApiGatewayV2.Client.exceptions.NotFoundException
ApiGatewayV2.Client.exceptions.TooManyRequestsException
ApiGatewayV2.Client.exceptions.BadRequestException
ApiGatewayV2.Client.exceptions.ConflictException

Table Of Contents

create_api¶