SupplyChain / Client / update_instance

update_instance#

SupplyChain.Client.update_instance(**kwargs)#

Enables you to programmatically update an Amazon Web Services Supply Chain instance description by providing all the relevant information such as account ID, instance ID and so on without using the AWS console.

See also: AWS API Documentation

Request Syntax

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

  • instanceId (string) –

    [REQUIRED]

    The AWS Supply Chain instance identifier.

  • instanceName (string) – The AWS Supply Chain instance name.

  • instanceDescription (string) – The AWS Supply Chain instance description.

Return type:

dict

Returns:

Response Syntax

{
    'instance': {
        'instanceId': 'string',
        'awsAccountId': 'string',
        'state': 'Initializing'|'Active'|'CreateFailed'|'DeleteFailed'|'Deleting'|'Deleted',
        'errorMessage': 'string',
        '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.

      • errorMessage (string) –

        The Amazon Web Services Supply Chain instance error message. If the instance results in an unhealthy state, customers need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.

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

Exceptions