Skip to content

Typed dictionaries

Index > MarketplaceCatalog > Typed dictionaries

Auto-generated documentation for MarketplaceCatalog type annotations stubs module mypy-boto3-marketplace-catalog.

CancelChangeSetRequestRequestTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import CancelChangeSetRequestRequestTypeDef

def get_value() -> CancelChangeSetRequestRequestTypeDef:
    return {
        "Catalog": ...,
        "ChangeSetId": ...,
    }
Definition
class CancelChangeSetRequestRequestTypeDef(TypedDict):
    Catalog: str,
    ChangeSetId: str,

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

ChangeSetSummaryListItemTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import ChangeSetSummaryListItemTypeDef

def get_value() -> ChangeSetSummaryListItemTypeDef:
    return {
        "ChangeSetId": ...,
    }
Definition
class ChangeSetSummaryListItemTypeDef(TypedDict):
    ChangeSetId: NotRequired[str],
    ChangeSetArn: NotRequired[str],
    ChangeSetName: NotRequired[str],
    StartTime: NotRequired[str],
    EndTime: NotRequired[str],
    Status: NotRequired[ChangeStatusType],  # (1)
    EntityIdList: NotRequired[List[str]],
    FailureCode: NotRequired[FailureCodeType],  # (2)
  1. See ChangeStatusType
  2. See FailureCodeType

EntityTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import EntityTypeDef

def get_value() -> EntityTypeDef:
    return {
        "Type": ...,
    }
Definition
class EntityTypeDef(TypedDict):
    Type: str,
    Identifier: NotRequired[str],

ErrorDetailTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import ErrorDetailTypeDef

def get_value() -> ErrorDetailTypeDef:
    return {
        "ErrorCode": ...,
    }
Definition
class ErrorDetailTypeDef(TypedDict):
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],

DescribeChangeSetRequestRequestTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import DescribeChangeSetRequestRequestTypeDef

def get_value() -> DescribeChangeSetRequestRequestTypeDef:
    return {
        "Catalog": ...,
        "ChangeSetId": ...,
    }
Definition
class DescribeChangeSetRequestRequestTypeDef(TypedDict):
    Catalog: str,
    ChangeSetId: str,

DescribeEntityRequestRequestTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import DescribeEntityRequestRequestTypeDef

def get_value() -> DescribeEntityRequestRequestTypeDef:
    return {
        "Catalog": ...,
        "EntityId": ...,
    }
Definition
class DescribeEntityRequestRequestTypeDef(TypedDict):
    Catalog: str,
    EntityId: str,

EntitySummaryTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import EntitySummaryTypeDef

def get_value() -> EntitySummaryTypeDef:
    return {
        "Name": ...,
    }
Definition
class EntitySummaryTypeDef(TypedDict):
    Name: NotRequired[str],
    EntityType: NotRequired[str],
    EntityId: NotRequired[str],
    EntityArn: NotRequired[str],
    LastModifiedDate: NotRequired[str],
    Visibility: NotRequired[str],

FilterTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import FilterTypeDef

def get_value() -> FilterTypeDef:
    return {
        "Name": ...,
    }
Definition
class FilterTypeDef(TypedDict):
    Name: NotRequired[str],
    ValueList: NotRequired[Sequence[str]],

SortTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import SortTypeDef

def get_value() -> SortTypeDef:
    return {
        "SortBy": ...,
    }
Definition
class SortTypeDef(TypedDict):
    SortBy: NotRequired[str],
    SortOrder: NotRequired[SortOrderType],  # (1)
  1. See SortOrderType

CancelChangeSetResponseTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import CancelChangeSetResponseTypeDef

def get_value() -> CancelChangeSetResponseTypeDef:
    return {
        "ChangeSetId": ...,
        "ChangeSetArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class CancelChangeSetResponseTypeDef(TypedDict):
    ChangeSetId: str,
    ChangeSetArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeEntityResponseTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import DescribeEntityResponseTypeDef

def get_value() -> DescribeEntityResponseTypeDef:
    return {
        "EntityType": ...,
        "EntityIdentifier": ...,
        "EntityArn": ...,
        "LastModifiedDate": ...,
        "Details": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeEntityResponseTypeDef(TypedDict):
    EntityType: str,
    EntityIdentifier: str,
    EntityArn: str,
    LastModifiedDate: str,
    Details: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartChangeSetResponseTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import StartChangeSetResponseTypeDef

def get_value() -> StartChangeSetResponseTypeDef:
    return {
        "ChangeSetId": ...,
        "ChangeSetArn": ...,
        "ResponseMetadata": ...,
    }
Definition
class StartChangeSetResponseTypeDef(TypedDict):
    ChangeSetId: str,
    ChangeSetArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListChangeSetsResponseTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import ListChangeSetsResponseTypeDef

def get_value() -> ListChangeSetsResponseTypeDef:
    return {
        "ChangeSetSummaryList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListChangeSetsResponseTypeDef(TypedDict):
    ChangeSetSummaryList: List[ChangeSetSummaryListItemTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChangeSetSummaryListItemTypeDef
  2. See ResponseMetadataTypeDef

ChangeTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import ChangeTypeDef

def get_value() -> ChangeTypeDef:
    return {
        "ChangeType": ...,
        "Entity": ...,
        "Details": ...,
    }
Definition
class ChangeTypeDef(TypedDict):
    ChangeType: str,
    Entity: EntityTypeDef,  # (1)
    Details: str,
    ChangeName: NotRequired[str],
  1. See EntityTypeDef

ChangeSummaryTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import ChangeSummaryTypeDef

def get_value() -> ChangeSummaryTypeDef:
    return {
        "ChangeType": ...,
    }
Definition
class ChangeSummaryTypeDef(TypedDict):
    ChangeType: NotRequired[str],
    Entity: NotRequired[EntityTypeDef],  # (1)
    Details: NotRequired[str],
    ErrorDetailList: NotRequired[List[ErrorDetailTypeDef]],  # (2)
    ChangeName: NotRequired[str],
  1. See EntityTypeDef
  2. See ErrorDetailTypeDef

ListEntitiesResponseTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import ListEntitiesResponseTypeDef

def get_value() -> ListEntitiesResponseTypeDef:
    return {
        "EntitySummaryList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListEntitiesResponseTypeDef(TypedDict):
    EntitySummaryList: List[EntitySummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EntitySummaryTypeDef
  2. See ResponseMetadataTypeDef

ListChangeSetsRequestRequestTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import ListChangeSetsRequestRequestTypeDef

def get_value() -> ListChangeSetsRequestRequestTypeDef:
    return {
        "Catalog": ...,
    }
Definition
class ListChangeSetsRequestRequestTypeDef(TypedDict):
    Catalog: str,
    FilterList: NotRequired[Sequence[FilterTypeDef]],  # (1)
    Sort: NotRequired[SortTypeDef],  # (2)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See FilterTypeDef
  2. See SortTypeDef

ListEntitiesRequestRequestTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import ListEntitiesRequestRequestTypeDef

def get_value() -> ListEntitiesRequestRequestTypeDef:
    return {
        "Catalog": ...,
        "EntityType": ...,
    }
Definition
class ListEntitiesRequestRequestTypeDef(TypedDict):
    Catalog: str,
    EntityType: str,
    FilterList: NotRequired[Sequence[FilterTypeDef]],  # (1)
    Sort: NotRequired[SortTypeDef],  # (2)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See FilterTypeDef
  2. See SortTypeDef

StartChangeSetRequestRequestTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import StartChangeSetRequestRequestTypeDef

def get_value() -> StartChangeSetRequestRequestTypeDef:
    return {
        "Catalog": ...,
        "ChangeSet": ...,
    }
Definition
class StartChangeSetRequestRequestTypeDef(TypedDict):
    Catalog: str,
    ChangeSet: Sequence[ChangeTypeDef],  # (1)
    ChangeSetName: NotRequired[str],
    ClientRequestToken: NotRequired[str],
  1. See ChangeTypeDef

DescribeChangeSetResponseTypeDef

Usage Example
from mypy_boto3_marketplace_catalog.type_defs import DescribeChangeSetResponseTypeDef

def get_value() -> DescribeChangeSetResponseTypeDef:
    return {
        "ChangeSetId": ...,
        "ChangeSetArn": ...,
        "ChangeSetName": ...,
        "StartTime": ...,
        "EndTime": ...,
        "Status": ...,
        "FailureCode": ...,
        "FailureDescription": ...,
        "ChangeSet": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeChangeSetResponseTypeDef(TypedDict):
    ChangeSetId: str,
    ChangeSetArn: str,
    ChangeSetName: str,
    StartTime: str,
    EndTime: str,
    Status: ChangeStatusType,  # (1)
    FailureCode: FailureCodeType,  # (2)
    FailureDescription: str,
    ChangeSet: List[ChangeSummaryTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ChangeStatusType
  2. See FailureCodeType
  3. See ChangeSummaryTypeDef
  4. See ResponseMetadataTypeDef