Skip to content

Type definitions#

Index > Artifact > Type definitions

Auto-generated documentation for Artifact type annotations stubs module mypy-boto3-artifact.

AccountSettingsTypeDef#

# AccountSettingsTypeDef definition

class AccountSettingsTypeDef(TypedDict):
    notificationSubscriptionStatus: NotRequired[NotificationSubscriptionStatusType],  # (1)
  1. See NotificationSubscriptionStatusType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

GetReportMetadataRequestRequestTypeDef#

# GetReportMetadataRequestRequestTypeDef definition

class GetReportMetadataRequestRequestTypeDef(TypedDict):
    reportId: str,
    reportVersion: NotRequired[int],

ReportDetailTypeDef#

# ReportDetailTypeDef definition

class ReportDetailTypeDef(TypedDict):
    acceptanceType: NotRequired[AcceptanceTypeType],  # (1)
    arn: NotRequired[str],
    category: NotRequired[str],
    companyName: NotRequired[str],
    createdAt: NotRequired[datetime],
    deletedAt: NotRequired[datetime],
    description: NotRequired[str],
    id: NotRequired[str],
    lastModifiedAt: NotRequired[datetime],
    name: NotRequired[str],
    periodEnd: NotRequired[datetime],
    periodStart: NotRequired[datetime],
    productName: NotRequired[str],
    sequenceNumber: NotRequired[int],
    series: NotRequired[str],
    state: NotRequired[PublishedStateType],  # (2)
    statusMessage: NotRequired[str],
    termArn: NotRequired[str],
    uploadState: NotRequired[UploadStateType],  # (3)
    version: NotRequired[int],
  1. See AcceptanceTypeType
  2. See PublishedStateType
  3. See UploadStateType

GetReportRequestRequestTypeDef#

# GetReportRequestRequestTypeDef definition

class GetReportRequestRequestTypeDef(TypedDict):
    reportId: str,
    termToken: str,
    reportVersion: NotRequired[int],

GetTermForReportRequestRequestTypeDef#

# GetTermForReportRequestRequestTypeDef definition

class GetTermForReportRequestRequestTypeDef(TypedDict):
    reportId: str,
    reportVersion: NotRequired[int],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListReportsRequestRequestTypeDef#

# ListReportsRequestRequestTypeDef definition

class ListReportsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ReportSummaryTypeDef#

# ReportSummaryTypeDef definition

class ReportSummaryTypeDef(TypedDict):
    arn: NotRequired[str],
    category: NotRequired[str],
    companyName: NotRequired[str],
    description: NotRequired[str],
    id: NotRequired[str],
    name: NotRequired[str],
    periodEnd: NotRequired[datetime],
    periodStart: NotRequired[datetime],
    productName: NotRequired[str],
    series: NotRequired[str],
    state: NotRequired[PublishedStateType],  # (1)
    statusMessage: NotRequired[str],
    uploadState: NotRequired[UploadStateType],  # (2)
    version: NotRequired[int],
  1. See PublishedStateType
  2. See UploadStateType

PutAccountSettingsRequestRequestTypeDef#

# PutAccountSettingsRequestRequestTypeDef definition

class PutAccountSettingsRequestRequestTypeDef(TypedDict):
    notificationSubscriptionStatus: NotRequired[NotificationSubscriptionStatusType],  # (1)
  1. See NotificationSubscriptionStatusType

GetAccountSettingsResponseTypeDef#

# GetAccountSettingsResponseTypeDef definition

class GetAccountSettingsResponseTypeDef(TypedDict):
    accountSettings: AccountSettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountSettingsTypeDef
  2. See ResponseMetadataTypeDef

GetReportResponseTypeDef#

# GetReportResponseTypeDef definition

class GetReportResponseTypeDef(TypedDict):
    documentPresignedUrl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetTermForReportResponseTypeDef#

# GetTermForReportResponseTypeDef definition

class GetTermForReportResponseTypeDef(TypedDict):
    documentPresignedUrl: str,
    termToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutAccountSettingsResponseTypeDef#

# PutAccountSettingsResponseTypeDef definition

class PutAccountSettingsResponseTypeDef(TypedDict):
    accountSettings: AccountSettingsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountSettingsTypeDef
  2. See ResponseMetadataTypeDef

GetReportMetadataResponseTypeDef#

# GetReportMetadataResponseTypeDef definition

class GetReportMetadataResponseTypeDef(TypedDict):
    reportDetails: ReportDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReportDetailTypeDef
  2. See ResponseMetadataTypeDef

ListReportsRequestListReportsPaginateTypeDef#

# ListReportsRequestListReportsPaginateTypeDef definition

class ListReportsRequestListReportsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListReportsResponseTypeDef#

# ListReportsResponseTypeDef definition

class ListReportsResponseTypeDef(TypedDict):
    nextToken: str,
    reports: List[ReportSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReportSummaryTypeDef
  2. See ResponseMetadataTypeDef