AWS API Changes

2024/02/15 - AWS Artifact - 6 new api methods

Changes This is the initial SDK release for AWS Artifact. AWS Artifact provides on-demand access to compliance and third-party compliance reports. This release includes access to List and Get reports, along with their metadata. This release also includes access to AWS Artifact notifications settings.

GetReportMetadata (new)

Link ¶

Get the metadata for a single report.

See also: AWS API Documentation

Request Syntax

client.get_report_metadata(
    reportId='string',
    reportVersion=123
)

type reportId

string

param reportId

[REQUIRED]

Unique resource ID for the report resource.

type reportVersion

integer

param reportVersion

Version for the report resource.

rtype

dict

returns

Response Syntax

{
    'reportDetails': {
        'acceptanceType': 'PASSTHROUGH'|'EXPLICIT',
        'arn': 'string',
        'category': 'string',
        'companyName': 'string',
        'createdAt': datetime(2015, 1, 1),
        'deletedAt': datetime(2015, 1, 1),
        'description': 'string',
        'id': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'periodEnd': datetime(2015, 1, 1),
        'periodStart': datetime(2015, 1, 1),
        'productName': 'string',
        'sequenceNumber': 123,
        'series': 'string',
        'state': 'PUBLISHED'|'UNPUBLISHED',
        'statusMessage': 'string',
        'termArn': 'string',
        'uploadState': 'PROCESSING'|'COMPLETE'|'FAILED'|'FAULT',
        'version': 123
    }
}

Response Structure

(dict) --
- reportDetails (dict) --
  
  Report resource detail.
  - acceptanceType (string) --
    
    Acceptance type for report.
  - arn (string) --
    
    ARN for the report resource.
  - category (string) --
    
    Category for the report resource.
  - companyName (string) --
    
    Associated company name for the report resource.
  - createdAt (datetime) --
    
    Timestamp indicating when the report resource was created.
  - deletedAt (datetime) --
    
    Timestamp indicating when the report resource was deleted.
  - description (string) --
    
    Description for the report resource.
  - id (string) --
    
    Unique resource ID for the report resource.
  - lastModifiedAt (datetime) --
    
    Timestamp indicating when the report resource was last modified.
  - name (string) --
    
    Name for the report resource.
  - periodEnd (datetime) --
    
    Timestamp indicating the report resource effective end.
  - periodStart (datetime) --
    
    Timestamp indicating the report resource effective start.
  - productName (string) --
    
    Associated product name for the report resource.
  - sequenceNumber (integer) --
    
    Sequence number to enforce optimistic locking.
  - series (string) --
    
    Series for the report resource.
  - state (string) --
    
    Current state of the report resource
  - statusMessage (string) --
    
    The message associated with the current upload state.
  - termArn (string) --
    
    Unique resource ARN for term resource.
  - uploadState (string) --
    
    The current state of the document upload.
  - version (integer) --
    
    Version for the report resource.

PutAccountSettings (new)

Link ¶

Put the account settings for Artifact.

See also: AWS API Documentation

Request Syntax

client.put_account_settings(
    notificationSubscriptionStatus='SUBSCRIBED'|'NOT_SUBSCRIBED'
)

type notificationSubscriptionStatus

string

param notificationSubscriptionStatus

Desired notification subscription status.

rtype

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.

GetTermForReport (new)

Link ¶

Get the Term content associated with a single report.

See also: AWS API Documentation

Request Syntax

client.get_term_for_report(
    reportId='string',
    reportVersion=123
)

type reportId

string

param reportId

[REQUIRED]

Unique resource ID for the report resource.

type reportVersion

integer

param reportVersion

Version for the report resource.

rtype

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.

GetAccountSettings (new)

Link ¶

Get the account settings for Artifact.

See also: AWS API Documentation

Request Syntax

client.get_account_settings()

rtype

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.

ListReports (new)

Link ¶

List available reports.

See also: AWS API Documentation

Request Syntax

client.list_reports(
    maxResults=123,
    nextToken='string'
)

type maxResults

integer

param maxResults

Maximum number of resources to return in the paginated response.

type nextToken

string

param nextToken

Pagination token to request the next page of resources.

rtype

dict

returns

Response Syntax

{
    'nextToken': 'string',
    'reports': [
        {
            'arn': 'string',
            'category': 'string',
            'companyName': 'string',
            'description': 'string',
            'id': 'string',
            'name': 'string',
            'periodEnd': datetime(2015, 1, 1),
            'periodStart': datetime(2015, 1, 1),
            'productName': 'string',
            'series': 'string',
            'state': 'PUBLISHED'|'UNPUBLISHED',
            'statusMessage': 'string',
            'uploadState': 'PROCESSING'|'COMPLETE'|'FAILED'|'FAULT',
            'version': 123
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  Pagination token to request the next page of resources.
- reports (list) --
  
  List of report resources.
  - (dict) --
    
    Summary for report resource.
    - arn (string) --
      
      ARN for the report resource.
    - category (string) --
      
      Category for the report resource.
    - companyName (string) --
      
      Associated company name for the report resource.
    - description (string) --
      
      Description for the report resource.
    - id (string) --
      
      Unique resource ID for the report resource.
    - name (string) --
      
      Name for the report resource.
    - periodEnd (datetime) --
      
      Timestamp indicating the report resource effective end.
    - periodStart (datetime) --
      
      Timestamp indicating the report resource effective start.
    - productName (string) --
      
      Associated product name for the report resource.
    - series (string) --
      
      Series for the report resource.
    - state (string) --
      
      Current state of the report resource.
    - statusMessage (string) --
      
      The message associated with the current upload state.
    - uploadState (string) --
      
      The current state of the document upload.
    - version (integer) --
      
      Version for the report resource.

GetReport (new)

Link ¶

Get the content for a single report.

See also: AWS API Documentation

Request Syntax

client.get_report(
    reportId='string',
    reportVersion=123,
    termToken='string'
)

type reportId

string

param reportId

[REQUIRED]

Unique resource ID for the report resource.

type reportVersion

integer

param reportVersion

Version for the report resource.

type termToken

string

param termToken

[REQUIRED]

Unique download token provided by GetTermForReport API.

rtype

dict

returns

Response Syntax

{
    'documentPresignedUrl': 'string'
}

Response Structure

(dict) --
- documentPresignedUrl (string) --
  
  Presigned S3 url to access the report content.