AWS Supply Chain

2024/10/14 - AWS Supply Chain - 5 new api methods

Changes  This release adds AWS Supply Chain instance management functionality. Specifically adding CreateInstance, DeleteInstance, GetInstance, ListInstances, and UpdateInstance APIs.

DeleteInstance (new) Link ¶

Delete the instance. This is an asynchronous operation. Upon receiving a DeleteInstance request, AWS Supply Chain immediately returns a response with the instance resource, delete state while cleaning up all Amazon Web Services resources created during the instance creation process. You can use the GetInstance action to check the instance status.

See also: AWS API Documentation

Request Syntax

client.delete_instance(
    instanceId='string'
)
type instanceId:

string

param instanceId:

[REQUIRED]

The AWS Supply Chain instance identifier.

rtype:

dict

returns:

Response Syntax

{
    'instance': {
        'instanceId': 'string',
        'awsAccountId': 'string',
        'state': 'Initializing'|'Active'|'CreateFailed'|'DeleteFailed'|'Deleting'|'Deleted',
        'webAppDnsDomain': 'string',
        'createdTime': datetime(2015, 1, 1),
        'lastModifiedTime': datetime(2015, 1, 1),
        'instanceName': 'string',
        'instanceDescription': 'string',
        'kmsKeyArn': 'string',
        'versionNumber': 123.0
    }
}

Response Structure

  • (dict) --

    The response parameters for DeleteInstance.

    • instance (dict) --

      The AWS Supply Chain instance resource data details.

      • instanceId (string) --

        The Amazon Web Services Supply Chain instance identifier.

      • awsAccountId (string) --

        The Amazon Web Services account ID that owns the instance.

      • state (string) --

        The state of the instance.

      • webAppDnsDomain (string) --

        The WebApp DNS domain name of the instance.

      • createdTime (datetime) --

        The instance creation timestamp.

      • lastModifiedTime (datetime) --

        The instance last modified timestamp.

      • instanceName (string) --

        The Amazon Web Services Supply Chain instance name.

      • instanceDescription (string) --

        The Amazon Web Services Supply Chain instance description.

      • kmsKeyArn (string) --

        The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key and nothing is returned.

      • versionNumber (float) --

        The version number of the instance.

GetInstance (new) Link ¶

Get the AWS Supply Chain instance details.

See also: AWS API Documentation

Request Syntax

client.get_instance(
    instanceId='string'
)
type instanceId:

string

param instanceId:

[REQUIRED]

The AWS Supply Chain instance identifier

rtype:

dict

returns:

Response Syntax

{
    'instance': {
        'instanceId': 'string',
        'awsAccountId': 'string',
        'state': 'Initializing'|'Active'|'CreateFailed'|'DeleteFailed'|'Deleting'|'Deleted',
        'webAppDnsDomain': 'string',
        'createdTime': datetime(2015, 1, 1),
        'lastModifiedTime': datetime(2015, 1, 1),
        'instanceName': 'string',
        'instanceDescription': 'string',
        'kmsKeyArn': 'string',
        'versionNumber': 123.0
    }
}

Response Structure

  • (dict) --

    The response parameters for GetInstance.

    • instance (dict) --

      The instance resource data details.

      • instanceId (string) --

        The Amazon Web Services Supply Chain instance identifier.

      • awsAccountId (string) --

        The Amazon Web Services account ID that owns the instance.

      • state (string) --

        The state of the instance.

      • webAppDnsDomain (string) --

        The WebApp DNS domain name of the instance.

      • createdTime (datetime) --

        The instance creation timestamp.

      • lastModifiedTime (datetime) --

        The instance last modified timestamp.

      • instanceName (string) --

        The Amazon Web Services Supply Chain instance name.

      • instanceDescription (string) --

        The Amazon Web Services Supply Chain instance description.

      • kmsKeyArn (string) --

        The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key and nothing is returned.

      • versionNumber (float) --

        The version number of the instance.

ListInstances (new) Link ¶

List all the AWS Supply Chain instances in a paginated way.

See also: AWS API Documentation

Request Syntax

client.list_instances(
    nextToken='string',
    maxResults=123,
    instanceNameFilter=[
        'string',
    ],
    instanceStateFilter=[
        'Initializing'|'Active'|'CreateFailed'|'DeleteFailed'|'Deleting'|'Deleted',
    ]
)
type nextToken:

string

param nextToken:

The pagination token to fetch the next page of instances.

type maxResults:

integer

param maxResults:

Specify the maximum number of instances to fetch in this paginated request.

type instanceNameFilter:

list

param instanceNameFilter:

The filter to ListInstances based on their names.

  • (string) --

type instanceStateFilter:

list

param instanceStateFilter:

The filter to ListInstances based on their state.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'instances': [
        {
            'instanceId': 'string',
            'awsAccountId': 'string',
            'state': 'Initializing'|'Active'|'CreateFailed'|'DeleteFailed'|'Deleting'|'Deleted',
            'webAppDnsDomain': 'string',
            'createdTime': datetime(2015, 1, 1),
            'lastModifiedTime': datetime(2015, 1, 1),
            'instanceName': 'string',
            'instanceDescription': 'string',
            'kmsKeyArn': 'string',
            'versionNumber': 123.0
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    The response parameters for ListInstances.

    • instances (list) --

      The list of instances resource data details.

      • (dict) --

        The details of the instance.

        • instanceId (string) --

          The Amazon Web Services Supply Chain instance identifier.

        • awsAccountId (string) --

          The Amazon Web Services account ID that owns the instance.

        • state (string) --

          The state of the instance.

        • webAppDnsDomain (string) --

          The WebApp DNS domain name of the instance.

        • createdTime (datetime) --

          The instance creation timestamp.

        • lastModifiedTime (datetime) --

          The instance last modified timestamp.

        • instanceName (string) --

          The Amazon Web Services Supply Chain instance name.

        • instanceDescription (string) --

          The Amazon Web Services Supply Chain instance description.

        • kmsKeyArn (string) --

          The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key and nothing is returned.

        • versionNumber (float) --

          The version number of the instance.

    • nextToken (string) --

      The pagination token to fetch the next page of instances.

UpdateInstance (new) Link ¶

Update the instance.

See also: AWS API Documentation

Request Syntax

client.update_instance(
    instanceId='string',
    instanceName='string',
    instanceDescription='string'
)
type instanceId:

string

param instanceId:

[REQUIRED]

The AWS Supply Chain instance identifier.

type instanceName:

string

param instanceName:

The AWS Supply Chain instance name.

type instanceDescription:

string

param instanceDescription:

The AWS Supply Chain instance description.

rtype:

dict

returns:

Response Syntax

{
    'instance': {
        'instanceId': 'string',
        'awsAccountId': 'string',
        'state': 'Initializing'|'Active'|'CreateFailed'|'DeleteFailed'|'Deleting'|'Deleted',
        'webAppDnsDomain': 'string',
        'createdTime': datetime(2015, 1, 1),
        'lastModifiedTime': datetime(2015, 1, 1),
        'instanceName': 'string',
        'instanceDescription': 'string',
        'kmsKeyArn': 'string',
        'versionNumber': 123.0
    }
}

Response Structure

  • (dict) --

    The response parameters for UpdateInstance.

    • instance (dict) --

      The instance resource data details.

      • instanceId (string) --

        The Amazon Web Services Supply Chain instance identifier.

      • awsAccountId (string) --

        The Amazon Web Services account ID that owns the instance.

      • state (string) --

        The state of the instance.

      • webAppDnsDomain (string) --

        The WebApp DNS domain name of the instance.

      • createdTime (datetime) --

        The instance creation timestamp.

      • lastModifiedTime (datetime) --

        The instance last modified timestamp.

      • instanceName (string) --

        The Amazon Web Services Supply Chain instance name.

      • instanceDescription (string) --

        The Amazon Web Services Supply Chain instance description.

      • kmsKeyArn (string) --

        The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key and nothing is returned.

      • versionNumber (float) --

        The version number of the instance.

CreateInstance (new) Link ¶

Create a new instance for AWS Supply Chain. This is an asynchronous operation. Upon receiving a CreateInstance request, AWS Supply Chain immediately returns the instance resource, with instance ID, and the initializing state while simultaneously creating all required Amazon Web Services resources for an instance creation. You can use GetInstance to check the status of the instance.

See also: AWS API Documentation

Request Syntax

client.create_instance(
    instanceName='string',
    instanceDescription='string',
    kmsKeyArn='string',
    tags={
        'string': 'string'
    },
    clientToken='string'
)
type instanceName:

string

param instanceName:

The AWS Supply Chain instance name.

type instanceDescription:

string

param instanceDescription:

The AWS Supply Chain instance description.

type kmsKeyArn:

string

param kmsKeyArn:

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon Web Services owned KMS key. If you don't provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key.

type tags:

dict

param tags:

The Amazon Web Services tags of an instance to be created.

  • (string) --

    • (string) --

type clientToken:

string

param clientToken:

The client token for idempotency.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'instance': {
        'instanceId': 'string',
        'awsAccountId': 'string',
        'state': 'Initializing'|'Active'|'CreateFailed'|'DeleteFailed'|'Deleting'|'Deleted',
        'webAppDnsDomain': 'string',
        'createdTime': datetime(2015, 1, 1),
        'lastModifiedTime': datetime(2015, 1, 1),
        'instanceName': 'string',
        'instanceDescription': 'string',
        'kmsKeyArn': 'string',
        'versionNumber': 123.0
    }
}

Response Structure

  • (dict) --

    The response parameters for CreateInstance.

    • instance (dict) --

      The AWS Supply Chain instance resource data details.

      • instanceId (string) --

        The Amazon Web Services Supply Chain instance identifier.

      • awsAccountId (string) --

        The Amazon Web Services account ID that owns the instance.

      • state (string) --

        The state of the instance.

      • webAppDnsDomain (string) --

        The WebApp DNS domain name of the instance.

      • createdTime (datetime) --

        The instance creation timestamp.

      • lastModifiedTime (datetime) --

        The instance last modified timestamp.

      • instanceName (string) --

        The Amazon Web Services Supply Chain instance name.

      • instanceDescription (string) --

        The Amazon Web Services Supply Chain instance description.

      • kmsKeyArn (string) --

        The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key and nothing is returned.

      • versionNumber (float) --

        The version number of the instance.