ArtifactClient

Index > Artifact > ArtifactClient

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

ArtifactClient

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

# ArtifactClient usage example

from boto3.session import Session
from mypy_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 mypy_boto3_artifact.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

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:
    ...

close

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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:
    ...

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_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: GetReportRequestRequestTypeDef = {  # (1)
    "reportId": ...,
    "termToken": ...,
}

parent.get_report(**kwargs)

1. See GetReportRequestRequestTypeDef

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: GetReportMetadataRequestRequestTypeDef = {  # (1)
    "reportId": ...,
}

parent.get_report_metadata(**kwargs)

1. See GetReportMetadataRequestRequestTypeDef

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: GetTermForReportRequestRequestTypeDef = {  # (1)
    "reportId": ...,
}

parent.get_term_for_report(**kwargs)

1. See GetTermForReportRequestRequestTypeDef

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: ListReportsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_reports(**kwargs)

1. See ListReportsRequestRequestTypeDef

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: PutAccountSettingsRequestRequestTypeDef = {  # (1)
    "notificationSubscriptionStatus": ...,
}

parent.put_account_settings(**kwargs)

1. See PutAccountSettingsRequestRequestTypeDef

get_paginator

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

• client.get_paginator("list_reports") -> ListReportsPaginator