create_application¶

create_application(**kwargs)¶

Creates an Amazon Web Services Migration Hub Refactor Spaces application. The account that owns the environment also owns the applications created inside the environment, regardless of the account that creates the application. Refactor Spaces provisions an Amazon API Gateway, API Gateway VPC link, and Network Load Balancer for the application proxy inside your account.

See also: AWS API Documentation

Request Syntax

response = client.create_application(
    ApiGatewayProxy={
        'EndpointType': 'REGIONAL'|'PRIVATE',
        'StageName': 'string'
    },
    ClientToken='string',
    EnvironmentIdentifier='string',
    Name='string',
    ProxyType='API_GATEWAY',
    Tags={
        'string': 'string'
    },
    VpcId='string'
)

Parameters

ApiGatewayProxy (dict) --
A wrapper object holding the API Gateway endpoint type and stage name for the proxy.
- EndpointType (string) --
  The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.
  
  If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) endpoints for Amazon API Gateway that have been granted access.
- StageName (string) --
  The name of the API Gateway stage. The name defaults to prod .
ClientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.
EnvironmentIdentifier (string) --
[REQUIRED]

The unique identifier of the environment.
Name (string) --
[REQUIRED]

The name to use for the application.
ProxyType (string) --
[REQUIRED]

The proxy type of the proxy created within the application.
Tags (dict) --
The tags to assign to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
- (string) --
  - (string) --
VpcId (string) --
[REQUIRED]

The ID of the virtual private cloud (VPC).

Return type

dict

Returns

Response Syntax

{
    'ApiGatewayProxy': {
        'EndpointType': 'REGIONAL'|'PRIVATE',
        'StageName': 'string'
    },
    'ApplicationId': 'string',
    'Arn': 'string',
    'CreatedByAccountId': 'string',
    'CreatedTime': datetime(2015, 1, 1),
    'EnvironmentId': 'string',
    'LastUpdatedTime': datetime(2015, 1, 1),
    'Name': 'string',
    'OwnerAccountId': 'string',
    'ProxyType': 'API_GATEWAY',
    'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING',
    'Tags': {
        'string': 'string'
    },
    'VpcId': 'string'
}

Response Structure

(dict) --
- ApiGatewayProxy (dict) --
  
  A wrapper object holding the API Gateway endpoint type and stage name for the proxy.
  - EndpointType (string) --
    
    The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to REGIONAL by default.
    
    If the value is set to PRIVATE in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) endpoints for Amazon API Gateway that have been granted access.
  - StageName (string) --
    
    The name of the API Gateway stage. The name defaults to prod .
- ApplicationId (string) --
  
  The unique identifier of the application.
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the application. The format for this ARN is arn:aws:refactor-spaces:region:account-id:resource-type/resource-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .
- CreatedByAccountId (string) --
  
  The Amazon Web Services account ID of application creator.
- CreatedTime (datetime) --
  
  A timestamp that indicates when the application is created.
- EnvironmentId (string) --
  
  The ID of the environment in which the application is created.
- LastUpdatedTime (datetime) --
  
  A timestamp that indicates when the application was last updated.
- Name (string) --
  
  The name of the application.
- OwnerAccountId (string) --
  
  The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).
- ProxyType (string) --
  
  The proxy type of the proxy created within the application.
- State (string) --
  
  The current state of the application.
- Tags (dict) --
  
  The tags assigned to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
  - (string) --
    - (string) --
- VpcId (string) --
  
  The ID of the Amazon VPC.

Exceptions

MigrationHubRefactorSpaces.Client.exceptions.ResourceNotFoundException
MigrationHubRefactorSpaces.Client.exceptions.InternalServerException
MigrationHubRefactorSpaces.Client.exceptions.ConflictException
MigrationHubRefactorSpaces.Client.exceptions.ServiceQuotaExceededException
MigrationHubRefactorSpaces.Client.exceptions.ValidationException
MigrationHubRefactorSpaces.Client.exceptions.ThrottlingException
MigrationHubRefactorSpaces.Client.exceptions.AccessDeniedException

Table Of Contents

create_application¶