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

CustomerAgreementSummaryTypeDef#

# CustomerAgreementSummaryTypeDef definition

class CustomerAgreementSummaryTypeDef(TypedDict):
    name: NotRequired[str],
    arn: NotRequired[str],
    id: NotRequired[str],
    agreementArn: NotRequired[str],
    awsAccountId: NotRequired[str],
    organizationArn: NotRequired[str],
    effectiveStart: NotRequired[datetime],
    effectiveEnd: NotRequired[datetime],
    state: NotRequired[CustomerAgreementStateType],  # (1)
    description: NotRequired[str],
    acceptanceTerms: NotRequired[list[str]],
    terminateTerms: NotRequired[list[str]],
    type: NotRequired[AgreementTypeType],  # (2)
  1. See CustomerAgreementStateType
  2. See AgreementTypeType

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):
    id: NotRequired[str],
    name: NotRequired[str],
    description: NotRequired[str],
    periodStart: NotRequired[datetime],
    periodEnd: NotRequired[datetime],
    createdAt: NotRequired[datetime],
    lastModifiedAt: NotRequired[datetime],
    deletedAt: NotRequired[datetime],
    state: NotRequired[PublishedStateType],  # (1)
    arn: NotRequired[str],
    series: NotRequired[str],
    category: NotRequired[str],
    companyName: NotRequired[str],
    productName: NotRequired[str],
    termArn: NotRequired[str],
    version: NotRequired[int],
    acceptanceType: NotRequired[AcceptanceTypeType],  # (2)
    sequenceNumber: NotRequired[int],
    uploadState: NotRequired[UploadStateType],  # (3)
    statusMessage: NotRequired[str],
  1. See PublishedStateType
  2. See AcceptanceTypeType
  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],

ListCustomerAgreementsRequestRequestTypeDef#

# ListCustomerAgreementsRequestRequestTypeDef definition

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

ListReportsRequestRequestTypeDef#

# ListReportsRequestRequestTypeDef definition

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

ReportSummaryTypeDef#

# ReportSummaryTypeDef definition

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

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

ListCustomerAgreementsResponseTypeDef#

# ListCustomerAgreementsResponseTypeDef definition

class ListCustomerAgreementsResponseTypeDef(TypedDict):
    customerAgreements: list[CustomerAgreementSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See CustomerAgreementSummaryTypeDef
  2. 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

ListCustomerAgreementsRequestPaginateTypeDef#

# ListCustomerAgreementsRequestPaginateTypeDef definition

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

ListReportsRequestPaginateTypeDef#

# ListReportsRequestPaginateTypeDef definition

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

ListReportsResponseTypeDef#

# ListReportsResponseTypeDef definition

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