Skip to content

ArtifactClient#

Index > Artifact > ArtifactClient

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

ArtifactClient#

Type annotations and code completion for boto3.client("artifact"). boto3 documentation

# ArtifactClient usage example

from boto3.session import Session
from types_boto3_artifact.client import ArtifactClient

def get_artifact_client() -> ArtifactClient:
    return Session().client("artifact")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("artifact").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("artifact")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_artifact.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("artifact").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("artifact").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_compliance_inquiry#

Create a new compliance inquiry.

Type annotations and code completion for boto3.client("artifact").create_compliance_inquiry method. boto3 documentation

# create_compliance_inquiry method definition

def create_compliance_inquiry(
    self,
    *,
    name: str,
    inquiryContent: InquiryContentTypeDef,  # (1)
    clientToken: str = ...,
    supportMode: InquirySupportModeType = ...,  # (2)
    tags: Mapping[str, str] = ...,
) -> CreateComplianceInquiryResponseTypeDef:  # (3)
    ...
  1. See InquiryContentTypeDef
  2. See InquirySupportModeType
  3. See CreateComplianceInquiryResponseTypeDef
# create_compliance_inquiry method usage example with argument unpacking

kwargs: CreateComplianceInquiryRequestTypeDef = {  # (1)
    "name": ...,
    "inquiryContent": ...,
}

parent.create_compliance_inquiry(**kwargs)
  1. See CreateComplianceInquiryRequestTypeDef

export_compliance_inquiry#

Export a compliance inquiry report.

Type annotations and code completion for boto3.client("artifact").export_compliance_inquiry method. boto3 documentation

# export_compliance_inquiry method definition

def export_compliance_inquiry(
    self,
    *,
    complianceInquiryId: str,
    queryIdentifiers: Sequence[int] = ...,
    includeCitations: bool = ...,
) -> ExportComplianceInquiryResponseTypeDef:  # (1)
    ...
  1. See ExportComplianceInquiryResponseTypeDef
# export_compliance_inquiry method usage example with argument unpacking

kwargs: ExportComplianceInquiryRequestTypeDef = {  # (1)
    "complianceInquiryId": ...,
}

parent.export_compliance_inquiry(**kwargs)
  1. See ExportComplianceInquiryRequestTypeDef

get_account_settings#

Get the account settings for Artifact.

Type annotations and code completion for boto3.client("artifact").get_account_settings method. boto3 documentation

# get_account_settings method definition

def get_account_settings(
    self,
) -> GetAccountSettingsResponseTypeDef:  # (1)
    ...
  1. See GetAccountSettingsResponseTypeDef

get_compliance_inquiry_metadata#

Get the metadata for a single compliance inquiry.

Type annotations and code completion for boto3.client("artifact").get_compliance_inquiry_metadata method. boto3 documentation

# get_compliance_inquiry_metadata method definition

def get_compliance_inquiry_metadata(
    self,
    *,
    complianceInquiryId: str,
) -> GetComplianceInquiryMetadataResponseTypeDef:  # (1)
    ...
  1. See GetComplianceInquiryMetadataResponseTypeDef
# get_compliance_inquiry_metadata method usage example with argument unpacking

kwargs: GetComplianceInquiryMetadataRequestTypeDef = {  # (1)
    "complianceInquiryId": ...,
}

parent.get_compliance_inquiry_metadata(**kwargs)
  1. See GetComplianceInquiryMetadataRequestTypeDef

get_report#

Get the content for a single report.

Type annotations and code completion for boto3.client("artifact").get_report method. boto3 documentation

# get_report method definition

def get_report(
    self,
    *,
    reportId: str,
    termToken: str,
    reportVersion: int = ...,
) -> GetReportResponseTypeDef:  # (1)
    ...
  1. See GetReportResponseTypeDef
# get_report method usage example with argument unpacking

kwargs: GetReportRequestTypeDef = {  # (1)
    "reportId": ...,
    "termToken": ...,
}

parent.get_report(**kwargs)
  1. See GetReportRequestTypeDef

get_report_metadata#

Get the metadata for a single report.

Type annotations and code completion for boto3.client("artifact").get_report_metadata method. boto3 documentation

# get_report_metadata method definition

def get_report_metadata(
    self,
    *,
    reportId: str,
    reportVersion: int = ...,
) -> GetReportMetadataResponseTypeDef:  # (1)
    ...
  1. See GetReportMetadataResponseTypeDef
# get_report_metadata method usage example with argument unpacking

kwargs: GetReportMetadataRequestTypeDef = {  # (1)
    "reportId": ...,
}

parent.get_report_metadata(**kwargs)
  1. See GetReportMetadataRequestTypeDef

get_term_for_report#

Get the Term content associated with a single report.

Type annotations and code completion for boto3.client("artifact").get_term_for_report method. boto3 documentation

# get_term_for_report method definition

def get_term_for_report(
    self,
    *,
    reportId: str,
    reportVersion: int = ...,
) -> GetTermForReportResponseTypeDef:  # (1)
    ...
  1. See GetTermForReportResponseTypeDef
# get_term_for_report method usage example with argument unpacking

kwargs: GetTermForReportRequestTypeDef = {  # (1)
    "reportId": ...,
}

parent.get_term_for_report(**kwargs)
  1. See GetTermForReportRequestTypeDef

list_compliance_inquiries#

List available compliance inquiries.

Type annotations and code completion for boto3.client("artifact").list_compliance_inquiries method. boto3 documentation

# list_compliance_inquiries method definition

def list_compliance_inquiries(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListComplianceInquiriesResponseTypeDef:  # (1)
    ...
  1. See ListComplianceInquiriesResponseTypeDef
# list_compliance_inquiries method usage example with argument unpacking

kwargs: ListComplianceInquiriesRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_compliance_inquiries(**kwargs)
  1. See ListComplianceInquiriesRequestTypeDef

list_compliance_inquiry_queries#

List queries within a compliance inquiry.

Type annotations and code completion for boto3.client("artifact").list_compliance_inquiry_queries method. boto3 documentation

# list_compliance_inquiry_queries method definition

def list_compliance_inquiry_queries(
    self,
    *,
    complianceInquiryId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListComplianceInquiryQueriesResponseTypeDef:  # (1)
    ...
  1. See ListComplianceInquiryQueriesResponseTypeDef
# list_compliance_inquiry_queries method usage example with argument unpacking

kwargs: ListComplianceInquiryQueriesRequestTypeDef = {  # (1)
    "complianceInquiryId": ...,
}

parent.list_compliance_inquiry_queries(**kwargs)
  1. See ListComplianceInquiryQueriesRequestTypeDef

list_customer_agreements#

List active customer-agreements applicable to calling identity.

Type annotations and code completion for boto3.client("artifact").list_customer_agreements method. boto3 documentation

# list_customer_agreements method definition

def list_customer_agreements(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListCustomerAgreementsResponseTypeDef:  # (1)
    ...
  1. See ListCustomerAgreementsResponseTypeDef
# list_customer_agreements method usage example with argument unpacking

kwargs: ListCustomerAgreementsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_customer_agreements(**kwargs)
  1. See ListCustomerAgreementsRequestTypeDef

list_report_versions#

List available report versions for a given report.

Type annotations and code completion for boto3.client("artifact").list_report_versions method. boto3 documentation

# list_report_versions method definition

def list_report_versions(
    self,
    *,
    reportId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListReportVersionsResponseTypeDef:  # (1)
    ...
  1. See ListReportVersionsResponseTypeDef
# list_report_versions method usage example with argument unpacking

kwargs: ListReportVersionsRequestTypeDef = {  # (1)
    "reportId": ...,
}

parent.list_report_versions(**kwargs)
  1. See ListReportVersionsRequestTypeDef

list_reports#

List available reports.

Type annotations and code completion for boto3.client("artifact").list_reports method. boto3 documentation

# list_reports method definition

def list_reports(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListReportsResponseTypeDef:  # (1)
    ...
  1. See ListReportsResponseTypeDef
# list_reports method usage example with argument unpacking

kwargs: ListReportsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_reports(**kwargs)
  1. See ListReportsRequestTypeDef

list_tags_for_resource#

List tags for a resource.

Type annotations and code completion for boto3.client("artifact").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

put_account_settings#

Put the account settings for Artifact.

Type annotations and code completion for boto3.client("artifact").put_account_settings method. boto3 documentation

# put_account_settings method definition

def put_account_settings(
    self,
    *,
    notificationSubscriptionStatus: NotificationSubscriptionStatusType = ...,  # (1)
) -> PutAccountSettingsResponseTypeDef:  # (2)
    ...
  1. See NotificationSubscriptionStatusType
  2. See PutAccountSettingsResponseTypeDef
# put_account_settings method usage example with argument unpacking

kwargs: PutAccountSettingsRequestTypeDef = {  # (1)
    "notificationSubscriptionStatus": ...,
}

parent.put_account_settings(**kwargs)
  1. See PutAccountSettingsRequestTypeDef

tag_resource#

Add tags to a resource.

Type annotations and code completion for boto3.client("artifact").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Remove tags from a resource.

Type annotations and code completion for boto3.client("artifact").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("artifact").get_paginator method with overloads.