AWS API Changes

2016/09/13 - AWS Service Catalog - 2 updated api methods

Changes Updates the API for AWS.ServiceCatalog.

ListRecordHistory (updated)

Link ¶
Changes (request)

{'AccessLevelFilter': {'Key': 'Account | Role | User', 'Value': 'string'}}

Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.

Request Syntax

client.list_record_history(
    AcceptLanguage='string',
    AccessLevelFilter={
        'Key': 'Account'|'Role'|'User',
        'Value': 'string'
    },
    SearchFilter={
        'Key': 'string',
        'Value': 'string'
    },
    PageSize=123,
    PageToken='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type AccessLevelFilter

dict

param AccessLevelFilter

The access level for obtaining results. If left unspecified, User level access is used.

Key (string) --

Specifies the access level.

Account allows results at the account level.

Role allows results based on the federated role of the specified user.

User allows results limited to the specified user.
Value (string) --

Specifies the user to which the access level applies. A value of Self is currently supported.

type SearchFilter

dict

param SearchFilter

The filter to limit search results.

Key (string) --

The filter key.
Value (string) --

The filter value for Key .

type PageSize

integer

param PageSize

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize , the value of NextPageToken in the response is non-null.

type PageToken

string

param PageToken

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize .

rtype

dict

returns

Response Syntax

{
    'RecordDetails': [
        {
            'RecordId': 'string',
            'ProvisionedProductName': 'string',
            'Status': 'IN_PROGRESS'|'SUCCEEDED'|'ERROR',
            'CreatedTime': datetime(2015, 1, 1),
            'UpdatedTime': datetime(2015, 1, 1),
            'ProvisionedProductType': 'string',
            'RecordType': 'string',
            'ProvisionedProductId': 'string',
            'ProductId': 'string',
            'ProvisioningArtifactId': 'string',
            'PathId': 'string',
            'RecordErrors': [
                {
                    'Code': 'string',
                    'Description': 'string'
                },
            ],
            'RecordTags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

(dict) --
- RecordDetails (list) --
  
  A list of record detail objects, listed in reverse chronological order.
  - (dict) --
    
    The full details of a specific ProvisionedProduct object.
    - RecordId (string) --
      
      The identifier of the ProvisionedProduct object record.
    - ProvisionedProductName (string) --
      
      The user-friendly name of the ProvisionedProduct object.
    - Status (string) --
      
      The status of the ProvisionedProduct object.
    - CreatedTime (datetime) --
      
      The time when the record for the ProvisionedProduct object was created.
    - UpdatedTime (datetime) --
      
      The time when the record for the ProvisionedProduct object was last updated.
    - ProvisionedProductType (string) --
      
      The type of the ProvisionedProduct object.
    - RecordType (string) --
      
      The record type for this record.
    - ProvisionedProductId (string) --
      
      The identifier of the ProvisionedProduct object.
    - ProductId (string) --
      
      The identifier of the product.
    - ProvisioningArtifactId (string) --
      
      The provisioning artifact identifier for this product.
    - PathId (string) --
      
      The identifier of the path for this product's provisioning.
    - RecordErrors (list) --
      
      A list of errors that occurred while processing the request.
      - (dict) --
        
        The error code and description resulting from an operation.
        
        Code (string) --
        
        The numeric value of the error.
        
        Description (string) --
        
        The text description of the error.
    - RecordTags (list) --
      
      List of tags associated with this record.
      - (dict) --
        
        A tag associated with the record, stored as a key-value pair.
        
        Key (string) --
        
        The key for this tag.
        
        Value (string) --
        
        The value for this tag.
- NextPageToken (string) --
  
  The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

ScanProvisionedProducts (updated)

Link ¶
Changes (request)

{'AccessLevelFilter': {'Key': 'Account | Role | User', 'Value': 'string'}}

Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).

Request Syntax

client.scan_provisioned_products(
    AcceptLanguage='string',
    AccessLevelFilter={
        'Key': 'Account'|'Role'|'User',
        'Value': 'string'
    },
    PageSize=123,
    PageToken='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type AccessLevelFilter

dict

param AccessLevelFilter

The access level for obtaining results. If left unspecified, User level access is used.

Key (string) --

Specifies the access level.

Account allows results at the account level.

Role allows results based on the federated role of the specified user.

User allows results limited to the specified user.
Value (string) --

Specifies the user to which the access level applies. A value of Self is currently supported.

type PageSize

integer

param PageSize

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize , the value of NextPageToken in the response is non-null.

type PageToken

string

param PageToken

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize .

rtype

dict

returns

Response Syntax

{
    'ProvisionedProducts': [
        {
            'Name': 'string',
            'Arn': 'string',
            'Type': 'string',
            'Id': 'string',
            'Status': 'IN_PROGRESS'|'SUCCEEDED'|'ERROR',
            'StatusMessage': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'IdempotencyToken': 'string',
            'LastRecordId': 'string'
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

(dict) --
- ProvisionedProducts (list) --
  
  A list of ProvisionedProduct detail objects.
  - (dict) --
    
    Detailed information about a ProvisionedProduct object.
    - Name (string) --
      
      The user-friendly name of the ProvisionedProduct object.
    - Arn (string) --
      
      The ARN associated with the ProvisionedProduct object.
    - Type (string) --
      
      The type of the ProvisionedProduct object.
    - Id (string) --
      
      The identifier of the ProvisionedProduct object.
    - Status (string) --
      
      The current status of the ProvisionedProduct.
    - StatusMessage (string) --
      
      The current status message of the ProvisionedProduct.
    - CreatedTime (datetime) --
      
      The time the ProvisionedProduct was created.
    - IdempotencyToken (string) --
      
      An idempotency token that uniquely identifies this ProvisionedProduct.
    - LastRecordId (string) --
      
      The record identifier of the last request performed on this ProvisionedProduct object.
- NextPageToken (string) --
  
  The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.