Skip to content

Type definitions#

Index > MigrationHubRefactorSpaces > Type definitions

Auto-generated documentation for MigrationHubRefactorSpaces type annotations stubs module mypy-boto3-migration-hub-refactor-spaces.

ApiGatewayProxyConfigTypeDef#

# ApiGatewayProxyConfigTypeDef definition

class ApiGatewayProxyConfigTypeDef(TypedDict):
    ApiGatewayId: NotRequired[str],
    EndpointType: NotRequired[ApiGatewayEndpointTypeType],  # (1)
    NlbArn: NotRequired[str],
    NlbName: NotRequired[str],
    ProxyUrl: NotRequired[str],
    StageName: NotRequired[str],
    VpcLinkId: NotRequired[str],
  1. See ApiGatewayEndpointTypeType

ApiGatewayProxyInputTypeDef#

# ApiGatewayProxyInputTypeDef definition

class ApiGatewayProxyInputTypeDef(TypedDict):
    EndpointType: NotRequired[ApiGatewayEndpointTypeType],  # (1)
    StageName: NotRequired[str],
  1. See ApiGatewayEndpointTypeType

ApiGatewayProxySummaryTypeDef#

# ApiGatewayProxySummaryTypeDef definition

class ApiGatewayProxySummaryTypeDef(TypedDict):
    ApiGatewayId: NotRequired[str],
    EndpointType: NotRequired[ApiGatewayEndpointTypeType],  # (1)
    NlbArn: NotRequired[str],
    NlbName: NotRequired[str],
    ProxyUrl: NotRequired[str],
    StageName: NotRequired[str],
    VpcLinkId: NotRequired[str],
  1. See ApiGatewayEndpointTypeType

ErrorResponseTypeDef#

# ErrorResponseTypeDef definition

class ErrorResponseTypeDef(TypedDict):
    AccountId: NotRequired[str],
    AdditionalDetails: NotRequired[Dict[str, str]],
    Code: NotRequired[ErrorCodeType],  # (1)
    Message: NotRequired[str],
    ResourceIdentifier: NotRequired[str],
    ResourceType: NotRequired[ErrorResourceTypeType],  # (2)
  1. See ErrorCodeType
  2. See ErrorResourceTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CreateEnvironmentRequestRequestTypeDef#

# CreateEnvironmentRequestRequestTypeDef definition

class CreateEnvironmentRequestRequestTypeDef(TypedDict):
    Name: str,
    NetworkFabricType: NetworkFabricTypeType,  # (1)
    ClientToken: NotRequired[str],
    Description: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
  1. See NetworkFabricTypeType

DefaultRouteInputTypeDef#

# DefaultRouteInputTypeDef definition

class DefaultRouteInputTypeDef(TypedDict):
    ActivationState: NotRequired[RouteActivationStateType],  # (1)
  1. See RouteActivationStateType

UriPathRouteInputTypeDef#

# UriPathRouteInputTypeDef definition

class UriPathRouteInputTypeDef(TypedDict):
    ActivationState: RouteActivationStateType,  # (1)
    SourcePath: str,
    AppendSourcePath: NotRequired[bool],
    IncludeChildPaths: NotRequired[bool],
    Methods: NotRequired[Sequence[HttpMethodType]],  # (2)
  1. See RouteActivationStateType
  2. See HttpMethodType

LambdaEndpointInputTypeDef#

# LambdaEndpointInputTypeDef definition

class LambdaEndpointInputTypeDef(TypedDict):
    Arn: str,

UrlEndpointInputTypeDef#

# UrlEndpointInputTypeDef definition

class UrlEndpointInputTypeDef(TypedDict):
    Url: str,
    HealthUrl: NotRequired[str],

DeleteApplicationRequestRequestTypeDef#

# DeleteApplicationRequestRequestTypeDef definition

class DeleteApplicationRequestRequestTypeDef(TypedDict):
    ApplicationIdentifier: str,
    EnvironmentIdentifier: str,

DeleteEnvironmentRequestRequestTypeDef#

# DeleteEnvironmentRequestRequestTypeDef definition

class DeleteEnvironmentRequestRequestTypeDef(TypedDict):
    EnvironmentIdentifier: str,

DeleteResourcePolicyRequestRequestTypeDef#

# DeleteResourcePolicyRequestRequestTypeDef definition

class DeleteResourcePolicyRequestRequestTypeDef(TypedDict):
    Identifier: str,

DeleteRouteRequestRequestTypeDef#

# DeleteRouteRequestRequestTypeDef definition

class DeleteRouteRequestRequestTypeDef(TypedDict):
    ApplicationIdentifier: str,
    EnvironmentIdentifier: str,
    RouteIdentifier: str,

DeleteServiceRequestRequestTypeDef#

# DeleteServiceRequestRequestTypeDef definition

class DeleteServiceRequestRequestTypeDef(TypedDict):
    ApplicationIdentifier: str,
    EnvironmentIdentifier: str,
    ServiceIdentifier: str,

EnvironmentVpcTypeDef#

# EnvironmentVpcTypeDef definition

class EnvironmentVpcTypeDef(TypedDict):
    AccountId: NotRequired[str],
    CidrBlocks: NotRequired[List[str]],
    CreatedTime: NotRequired[datetime],
    EnvironmentId: NotRequired[str],
    LastUpdatedTime: NotRequired[datetime],
    VpcId: NotRequired[str],
    VpcName: NotRequired[str],

GetApplicationRequestRequestTypeDef#

# GetApplicationRequestRequestTypeDef definition

class GetApplicationRequestRequestTypeDef(TypedDict):
    ApplicationIdentifier: str,
    EnvironmentIdentifier: str,

GetEnvironmentRequestRequestTypeDef#

# GetEnvironmentRequestRequestTypeDef definition

class GetEnvironmentRequestRequestTypeDef(TypedDict):
    EnvironmentIdentifier: str,

GetResourcePolicyRequestRequestTypeDef#

# GetResourcePolicyRequestRequestTypeDef definition

class GetResourcePolicyRequestRequestTypeDef(TypedDict):
    Identifier: str,

GetRouteRequestRequestTypeDef#

# GetRouteRequestRequestTypeDef definition

class GetRouteRequestRequestTypeDef(TypedDict):
    ApplicationIdentifier: str,
    EnvironmentIdentifier: str,
    RouteIdentifier: str,

GetServiceRequestRequestTypeDef#

# GetServiceRequestRequestTypeDef definition

class GetServiceRequestRequestTypeDef(TypedDict):
    ApplicationIdentifier: str,
    EnvironmentIdentifier: str,
    ServiceIdentifier: str,

LambdaEndpointConfigTypeDef#

# LambdaEndpointConfigTypeDef definition

class LambdaEndpointConfigTypeDef(TypedDict):
    Arn: NotRequired[str],

UrlEndpointConfigTypeDef#

# UrlEndpointConfigTypeDef definition

class UrlEndpointConfigTypeDef(TypedDict):
    HealthUrl: NotRequired[str],
    Url: NotRequired[str],

LambdaEndpointSummaryTypeDef#

# LambdaEndpointSummaryTypeDef definition

class LambdaEndpointSummaryTypeDef(TypedDict):
    Arn: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListApplicationsRequestRequestTypeDef#

# ListApplicationsRequestRequestTypeDef definition

class ListApplicationsRequestRequestTypeDef(TypedDict):
    EnvironmentIdentifier: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListEnvironmentVpcsRequestRequestTypeDef#

# ListEnvironmentVpcsRequestRequestTypeDef definition

class ListEnvironmentVpcsRequestRequestTypeDef(TypedDict):
    EnvironmentIdentifier: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListEnvironmentsRequestRequestTypeDef#

# ListEnvironmentsRequestRequestTypeDef definition

class ListEnvironmentsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListRoutesRequestRequestTypeDef#

# ListRoutesRequestRequestTypeDef definition

class ListRoutesRequestRequestTypeDef(TypedDict):
    ApplicationIdentifier: str,
    EnvironmentIdentifier: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListServicesRequestRequestTypeDef#

# ListServicesRequestRequestTypeDef definition

class ListServicesRequestRequestTypeDef(TypedDict):
    ApplicationIdentifier: str,
    EnvironmentIdentifier: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

PutResourcePolicyRequestRequestTypeDef#

# PutResourcePolicyRequestRequestTypeDef definition

class PutResourcePolicyRequestRequestTypeDef(TypedDict):
    Policy: str,
    ResourceArn: str,

UrlEndpointSummaryTypeDef#

# UrlEndpointSummaryTypeDef definition

class UrlEndpointSummaryTypeDef(TypedDict):
    HealthUrl: NotRequired[str],
    Url: NotRequired[str],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateRouteRequestRequestTypeDef#

# UpdateRouteRequestRequestTypeDef definition

class UpdateRouteRequestRequestTypeDef(TypedDict):
    ActivationState: RouteActivationStateType,  # (1)
    ApplicationIdentifier: str,
    EnvironmentIdentifier: str,
    RouteIdentifier: str,
  1. See RouteActivationStateType

CreateApplicationRequestRequestTypeDef#

# CreateApplicationRequestRequestTypeDef definition

class CreateApplicationRequestRequestTypeDef(TypedDict):
    EnvironmentIdentifier: str,
    Name: str,
    ProxyType: ProxyTypeType,  # (1)
    VpcId: str,
    ApiGatewayProxy: NotRequired[ApiGatewayProxyInputTypeDef],  # (2)
    ClientToken: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
  1. See ProxyTypeType
  2. See ApiGatewayProxyInputTypeDef

ApplicationSummaryTypeDef#

# ApplicationSummaryTypeDef definition

class ApplicationSummaryTypeDef(TypedDict):
    ApiGatewayProxy: NotRequired[ApiGatewayProxySummaryTypeDef],  # (1)
    ApplicationId: NotRequired[str],
    Arn: NotRequired[str],
    CreatedByAccountId: NotRequired[str],
    CreatedTime: NotRequired[datetime],
    EnvironmentId: NotRequired[str],
    Error: NotRequired[ErrorResponseTypeDef],  # (2)
    LastUpdatedTime: NotRequired[datetime],
    Name: NotRequired[str],
    OwnerAccountId: NotRequired[str],
    ProxyType: NotRequired[ProxyTypeType],  # (3)
    State: NotRequired[ApplicationStateType],  # (4)
    Tags: NotRequired[Dict[str, str]],
    VpcId: NotRequired[str],
  1. See ApiGatewayProxySummaryTypeDef
  2. See ErrorResponseTypeDef
  3. See ProxyTypeType
  4. See ApplicationStateType

EnvironmentSummaryTypeDef#

# EnvironmentSummaryTypeDef definition

class EnvironmentSummaryTypeDef(TypedDict):
    Arn: NotRequired[str],
    CreatedTime: NotRequired[datetime],
    Description: NotRequired[str],
    EnvironmentId: NotRequired[str],
    Error: NotRequired[ErrorResponseTypeDef],  # (1)
    LastUpdatedTime: NotRequired[datetime],
    Name: NotRequired[str],
    NetworkFabricType: NotRequired[NetworkFabricTypeType],  # (2)
    OwnerAccountId: NotRequired[str],
    State: NotRequired[EnvironmentStateType],  # (3)
    Tags: NotRequired[Dict[str, str]],
    TransitGatewayId: NotRequired[str],
  1. See ErrorResponseTypeDef
  2. See NetworkFabricTypeType
  3. See EnvironmentStateType

RouteSummaryTypeDef#

# RouteSummaryTypeDef definition

class RouteSummaryTypeDef(TypedDict):
    AppendSourcePath: NotRequired[bool],
    ApplicationId: NotRequired[str],
    Arn: NotRequired[str],
    CreatedByAccountId: NotRequired[str],
    CreatedTime: NotRequired[datetime],
    EnvironmentId: NotRequired[str],
    Error: NotRequired[ErrorResponseTypeDef],  # (1)
    IncludeChildPaths: NotRequired[bool],
    LastUpdatedTime: NotRequired[datetime],
    Methods: NotRequired[List[HttpMethodType]],  # (2)
    OwnerAccountId: NotRequired[str],
    PathResourceToId: NotRequired[Dict[str, str]],
    RouteId: NotRequired[str],
    RouteType: NotRequired[RouteTypeType],  # (3)
    ServiceId: NotRequired[str],
    SourcePath: NotRequired[str],
    State: NotRequired[RouteStateType],  # (4)
    Tags: NotRequired[Dict[str, str]],
  1. See ErrorResponseTypeDef
  2. See HttpMethodType
  3. See RouteTypeType
  4. See RouteStateType

CreateApplicationResponseTypeDef#

# CreateApplicationResponseTypeDef definition

class CreateApplicationResponseTypeDef(TypedDict):
    ApiGatewayProxy: ApiGatewayProxyInputTypeDef,  # (1)
    ApplicationId: str,
    Arn: str,
    CreatedByAccountId: str,
    CreatedTime: datetime,
    EnvironmentId: str,
    LastUpdatedTime: datetime,
    Name: str,
    OwnerAccountId: str,
    ProxyType: ProxyTypeType,  # (2)
    State: ApplicationStateType,  # (3)
    Tags: Dict[str, str],
    VpcId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ApiGatewayProxyInputTypeDef
  2. See ProxyTypeType
  3. See ApplicationStateType
  4. See ResponseMetadataTypeDef

CreateEnvironmentResponseTypeDef#

# CreateEnvironmentResponseTypeDef definition

class CreateEnvironmentResponseTypeDef(TypedDict):
    Arn: str,
    CreatedTime: datetime,
    Description: str,
    EnvironmentId: str,
    LastUpdatedTime: datetime,
    Name: str,
    NetworkFabricType: NetworkFabricTypeType,  # (1)
    OwnerAccountId: str,
    State: EnvironmentStateType,  # (2)
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See NetworkFabricTypeType
  2. See EnvironmentStateType
  3. See ResponseMetadataTypeDef

DeleteApplicationResponseTypeDef#

# DeleteApplicationResponseTypeDef definition

class DeleteApplicationResponseTypeDef(TypedDict):
    ApplicationId: str,
    Arn: str,
    EnvironmentId: str,
    LastUpdatedTime: datetime,
    Name: str,
    State: ApplicationStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ApplicationStateType
  2. See ResponseMetadataTypeDef

DeleteEnvironmentResponseTypeDef#

# DeleteEnvironmentResponseTypeDef definition

class DeleteEnvironmentResponseTypeDef(TypedDict):
    Arn: str,
    EnvironmentId: str,
    LastUpdatedTime: datetime,
    Name: str,
    State: EnvironmentStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EnvironmentStateType
  2. See ResponseMetadataTypeDef

DeleteRouteResponseTypeDef#

# DeleteRouteResponseTypeDef definition

class DeleteRouteResponseTypeDef(TypedDict):
    ApplicationId: str,
    Arn: str,
    LastUpdatedTime: datetime,
    RouteId: str,
    ServiceId: str,
    State: RouteStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RouteStateType
  2. See ResponseMetadataTypeDef

DeleteServiceResponseTypeDef#

# DeleteServiceResponseTypeDef definition

class DeleteServiceResponseTypeDef(TypedDict):
    ApplicationId: str,
    Arn: str,
    EnvironmentId: str,
    LastUpdatedTime: datetime,
    Name: str,
    ServiceId: str,
    State: ServiceStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServiceStateType
  2. See ResponseMetadataTypeDef

GetApplicationResponseTypeDef#

# GetApplicationResponseTypeDef definition

class GetApplicationResponseTypeDef(TypedDict):
    ApiGatewayProxy: ApiGatewayProxyConfigTypeDef,  # (1)
    ApplicationId: str,
    Arn: str,
    CreatedByAccountId: str,
    CreatedTime: datetime,
    EnvironmentId: str,
    Error: ErrorResponseTypeDef,  # (2)
    LastUpdatedTime: datetime,
    Name: str,
    OwnerAccountId: str,
    ProxyType: ProxyTypeType,  # (3)
    State: ApplicationStateType,  # (4)
    Tags: Dict[str, str],
    VpcId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See ApiGatewayProxyConfigTypeDef
  2. See ErrorResponseTypeDef
  3. See ProxyTypeType
  4. See ApplicationStateType
  5. See ResponseMetadataTypeDef

GetEnvironmentResponseTypeDef#

# GetEnvironmentResponseTypeDef definition

class GetEnvironmentResponseTypeDef(TypedDict):
    Arn: str,
    CreatedTime: datetime,
    Description: str,
    EnvironmentId: str,
    Error: ErrorResponseTypeDef,  # (1)
    LastUpdatedTime: datetime,
    Name: str,
    NetworkFabricType: NetworkFabricTypeType,  # (2)
    OwnerAccountId: str,
    State: EnvironmentStateType,  # (3)
    Tags: Dict[str, str],
    TransitGatewayId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ErrorResponseTypeDef
  2. See NetworkFabricTypeType
  3. See EnvironmentStateType
  4. See ResponseMetadataTypeDef

GetResourcePolicyResponseTypeDef#

# GetResourcePolicyResponseTypeDef definition

class GetResourcePolicyResponseTypeDef(TypedDict):
    Policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetRouteResponseTypeDef#

# GetRouteResponseTypeDef definition

class GetRouteResponseTypeDef(TypedDict):
    AppendSourcePath: bool,
    ApplicationId: str,
    Arn: str,
    CreatedByAccountId: str,
    CreatedTime: datetime,
    EnvironmentId: str,
    Error: ErrorResponseTypeDef,  # (1)
    IncludeChildPaths: bool,
    LastUpdatedTime: datetime,
    Methods: List[HttpMethodType],  # (2)
    OwnerAccountId: str,
    PathResourceToId: Dict[str, str],
    RouteId: str,
    RouteType: RouteTypeType,  # (3)
    ServiceId: str,
    SourcePath: str,
    State: RouteStateType,  # (4)
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See ErrorResponseTypeDef
  2. See HttpMethodType
  3. See RouteTypeType
  4. See RouteStateType
  5. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateRouteResponseTypeDef#

# UpdateRouteResponseTypeDef definition

class UpdateRouteResponseTypeDef(TypedDict):
    ApplicationId: str,
    Arn: str,
    LastUpdatedTime: datetime,
    RouteId: str,
    ServiceId: str,
    State: RouteStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RouteStateType
  2. See ResponseMetadataTypeDef

CreateRouteRequestRequestTypeDef#

# CreateRouteRequestRequestTypeDef definition

class CreateRouteRequestRequestTypeDef(TypedDict):
    ApplicationIdentifier: str,
    EnvironmentIdentifier: str,
    RouteType: RouteTypeType,  # (1)
    ServiceIdentifier: str,
    ClientToken: NotRequired[str],
    DefaultRoute: NotRequired[DefaultRouteInputTypeDef],  # (2)
    Tags: NotRequired[Mapping[str, str]],
    UriPathRoute: NotRequired[UriPathRouteInputTypeDef],  # (3)
  1. See RouteTypeType
  2. See DefaultRouteInputTypeDef
  3. See UriPathRouteInputTypeDef

CreateRouteResponseTypeDef#

# CreateRouteResponseTypeDef definition

class CreateRouteResponseTypeDef(TypedDict):
    ApplicationId: str,
    Arn: str,
    CreatedByAccountId: str,
    CreatedTime: datetime,
    LastUpdatedTime: datetime,
    OwnerAccountId: str,
    RouteId: str,
    RouteType: RouteTypeType,  # (1)
    ServiceId: str,
    State: RouteStateType,  # (2)
    Tags: Dict[str, str],
    UriPathRoute: UriPathRouteInputTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See RouteTypeType
  2. See RouteStateType
  3. See UriPathRouteInputTypeDef
  4. See ResponseMetadataTypeDef

CreateServiceRequestRequestTypeDef#

# CreateServiceRequestRequestTypeDef definition

class CreateServiceRequestRequestTypeDef(TypedDict):
    ApplicationIdentifier: str,
    EndpointType: ServiceEndpointTypeType,  # (1)
    EnvironmentIdentifier: str,
    Name: str,
    ClientToken: NotRequired[str],
    Description: NotRequired[str],
    LambdaEndpoint: NotRequired[LambdaEndpointInputTypeDef],  # (2)
    Tags: NotRequired[Mapping[str, str]],
    UrlEndpoint: NotRequired[UrlEndpointInputTypeDef],  # (3)
    VpcId: NotRequired[str],
  1. See ServiceEndpointTypeType
  2. See LambdaEndpointInputTypeDef
  3. See UrlEndpointInputTypeDef

CreateServiceResponseTypeDef#

# CreateServiceResponseTypeDef definition

class CreateServiceResponseTypeDef(TypedDict):
    ApplicationId: str,
    Arn: str,
    CreatedByAccountId: str,
    CreatedTime: datetime,
    Description: str,
    EndpointType: ServiceEndpointTypeType,  # (1)
    EnvironmentId: str,
    LambdaEndpoint: LambdaEndpointInputTypeDef,  # (2)
    LastUpdatedTime: datetime,
    Name: str,
    OwnerAccountId: str,
    ServiceId: str,
    State: ServiceStateType,  # (3)
    Tags: Dict[str, str],
    UrlEndpoint: UrlEndpointInputTypeDef,  # (4)
    VpcId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See