AWS API Changes

2023/02/09 - AWS Migration Hub Refactor Spaces - 3 updated api methods

Changes This release adds support for creating environments with a network fabric type of NONE

CreateEnvironment (updated)

Link ¶
Changes (both)

{'NetworkFabricType': {'NONE'}}

Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns the environment resource, and all Refactor Spaces applications, services, and routes created within the environment. They are referred to as the environment owner . The environment owner has cross-account visibility and control of Refactor Spaces resources that are added to the environment by other accounts that the environment is shared with.

When creating an environment with a network fabric type of TRANSIT_GATEWAY , Refactor Spaces provisions a transit gateway in your account.

See also: AWS API Documentation

Request Syntax

client.create_environment(
    ClientToken='string',
    Description='string',
    Name='string',
    NetworkFabricType='TRANSIT_GATEWAY'|'NONE',
    Tags={
        'string': 'string'
    }
)

type ClientToken

string

param ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

type Description

string

param Description

The description of the environment.

type Name

string

param Name

[REQUIRED]

The name of the environment.

type NetworkFabricType

string

param NetworkFabricType

[REQUIRED]

The network fabric type of the environment.

type Tags

dict

param Tags

The tags to assign to the environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'CreatedTime': datetime(2015, 1, 1),
    'Description': 'string',
    'EnvironmentId': 'string',
    'LastUpdatedTime': datetime(2015, 1, 1),
    'Name': 'string',
    'NetworkFabricType': 'TRANSIT_GATEWAY'|'NONE',
    'OwnerAccountId': 'string',
    'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the environment.
- CreatedTime (datetime) --
  
  A timestamp that indicates when the environment is created.
- Description (string) --
  
  A description of the environment.
- EnvironmentId (string) --
  
  The unique identifier of the environment.
- LastUpdatedTime (datetime) --
  
  A timestamp that indicates when the environment was last updated.
- Name (string) --
  
  The name of the environment.
- NetworkFabricType (string) --
  
  The network fabric type of the environment.
- OwnerAccountId (string) --
  
  The Amazon Web Services account ID of environment owner.
- State (string) --
  
  The current state of the environment.
- Tags (dict) --
  
  The tags assigned to the created environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair..
  - (string) --
    - (string) --

GetEnvironment (updated)

Link ¶
Changes (response)

{'NetworkFabricType': {'NONE'}}

Gets an Amazon Web Services Migration Hub Refactor Spaces environment.

See also: AWS API Documentation

Request Syntax

client.get_environment(
    EnvironmentIdentifier='string'
)

type EnvironmentIdentifier

string

param EnvironmentIdentifier

[REQUIRED]

The ID of the environment.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'CreatedTime': datetime(2015, 1, 1),
    'Description': 'string',
    'EnvironmentId': 'string',
    'Error': {
        'AccountId': 'string',
        'AdditionalDetails': {
            'string': 'string'
        },
        'Code': 'INVALID_RESOURCE_STATE'|'RESOURCE_LIMIT_EXCEEDED'|'RESOURCE_CREATION_FAILURE'|'RESOURCE_UPDATE_FAILURE'|'SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE'|'RESOURCE_DELETION_FAILURE'|'RESOURCE_RETRIEVAL_FAILURE'|'RESOURCE_IN_USE'|'RESOURCE_NOT_FOUND'|'STATE_TRANSITION_FAILURE'|'REQUEST_LIMIT_EXCEEDED'|'NOT_AUTHORIZED',
        'Message': 'string',
        'ResourceIdentifier': 'string',
        'ResourceType': 'ENVIRONMENT'|'APPLICATION'|'ROUTE'|'SERVICE'|'TRANSIT_GATEWAY'|'TRANSIT_GATEWAY_ATTACHMENT'|'API_GATEWAY'|'NLB'|'TARGET_GROUP'|'LOAD_BALANCER_LISTENER'|'VPC_LINK'|'LAMBDA'|'VPC'|'SUBNET'|'ROUTE_TABLE'|'SECURITY_GROUP'|'VPC_ENDPOINT_SERVICE_CONFIGURATION'|'RESOURCE_SHARE'|'IAM_ROLE'
    },
    'LastUpdatedTime': datetime(2015, 1, 1),
    'Name': 'string',
    'NetworkFabricType': 'TRANSIT_GATEWAY'|'NONE',
    'OwnerAccountId': 'string',
    'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
    'Tags': {
        'string': 'string'
    },
    'TransitGatewayId': 'string'
}

Response Structure

(dict) --
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the environment.
- CreatedTime (datetime) --
  
  A timestamp that indicates when the environment is created.
- Description (string) --
  
  The description of the environment.
- EnvironmentId (string) --
  
  The unique identifier of the environment.
- Error (dict) --
  
  Any error associated with the environment resource.
  - AccountId (string) --
    
    The Amazon Web Services account ID of the resource owner.
  - AdditionalDetails (dict) --
    
    Additional details about the error.
    - (string) --
      - (string) --
  - Code (string) --
    
    The error code associated with the error.
  - Message (string) --
    
    The message associated with the error.
  - ResourceIdentifier (string) --
    
    The ID of the resource.
  - ResourceType (string) --
    
    The type of resource.
- LastUpdatedTime (datetime) --
  
  A timestamp that indicates when the environment was last updated.
- Name (string) --
  
  The name of the environment.
- NetworkFabricType (string) --
  
  The network fabric type of the environment.
- OwnerAccountId (string) --
  
  The Amazon Web Services account ID of the environment owner.
- State (string) --
  
  The current state of the environment.
- Tags (dict) --
  
  The tags to assign to the environment. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
  - (string) --
    - (string) --
- TransitGatewayId (string) --
  
  The ID of the transit gateway set up by the environment.

ListEnvironments (updated)

Link ¶
Changes (response)

{'EnvironmentSummaryList': {'NetworkFabricType': {'NONE'}}}

Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.

See also: AWS API Documentation

Request Syntax

client.list_environments(
    MaxResults=123,
    NextToken='string'
)

type MaxResults

integer

param MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken

string

param NextToken

The token for the next page of results.

rtype

dict

returns

Response Syntax

{
    'EnvironmentSummaryList': [
        {
            'Arn': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'Description': 'string',
            'EnvironmentId': 'string',
            'Error': {
                'AccountId': 'string',
                'AdditionalDetails': {
                    'string': 'string'
                },
                'Code': 'INVALID_RESOURCE_STATE'|'RESOURCE_LIMIT_EXCEEDED'|'RESOURCE_CREATION_FAILURE'|'RESOURCE_UPDATE_FAILURE'|'SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE'|'RESOURCE_DELETION_FAILURE'|'RESOURCE_RETRIEVAL_FAILURE'|'RESOURCE_IN_USE'|'RESOURCE_NOT_FOUND'|'STATE_TRANSITION_FAILURE'|'REQUEST_LIMIT_EXCEEDED'|'NOT_AUTHORIZED',
                'Message': 'string',
                'ResourceIdentifier': 'string',
                'ResourceType': 'ENVIRONMENT'|'APPLICATION'|'ROUTE'|'SERVICE'|'TRANSIT_GATEWAY'|'TRANSIT_GATEWAY_ATTACHMENT'|'API_GATEWAY'|'NLB'|'TARGET_GROUP'|'LOAD_BALANCER_LISTENER'|'VPC_LINK'|'LAMBDA'|'VPC'|'SUBNET'|'ROUTE_TABLE'|'SECURITY_GROUP'|'VPC_ENDPOINT_SERVICE_CONFIGURATION'|'RESOURCE_SHARE'|'IAM_ROLE'
            },
            'LastUpdatedTime': datetime(2015, 1, 1),
            'Name': 'string',
            'NetworkFabricType': 'TRANSIT_GATEWAY'|'NONE',
            'OwnerAccountId': 'string',
            'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
            'Tags': {
                'string': 'string'
            },
            'TransitGatewayId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- EnvironmentSummaryList (list) --
  
  The list of EnvironmentSummary objects.
  - (dict) --
    
    The summary information for environments as a response to ListEnvironments .
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the environment.
    - CreatedTime (datetime) --
      
      A timestamp that indicates when the environment is created.
    - Description (string) --
      
      A description of the environment.
    - EnvironmentId (string) --
      
      The unique identifier of the environment.
    - Error (dict) --
      
      Any error associated with the environment resource.
      - AccountId (string) --
        
        The Amazon Web Services account ID of the resource owner.
      - AdditionalDetails (dict) --
        
        Additional details about the error.
        
        (string) --
        
        (string) --
      - Code (string) --
        
        The error code associated with the error.
      - Message (string) --
        
        The message associated with the error.
      - ResourceIdentifier (string) --
        
        The ID of the resource.
      - ResourceType (string) --
        
        The type of resource.
    - LastUpdatedTime (datetime) --
      
      A timestamp that indicates when the environment was last updated.
    - Name (string) --
      
      The name of the environment.
    - NetworkFabricType (string) --
      
      The network fabric type of the environment.
    - OwnerAccountId (string) --
      
      The Amazon Web Services account ID of the environment owner.
    - State (string) --
      
      The current state of the environment.
    - Tags (dict) --
      
      The tags assigned to the environment.
      - (string) --
        
        (string) --
    - TransitGatewayId (string) --
      
      The ID of the transit gateway set up by the environment.
- NextToken (string) --
  
  The token for the next page of results.