Artifact ******** Client ====== class Artifact.Client A low-level client representing AWS Artifact This reference provides descriptions of the low-level AWS Artifact Service API. import boto3 client = boto3.client('artifact') These are the available methods: * can_paginate * close * get_account_settings * get_paginator * get_report * get_report_metadata * get_term_for_report * get_waiter * list_customer_agreements * list_reports * put_account_settings Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListCustomerAgreements * ListReports Artifact / Paginator / ListReports ListReports *********** class Artifact.Paginator.ListReports paginator = client.get_paginator('list_reports') paginate(**kwargs) Creates an iterator that will paginate through responses from "Artifact.Client.list_reports()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'reports': [ { 'id': 'string', 'name': 'string', 'state': 'PUBLISHED'|'UNPUBLISHED', 'arn': 'string', 'version': 123, 'uploadState': 'PROCESSING'|'COMPLETE'|'FAILED'|'FAULT', 'description': 'string', 'periodStart': datetime(2015, 1, 1), 'periodEnd': datetime(2015, 1, 1), 'series': 'string', 'category': 'string', 'companyName': 'string', 'productName': 'string', 'statusMessage': 'string', 'acceptanceType': 'PASSTHROUGH'|'EXPLICIT' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **reports** *(list) --* List of report resources. * *(dict) --* Summary for report resource. * **id** *(string) --* Unique resource ID for the report resource. * **name** *(string) --* Name for the report resource. * **state** *(string) --* Current state of the report resource. * **arn** *(string) --* ARN for the report resource. * **version** *(integer) --* Version for the report resource. * **uploadState** *(string) --* The current state of the document upload. * **description** *(string) --* Description for the report resource. * **periodStart** *(datetime) --* Timestamp indicating the report resource effective start. * **periodEnd** *(datetime) --* Timestamp indicating the report resource effective end. * **series** *(string) --* Series for the report resource. * **category** *(string) --* Category for the report resource. * **companyName** *(string) --* Associated company name for the report resource. * **productName** *(string) --* Associated product name for the report resource. * **statusMessage** *(string) --* The message associated with the current upload state. * **acceptanceType** *(string) --* Acceptance type for report. * **NextToken** *(string) --* A token to resume pagination. Artifact / Paginator / ListCustomerAgreements ListCustomerAgreements ********************** class Artifact.Paginator.ListCustomerAgreements paginator = client.get_paginator('list_customer_agreements') paginate(**kwargs) Creates an iterator that will paginate through responses from "Artifact.Client.list_customer_agreements()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'customerAgreements': [ { 'name': 'string', 'arn': 'string', 'id': 'string', 'agreementArn': 'string', 'awsAccountId': 'string', 'organizationArn': 'string', 'effectiveStart': datetime(2015, 1, 1), 'effectiveEnd': datetime(2015, 1, 1), 'state': 'ACTIVE'|'CUSTOMER_TERMINATED'|'AWS_TERMINATED', 'description': 'string', 'acceptanceTerms': [ 'string', ], 'terminateTerms': [ 'string', ], 'type': 'CUSTOM'|'DEFAULT'|'MODIFIED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **customerAgreements** *(list) --* List of customer-agreement resources. * *(dict) --* Summary for customer-agreement resource. * **name** *(string) --* Name of the customer-agreement resource. * **arn** *(string) --* ARN of the customer-agreement resource. * **id** *(string) --* Identifier of the customer-agreement resource. * **agreementArn** *(string) --* ARN of the agreement resource the customer-agreement resource represents. * **awsAccountId** *(string) --* AWS account Id that owns the resource. * **organizationArn** *(string) --* ARN of the organization that owns the resource. * **effectiveStart** *(datetime) --* Timestamp indicating when the agreement became effective. * **effectiveEnd** *(datetime) --* Timestamp indicating when the agreement was terminated. * **state** *(string) --* State of the resource. * **description** *(string) --* Description of the resource. * **acceptanceTerms** *(list) --* Terms required to accept the agreement resource. * *(string) --* * **terminateTerms** *(list) --* Terms required to terminate the customer-agreement resource. * *(string) --* * **type** *(string) --* Type of the customer-agreement resource. * **NextToken** *(string) --* A token to resume pagination. Artifact / Client / get_report get_report ********** Artifact.Client.get_report(**kwargs) Get the content for a single report. See also: AWS API Documentation **Request Syntax** response = client.get_report( reportId='string', reportVersion=123, termToken='string' ) Parameters: * **reportId** (*string*) -- **[REQUIRED]** Unique resource ID for the report resource. * **reportVersion** (*integer*) -- Version for the report resource. * **termToken** (*string*) -- **[REQUIRED]** Unique download token provided by GetTermForReport API. Return type: dict Returns: **Response Syntax** { 'documentPresignedUrl': 'string' } **Response Structure** * *(dict) --* * **documentPresignedUrl** *(string) --* Presigned S3 url to access the report content. **Exceptions** * "Artifact.Client.exceptions.ResourceNotFoundException" * "Artifact.Client.exceptions.ThrottlingException" * "Artifact.Client.exceptions.AccessDeniedException" * "Artifact.Client.exceptions.ConflictException" * "Artifact.Client.exceptions.InternalServerException" * "Artifact.Client.exceptions.ValidationException" * "Artifact.Client.exceptions.ServiceQuotaExceededException" Artifact / Client / get_paginator get_paginator ************* Artifact.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. Artifact / Client / can_paginate can_paginate ************ Artifact.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. Artifact / Client / put_account_settings put_account_settings ******************** Artifact.Client.put_account_settings(**kwargs) Put the account settings for Artifact. See also: AWS API Documentation **Request Syntax** response = client.put_account_settings( notificationSubscriptionStatus='SUBSCRIBED'|'NOT_SUBSCRIBED' ) Parameters: **notificationSubscriptionStatus** (*string*) -- Desired notification subscription status. Return type: dict Returns: **Response Syntax** { 'accountSettings': { 'notificationSubscriptionStatus': 'SUBSCRIBED'|'NOT_SUBSCRIBED' } } **Response Structure** * *(dict) --* * **accountSettings** *(dict) --* Account settings for the customer. * **notificationSubscriptionStatus** *(string) --* Notification subscription status of the customer. **Exceptions** * "Artifact.Client.exceptions.ResourceNotFoundException" * "Artifact.Client.exceptions.ThrottlingException" * "Artifact.Client.exceptions.AccessDeniedException" * "Artifact.Client.exceptions.ConflictException" * "Artifact.Client.exceptions.InternalServerException" * "Artifact.Client.exceptions.ValidationException" * "Artifact.Client.exceptions.ServiceQuotaExceededException" Artifact / Client / list_reports list_reports ************ Artifact.Client.list_reports(**kwargs) List available reports. See also: AWS API Documentation **Request Syntax** response = client.list_reports( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- Maximum number of resources to return in the paginated response. * **nextToken** (*string*) -- Pagination token to request the next page of resources. Return type: dict Returns: **Response Syntax** { 'reports': [ { 'id': 'string', 'name': 'string', 'state': 'PUBLISHED'|'UNPUBLISHED', 'arn': 'string', 'version': 123, 'uploadState': 'PROCESSING'|'COMPLETE'|'FAILED'|'FAULT', 'description': 'string', 'periodStart': datetime(2015, 1, 1), 'periodEnd': datetime(2015, 1, 1), 'series': 'string', 'category': 'string', 'companyName': 'string', 'productName': 'string', 'statusMessage': 'string', 'acceptanceType': 'PASSTHROUGH'|'EXPLICIT' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **reports** *(list) --* List of report resources. * *(dict) --* Summary for report resource. * **id** *(string) --* Unique resource ID for the report resource. * **name** *(string) --* Name for the report resource. * **state** *(string) --* Current state of the report resource. * **arn** *(string) --* ARN for the report resource. * **version** *(integer) --* Version for the report resource. * **uploadState** *(string) --* The current state of the document upload. * **description** *(string) --* Description for the report resource. * **periodStart** *(datetime) --* Timestamp indicating the report resource effective start. * **periodEnd** *(datetime) --* Timestamp indicating the report resource effective end. * **series** *(string) --* Series for the report resource. * **category** *(string) --* Category for the report resource. * **companyName** *(string) --* Associated company name for the report resource. * **productName** *(string) --* Associated product name for the report resource. * **statusMessage** *(string) --* The message associated with the current upload state. * **acceptanceType** *(string) --* Acceptance type for report. * **nextToken** *(string) --* Pagination token to request the next page of resources. **Exceptions** * "Artifact.Client.exceptions.ResourceNotFoundException" * "Artifact.Client.exceptions.ThrottlingException" * "Artifact.Client.exceptions.AccessDeniedException" * "Artifact.Client.exceptions.InternalServerException" * "Artifact.Client.exceptions.ValidationException" * "Artifact.Client.exceptions.ServiceQuotaExceededException" Artifact / Client / get_account_settings get_account_settings ******************** Artifact.Client.get_account_settings() Get the account settings for Artifact. See also: AWS API Documentation **Request Syntax** response = client.get_account_settings() Return type: dict Returns: **Response Syntax** { 'accountSettings': { 'notificationSubscriptionStatus': 'SUBSCRIBED'|'NOT_SUBSCRIBED' } } **Response Structure** * *(dict) --* * **accountSettings** *(dict) --* Account settings for the customer. * **notificationSubscriptionStatus** *(string) --* Notification subscription status of the customer. **Exceptions** * "Artifact.Client.exceptions.ResourceNotFoundException" * "Artifact.Client.exceptions.ThrottlingException" * "Artifact.Client.exceptions.AccessDeniedException" * "Artifact.Client.exceptions.ConflictException" * "Artifact.Client.exceptions.InternalServerException" * "Artifact.Client.exceptions.ValidationException" * "Artifact.Client.exceptions.ServiceQuotaExceededException" Artifact / Client / list_customer_agreements list_customer_agreements ************************ Artifact.Client.list_customer_agreements(**kwargs) List active customer-agreements applicable to calling identity. See also: AWS API Documentation **Request Syntax** response = client.list_customer_agreements( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- Maximum number of resources to return in the paginated response. * **nextToken** (*string*) -- Pagination token to request the next page of resources. Return type: dict Returns: **Response Syntax** { 'customerAgreements': [ { 'name': 'string', 'arn': 'string', 'id': 'string', 'agreementArn': 'string', 'awsAccountId': 'string', 'organizationArn': 'string', 'effectiveStart': datetime(2015, 1, 1), 'effectiveEnd': datetime(2015, 1, 1), 'state': 'ACTIVE'|'CUSTOMER_TERMINATED'|'AWS_TERMINATED', 'description': 'string', 'acceptanceTerms': [ 'string', ], 'terminateTerms': [ 'string', ], 'type': 'CUSTOM'|'DEFAULT'|'MODIFIED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **customerAgreements** *(list) --* List of customer-agreement resources. * *(dict) --* Summary for customer-agreement resource. * **name** *(string) --* Name of the customer-agreement resource. * **arn** *(string) --* ARN of the customer-agreement resource. * **id** *(string) --* Identifier of the customer-agreement resource. * **agreementArn** *(string) --* ARN of the agreement resource the customer-agreement resource represents. * **awsAccountId** *(string) --* AWS account Id that owns the resource. * **organizationArn** *(string) --* ARN of the organization that owns the resource. * **effectiveStart** *(datetime) --* Timestamp indicating when the agreement became effective. * **effectiveEnd** *(datetime) --* Timestamp indicating when the agreement was terminated. * **state** *(string) --* State of the resource. * **description** *(string) --* Description of the resource. * **acceptanceTerms** *(list) --* Terms required to accept the agreement resource. * *(string) --* * **terminateTerms** *(list) --* Terms required to terminate the customer-agreement resource. * *(string) --* * **type** *(string) --* Type of the customer-agreement resource. * **nextToken** *(string) --* Pagination token to request the next page of resources. **Exceptions** * "Artifact.Client.exceptions.ThrottlingException" * "Artifact.Client.exceptions.AccessDeniedException" * "Artifact.Client.exceptions.InternalServerException" * "Artifact.Client.exceptions.ValidationException" Artifact / Client / get_report_metadata get_report_metadata ******************* Artifact.Client.get_report_metadata(**kwargs) Get the metadata for a single report. See also: AWS API Documentation **Request Syntax** response = client.get_report_metadata( reportId='string', reportVersion=123 ) Parameters: * **reportId** (*string*) -- **[REQUIRED]** Unique resource ID for the report resource. * **reportVersion** (*integer*) -- Version for the report resource. Return type: dict Returns: **Response Syntax** { 'reportDetails': { 'id': 'string', 'name': 'string', 'description': 'string', 'periodStart': datetime(2015, 1, 1), 'periodEnd': datetime(2015, 1, 1), 'createdAt': datetime(2015, 1, 1), 'lastModifiedAt': datetime(2015, 1, 1), 'deletedAt': datetime(2015, 1, 1), 'state': 'PUBLISHED'|'UNPUBLISHED', 'arn': 'string', 'series': 'string', 'category': 'string', 'companyName': 'string', 'productName': 'string', 'termArn': 'string', 'version': 123, 'acceptanceType': 'PASSTHROUGH'|'EXPLICIT', 'sequenceNumber': 123, 'uploadState': 'PROCESSING'|'COMPLETE'|'FAILED'|'FAULT', 'statusMessage': 'string' } } **Response Structure** * *(dict) --* * **reportDetails** *(dict) --* Report resource detail. * **id** *(string) --* Unique resource ID for the report resource. * **name** *(string) --* Name for the report resource. * **description** *(string) --* Description for the report resource. * **periodStart** *(datetime) --* Timestamp indicating the report resource effective start. * **periodEnd** *(datetime) --* Timestamp indicating the report resource effective end. * **createdAt** *(datetime) --* Timestamp indicating when the report resource was created. * **lastModifiedAt** *(datetime) --* Timestamp indicating when the report resource was last modified. * **deletedAt** *(datetime) --* Timestamp indicating when the report resource was deleted. * **state** *(string) --* Current state of the report resource * **arn** *(string) --* ARN for the report resource. * **series** *(string) --* Series for the report resource. * **category** *(string) --* Category for the report resource. * **companyName** *(string) --* Associated company name for the report resource. * **productName** *(string) --* Associated product name for the report resource. * **termArn** *(string) --* Unique resource ARN for term resource. * **version** *(integer) --* Version for the report resource. * **acceptanceType** *(string) --* Acceptance type for report. * **sequenceNumber** *(integer) --* Sequence number to enforce optimistic locking. * **uploadState** *(string) --* The current state of the document upload. * **statusMessage** *(string) --* The message associated with the current upload state. **Exceptions** * "Artifact.Client.exceptions.ResourceNotFoundException" * "Artifact.Client.exceptions.ThrottlingException" * "Artifact.Client.exceptions.AccessDeniedException" * "Artifact.Client.exceptions.InternalServerException" * "Artifact.Client.exceptions.ValidationException" * "Artifact.Client.exceptions.ServiceQuotaExceededException" Artifact / Client / get_term_for_report get_term_for_report ******************* Artifact.Client.get_term_for_report(**kwargs) Get the Term content associated with a single report. See also: AWS API Documentation **Request Syntax** response = client.get_term_for_report( reportId='string', reportVersion=123 ) Parameters: * **reportId** (*string*) -- **[REQUIRED]** Unique resource ID for the report resource. * **reportVersion** (*integer*) -- Version for the report resource. Return type: dict Returns: **Response Syntax** { 'documentPresignedUrl': 'string', 'termToken': 'string' } **Response Structure** * *(dict) --* * **documentPresignedUrl** *(string) --* Presigned S3 url to access the term content. * **termToken** *(string) --* Unique token representing this request event. **Exceptions** * "Artifact.Client.exceptions.ResourceNotFoundException" * "Artifact.Client.exceptions.ThrottlingException" * "Artifact.Client.exceptions.AccessDeniedException" * "Artifact.Client.exceptions.ConflictException" * "Artifact.Client.exceptions.InternalServerException" * "Artifact.Client.exceptions.ValidationException" * "Artifact.Client.exceptions.ServiceQuotaExceededException" Artifact / Client / get_waiter get_waiter ********** Artifact.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" Artifact / Client / close close ***** Artifact.Client.close() Closes underlying endpoint connections.