Skip to content

Type definitions#

Index > Artifact > Type definitions

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

BlobTypeDef#

# BlobTypeDef Union usage example

from types_boto3_artifact.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

AccountSettingsTypeDef#

# AccountSettingsTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import AccountSettingsTypeDef


def get_value() -> AccountSettingsTypeDef:
    return {
        "notificationSubscriptionStatus": ...,
    }


# AccountSettingsTypeDef definition

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

CitationTypeDef#

# CitationTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import CitationTypeDef


def get_value() -> CitationTypeDef:
    return {
        "sourceLabel": ...,
    }


# CitationTypeDef definition

class CitationTypeDef(TypedDict):
    sourceLabel: NotRequired[str],
    sourceContent: NotRequired[str],
    sourceLink: NotRequired[str],

InquirySummaryTypeDef#

# InquirySummaryTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import InquirySummaryTypeDef


def get_value() -> InquirySummaryTypeDef:
    return {
        "arn": ...,
    }


# InquirySummaryTypeDef definition

class InquirySummaryTypeDef(TypedDict):
    arn: str,
    name: str,
    id: str,
    status: InquiryStatusType,  # (1)
    statusMessage: InquiryStatusMessageType,  # (2)
    inputSource: InputSourceType,  # (3)
    createdAt: datetime.datetime,
  1. See InquiryStatusType
  2. See InquiryStatusMessageType
  3. See InputSourceType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

CustomerAgreementSummaryTypeDef#

# CustomerAgreementSummaryTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import CustomerAgreementSummaryTypeDef


def get_value() -> CustomerAgreementSummaryTypeDef:
    return {
        "name": ...,
    }


# 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.datetime],
    effectiveEnd: NotRequired[datetime.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

ExportComplianceInquiryRequestTypeDef#

# ExportComplianceInquiryRequestTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ExportComplianceInquiryRequestTypeDef


def get_value() -> ExportComplianceInquiryRequestTypeDef:
    return {
        "complianceInquiryId": ...,
    }


# ExportComplianceInquiryRequestTypeDef definition

class ExportComplianceInquiryRequestTypeDef(TypedDict):
    complianceInquiryId: str,
    queryIdentifiers: NotRequired[Sequence[int]],
    includeCitations: NotRequired[bool],

GetComplianceInquiryMetadataRequestTypeDef#

# GetComplianceInquiryMetadataRequestTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import GetComplianceInquiryMetadataRequestTypeDef


def get_value() -> GetComplianceInquiryMetadataRequestTypeDef:
    return {
        "complianceInquiryId": ...,
    }


# GetComplianceInquiryMetadataRequestTypeDef definition

class GetComplianceInquiryMetadataRequestTypeDef(TypedDict):
    complianceInquiryId: str,

InquiryDetailTypeDef#

# InquiryDetailTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import InquiryDetailTypeDef


def get_value() -> InquiryDetailTypeDef:
    return {
        "arn": ...,
    }


# InquiryDetailTypeDef definition

class InquiryDetailTypeDef(TypedDict):
    arn: str,
    name: str,
    id: str,
    status: InquiryStatusType,  # (1)
    statusMessage: InquiryStatusMessageType,  # (2)
    inputSource: InputSourceType,  # (3)
    createdAt: datetime.datetime,
    updatedAt: NotRequired[datetime.datetime],
    supportMode: NotRequired[InquirySupportModeType],  # (4)
  1. See InquiryStatusType
  2. See InquiryStatusMessageType
  3. See InputSourceType
  4. See InquirySupportModeType

GetReportMetadataRequestTypeDef#

# GetReportMetadataRequestTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import GetReportMetadataRequestTypeDef


def get_value() -> GetReportMetadataRequestTypeDef:
    return {
        "reportId": ...,
    }


# GetReportMetadataRequestTypeDef definition

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

ReportDetailTypeDef#

# ReportDetailTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ReportDetailTypeDef


def get_value() -> ReportDetailTypeDef:
    return {
        "id": ...,
    }


# ReportDetailTypeDef definition

class ReportDetailTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],
    description: NotRequired[str],
    periodStart: NotRequired[datetime.datetime],
    periodEnd: NotRequired[datetime.datetime],
    createdAt: NotRequired[datetime.datetime],
    lastModifiedAt: NotRequired[datetime.datetime],
    deletedAt: NotRequired[datetime.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

GetReportRequestTypeDef#

# GetReportRequestTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import GetReportRequestTypeDef


def get_value() -> GetReportRequestTypeDef:
    return {
        "reportId": ...,
    }


# GetReportRequestTypeDef definition

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

GetTermForReportRequestTypeDef#

# GetTermForReportRequestTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import GetTermForReportRequestTypeDef


def get_value() -> GetTermForReportRequestTypeDef:
    return {
        "reportId": ...,
    }


# GetTermForReportRequestTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

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

ListComplianceInquiriesRequestTypeDef#

# ListComplianceInquiriesRequestTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListComplianceInquiriesRequestTypeDef


def get_value() -> ListComplianceInquiriesRequestTypeDef:
    return {
        "maxResults": ...,
    }


# ListComplianceInquiriesRequestTypeDef definition

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

ListComplianceInquiryQueriesRequestTypeDef#

# ListComplianceInquiryQueriesRequestTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListComplianceInquiryQueriesRequestTypeDef


def get_value() -> ListComplianceInquiryQueriesRequestTypeDef:
    return {
        "complianceInquiryId": ...,
    }


# ListComplianceInquiryQueriesRequestTypeDef definition

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

ListCustomerAgreementsRequestTypeDef#

# ListCustomerAgreementsRequestTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListCustomerAgreementsRequestTypeDef


def get_value() -> ListCustomerAgreementsRequestTypeDef:
    return {
        "maxResults": ...,
    }


# ListCustomerAgreementsRequestTypeDef definition

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

ListReportVersionsRequestTypeDef#

# ListReportVersionsRequestTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListReportVersionsRequestTypeDef


def get_value() -> ListReportVersionsRequestTypeDef:
    return {
        "reportId": ...,
    }


# ListReportVersionsRequestTypeDef definition

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

ReportSummaryTypeDef#

# ReportSummaryTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ReportSummaryTypeDef


def get_value() -> ReportSummaryTypeDef:
    return {
        "id": ...,
    }


# 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.datetime],
    periodEnd: NotRequired[datetime.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

ListReportsRequestTypeDef#

# ListReportsRequestTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListReportsRequestTypeDef


def get_value() -> ListReportsRequestTypeDef:
    return {
        "maxResults": ...,
    }


# ListReportsRequestTypeDef definition

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

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    resourceArn: str,

PutAccountSettingsRequestTypeDef#

# PutAccountSettingsRequestTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import PutAccountSettingsRequestTypeDef


def get_value() -> PutAccountSettingsRequestTypeDef:
    return {
        "notificationSubscriptionStatus": ...,
    }


# PutAccountSettingsRequestTypeDef definition

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

ResponseVersionTypeDef#

# ResponseVersionTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ResponseVersionTypeDef


def get_value() -> ResponseVersionTypeDef:
    return {
        "responseText": ...,
    }


# ResponseVersionTypeDef definition

class ResponseVersionTypeDef(TypedDict):
    responseText: str,
    timestamp: datetime.datetime,

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

InquiryFileContentTypeDef#

# InquiryFileContentTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import InquiryFileContentTypeDef


def get_value() -> InquiryFileContentTypeDef:
    return {
        "fileSections": ...,
    }


# InquiryFileContentTypeDef definition

class InquiryFileContentTypeDef(TypedDict):
    content: BlobTypeDef,
    fileSections: NotRequired[Sequence[str]],

CreateComplianceInquiryResponseTypeDef#

# CreateComplianceInquiryResponseTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import CreateComplianceInquiryResponseTypeDef


def get_value() -> CreateComplianceInquiryResponseTypeDef:
    return {
        "complianceInquirySummary": ...,
    }


# CreateComplianceInquiryResponseTypeDef definition

class CreateComplianceInquiryResponseTypeDef(TypedDict):
    complianceInquirySummary: InquirySummaryTypeDef,  # (1)
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InquirySummaryTypeDef
  2. See ResponseMetadataTypeDef

ExportComplianceInquiryResponseTypeDef#

# ExportComplianceInquiryResponseTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ExportComplianceInquiryResponseTypeDef


def get_value() -> ExportComplianceInquiryResponseTypeDef:
    return {
        "documentPresignedUrl": ...,
    }


# ExportComplianceInquiryResponseTypeDef definition

class ExportComplianceInquiryResponseTypeDef(TypedDict):
    documentPresignedUrl: str,
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetAccountSettingsResponseTypeDef#

# GetAccountSettingsResponseTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import GetAccountSettingsResponseTypeDef


def get_value() -> GetAccountSettingsResponseTypeDef:
    return {
        "accountSettings": ...,
    }


# GetAccountSettingsResponseTypeDef definition

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

GetReportResponseTypeDef#

# GetReportResponseTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import GetReportResponseTypeDef


def get_value() -> GetReportResponseTypeDef:
    return {
        "documentPresignedUrl": ...,
    }


# GetReportResponseTypeDef definition

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

GetTermForReportResponseTypeDef#

# GetTermForReportResponseTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import GetTermForReportResponseTypeDef


def get_value() -> GetTermForReportResponseTypeDef:
    return {
        "documentPresignedUrl": ...,
    }


# GetTermForReportResponseTypeDef definition

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

ListComplianceInquiriesResponseTypeDef#

# ListComplianceInquiriesResponseTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListComplianceInquiriesResponseTypeDef


def get_value() -> ListComplianceInquiriesResponseTypeDef:
    return {
        "complianceInquiries": ...,
    }


# ListComplianceInquiriesResponseTypeDef definition

class ListComplianceInquiriesResponseTypeDef(TypedDict):
    complianceInquiries: list[InquirySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[InquirySummaryTypeDef]
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

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

PutAccountSettingsResponseTypeDef#

# PutAccountSettingsResponseTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import PutAccountSettingsResponseTypeDef


def get_value() -> PutAccountSettingsResponseTypeDef:
    return {
        "accountSettings": ...,
    }


# PutAccountSettingsResponseTypeDef definition

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

ListCustomerAgreementsResponseTypeDef#

# ListCustomerAgreementsResponseTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListCustomerAgreementsResponseTypeDef


def get_value() -> ListCustomerAgreementsResponseTypeDef:
    return {
        "customerAgreements": ...,
    }


# ListCustomerAgreementsResponseTypeDef definition

class ListCustomerAgreementsResponseTypeDef(TypedDict):
    customerAgreements: list[CustomerAgreementSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[CustomerAgreementSummaryTypeDef]
  2. See ResponseMetadataTypeDef

GetComplianceInquiryMetadataResponseTypeDef#

# GetComplianceInquiryMetadataResponseTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import GetComplianceInquiryMetadataResponseTypeDef


def get_value() -> GetComplianceInquiryMetadataResponseTypeDef:
    return {
        "complianceInquiryDetail": ...,
    }


# GetComplianceInquiryMetadataResponseTypeDef definition

class GetComplianceInquiryMetadataResponseTypeDef(TypedDict):
    complianceInquiryDetail: InquiryDetailTypeDef,  # (1)
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InquiryDetailTypeDef
  2. See ResponseMetadataTypeDef

GetReportMetadataResponseTypeDef#

# GetReportMetadataResponseTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import GetReportMetadataResponseTypeDef


def get_value() -> GetReportMetadataResponseTypeDef:
    return {
        "reportDetails": ...,
    }


# GetReportMetadataResponseTypeDef definition

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

ListComplianceInquiriesRequestPaginateTypeDef#

# ListComplianceInquiriesRequestPaginateTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListComplianceInquiriesRequestPaginateTypeDef


def get_value() -> ListComplianceInquiriesRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListComplianceInquiriesRequestPaginateTypeDef definition

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

ListComplianceInquiryQueriesRequestPaginateTypeDef#

# ListComplianceInquiryQueriesRequestPaginateTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListComplianceInquiryQueriesRequestPaginateTypeDef


def get_value() -> ListComplianceInquiryQueriesRequestPaginateTypeDef:
    return {
        "complianceInquiryId": ...,
    }


# ListComplianceInquiryQueriesRequestPaginateTypeDef definition

class ListComplianceInquiryQueriesRequestPaginateTypeDef(TypedDict):
    complianceInquiryId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListCustomerAgreementsRequestPaginateTypeDef#

# ListCustomerAgreementsRequestPaginateTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListCustomerAgreementsRequestPaginateTypeDef


def get_value() -> ListCustomerAgreementsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListCustomerAgreementsRequestPaginateTypeDef definition

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

ListReportVersionsRequestPaginateTypeDef#

# ListReportVersionsRequestPaginateTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListReportVersionsRequestPaginateTypeDef


def get_value() -> ListReportVersionsRequestPaginateTypeDef:
    return {
        "reportId": ...,
    }


# ListReportVersionsRequestPaginateTypeDef definition

class ListReportVersionsRequestPaginateTypeDef(TypedDict):
    reportId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListReportsRequestPaginateTypeDef#

# ListReportsRequestPaginateTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListReportsRequestPaginateTypeDef


def get_value() -> ListReportsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListReportsRequestPaginateTypeDef definition

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

ListReportVersionsResponseTypeDef#

# ListReportVersionsResponseTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListReportVersionsResponseTypeDef


def get_value() -> ListReportVersionsResponseTypeDef:
    return {
        "reports": ...,
    }


# ListReportVersionsResponseTypeDef definition

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

ListReportsResponseTypeDef#

# ListReportsResponseTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListReportsResponseTypeDef


def get_value() -> ListReportsResponseTypeDef:
    return {
        "reports": ...,
    }


# ListReportsResponseTypeDef definition

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

QuerySummaryTypeDef#

# QuerySummaryTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import QuerySummaryTypeDef


def get_value() -> QuerySummaryTypeDef:
    return {
        "queryIdentifier": ...,
    }


# QuerySummaryTypeDef definition

class QuerySummaryTypeDef(TypedDict):
    queryIdentifier: int,
    query: str,
    status: QueryStatusType,  # (3)
    statusMessage: QueryStatusMessageType,  # (4)
    createdAt: datetime.datetime,
    response: NotRequired[str],
    reviewType: NotRequired[ReviewTypeType],  # (1)
    citations: NotRequired[list[CitationTypeDef]],  # (2)
    updatedResponseVersions: NotRequired[list[ResponseVersionTypeDef]],  # (5)
  1. See ReviewTypeType
  2. See list[CitationTypeDef]
  3. See QueryStatusType
  4. See QueryStatusMessageType
  5. See list[ResponseVersionTypeDef]

InquiryContentTypeDef#

# InquiryContentTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import InquiryContentTypeDef


def get_value() -> InquiryContentTypeDef:
    return {
        "query": ...,
    }


# InquiryContentTypeDef definition

class InquiryContentTypeDef(TypedDict):
    query: NotRequired[str],
    fileContent: NotRequired[InquiryFileContentTypeDef],  # (1)
  1. See InquiryFileContentTypeDef

ListComplianceInquiryQueriesResponseTypeDef#

# ListComplianceInquiryQueriesResponseTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import ListComplianceInquiryQueriesResponseTypeDef


def get_value() -> ListComplianceInquiryQueriesResponseTypeDef:
    return {
        "queries": ...,
    }


# ListComplianceInquiryQueriesResponseTypeDef definition

class ListComplianceInquiryQueriesResponseTypeDef(TypedDict):
    queries: list[QuerySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See list[QuerySummaryTypeDef]
  2. See ResponseMetadataTypeDef

CreateComplianceInquiryRequestTypeDef#

# CreateComplianceInquiryRequestTypeDef TypedDict usage example

from types_boto3_artifact.type_defs import CreateComplianceInquiryRequestTypeDef


def get_value() -> CreateComplianceInquiryRequestTypeDef:
    return {
        "name": ...,
    }


# CreateComplianceInquiryRequestTypeDef definition

class CreateComplianceInquiryRequestTypeDef(TypedDict):
    name: str,
    inquiryContent: InquiryContentTypeDef,  # (1)
    clientToken: NotRequired[str],
    supportMode: NotRequired[InquirySupportModeType],  # (2)
    tags: NotRequired[Mapping[str, str]],
  1. See InquiryContentTypeDef
  2. See InquirySupportModeType