MigrationHubRefactorSpaces / Client / update_route

update_route#

MigrationHubRefactorSpaces.Client.update_route(**kwargs)#

Updates an Amazon Web Services Migration Hub Refactor Spaces route.

See also: AWS API Documentation

Request Syntax

response = client.update_route(
    ActivationState='ACTIVE'|'INACTIVE',
    ApplicationIdentifier='string',
    EnvironmentIdentifier='string',
    RouteIdentifier='string'
)
Parameters:

  • ActivationState (string) –

    [REQUIRED]

    If set to ACTIVE, traffic is forwarded to this route’s service after the route is updated.

  • ApplicationIdentifier (string) –

    [REQUIRED]

    The ID of the application within which the route is being updated.

  • EnvironmentIdentifier (string) –

    [REQUIRED]

    The ID of the environment in which the route is being updated.

  • RouteIdentifier (string) –

    [REQUIRED]

    The unique identifier of the route to update.

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationId': 'string',
    'Arn': 'string',
    'LastUpdatedTime': datetime(2015, 1, 1),
    'RouteId': 'string',
    'ServiceId': 'string',
    'State': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'|'INACTIVE'
}

Response Structure

  • (dict) –

    • ApplicationId (string) –

      The ID of the application in which the route is being updated.

    • Arn (string) –

      The Amazon Resource Name (ARN) of the route. 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.

    • LastUpdatedTime (datetime) –

      A timestamp that indicates when the route was last updated.

    • RouteId (string) –

      The unique identifier of the route.

    • ServiceId (string) –

      The ID of service in which the route was created. Traffic that matches this route is forwarded to this service.

    • State (string) –

      The current state of the route.

Exceptions

  • MigrationHubRefactorSpaces.Client.exceptions.ResourceNotFoundException

  • MigrationHubRefactorSpaces.Client.exceptions.InternalServerException

  • MigrationHubRefactorSpaces.Client.exceptions.ValidationException

  • MigrationHubRefactorSpaces.Client.exceptions.ThrottlingException

  • MigrationHubRefactorSpaces.Client.exceptions.AccessDeniedException