AWS API Changes

2021/10/20 - AWS Panorama - 33 new api methods

Changes General availability for AWS Panorama. AWS SDK for Panorama includes APIs to manage your devices and nodes, and deploy computer vision applications to the edge. For more information, see the AWS Panorama documentation at http://docs.aws.amazon.com/panorama

CreatePackage (new)

Link ¶

Creates a package and storage location in an Amazon S3 access point.

See also: AWS API Documentation

Request Syntax

client.create_package(
    PackageName='string',
    Tags={
        'string': 'string'
    }
)

type PackageName

string

param PackageName

[REQUIRED]

A name for the package.

type Tags

dict

param Tags

Tags for the package.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'PackageId': 'string',
    'Arn': 'string',
    'StorageLocation': {
        'Bucket': 'string',
        'RepoPrefixLocation': 'string',
        'GeneratedPrefixLocation': 'string',
        'BinaryPrefixLocation': 'string',
        'ManifestPrefixLocation': 'string'
    }
}

Response Structure

(dict) --
- PackageId (string) --
  
  The package's ID.
- Arn (string) --
  
  The package's ARN.
- StorageLocation (dict) --
  
  The package's storage location.
  - Bucket (string) --
    
    The location's bucket.
  - RepoPrefixLocation (string) --
    
    The location's repo prefix.
  - GeneratedPrefixLocation (string) --
    
    The location's generated prefix.
  - BinaryPrefixLocation (string) --
    
    The location's binary prefix.
  - ManifestPrefixLocation (string) --
    
    The location's manifest prefix.

ListNodes (new)

Link ¶

Returns a list of nodes.

See also: AWS API Documentation

Request Syntax

client.list_nodes(
    Category='BUSINESS_LOGIC'|'ML_MODEL'|'MEDIA_SOURCE'|'MEDIA_SINK',
    OwnerAccount='string',
    PackageName='string',
    PackageVersion='string',
    PatchVersion='string',
    NextToken='string',
    MaxResults=123
)

type Category

string

param Category

Search for nodes by category.

type OwnerAccount

string

param OwnerAccount

Search for nodes by the account ID of the nodes' owner.

type PackageName

string

param PackageName

Search for nodes by name.

type PackageVersion

string

param PackageVersion

Search for nodes by version.

type PatchVersion

string

param PatchVersion

Search for nodes by patch version.

type NextToken

string

param NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of nodes to return in one page of results.

rtype

dict

returns

Response Syntax

{
    'Nodes': [
        {
            'NodeId': 'string',
            'Name': 'string',
            'Category': 'BUSINESS_LOGIC'|'ML_MODEL'|'MEDIA_SOURCE'|'MEDIA_SINK',
            'OwnerAccount': 'string',
            'PackageName': 'string',
            'PackageId': 'string',
            'PackageArn': 'string',
            'PackageVersion': 'string',
            'PatchVersion': 'string',
            'Description': 'string',
            'CreatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Nodes (list) --
  
  A list of nodes.
  - (dict) --
    
    An application node that represents a camera stream, a model, code, or output.
    - NodeId (string) --
      
      The node's ID.
    - Name (string) --
      
      The node's name.
    - Category (string) --
      
      The node's category.
    - OwnerAccount (string) --
      
      The account ID of the node's owner.
    - PackageName (string) --
      
      The node's package name.
    - PackageId (string) --
      
      The node's package ID.
    - PackageArn (string) --
      
      The node's ARN.
    - PackageVersion (string) --
      
      The node's package version.
    - PatchVersion (string) --
      
      The node's patch version.
    - Description (string) --
      
      The node's description.
    - CreatedTime (datetime) --
      
      When the node was created.
- NextToken (string) --
  
  A pagination token that's included if more results are available.

DescribeDeviceJob (new)

Link ¶

Returns information about a device job.

See also: AWS API Documentation

Request Syntax

client.describe_device_job(
    JobId='string'
)

type JobId

string

param JobId

[REQUIRED]

The job's ID.

rtype

dict

returns

Response Syntax

{
    'JobId': 'string',
    'DeviceId': 'string',
    'DeviceArn': 'string',
    'DeviceName': 'string',
    'DeviceType': 'PANORAMA_APPLIANCE_DEVELOPER_KIT'|'PANORAMA_APPLIANCE',
    'ImageVersion': 'string',
    'Status': 'PENDING'|'IN_PROGRESS'|'VERIFYING'|'REBOOTING'|'DOWNLOADING'|'COMPLETED'|'FAILED',
    'CreatedTime': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- JobId (string) --
  
  The job's ID.
- DeviceId (string) --
  
  The device's ID.
- DeviceArn (string) --
  
  The device's ARN.
- DeviceName (string) --
  
  The device's name.
- DeviceType (string) --
  
  The device's type.
- ImageVersion (string) --
  
  For an OTA job, the target version of the device software.
- Status (string) --
  
  The job's status.
- CreatedTime (datetime) --
  
  When the job was created.

DescribePackageImportJob (new)

Link ¶

Returns information about a package import job.

See also: AWS API Documentation

Request Syntax

client.describe_package_import_job(
    JobId='string'
)

type JobId

string

param JobId

[REQUIRED]

The job's ID.

rtype

dict

returns

Response Syntax

{
    'JobId': 'string',
    'ClientToken': 'string',
    'JobType': 'NODE_PACKAGE_VERSION',
    'InputConfig': {
        'PackageVersionInputConfig': {
            'S3Location': {
                'Region': 'string',
                'BucketName': 'string',
                'ObjectKey': 'string'
            }
        }
    },
    'OutputConfig': {
        'PackageVersionOutputConfig': {
            'PackageName': 'string',
            'PackageVersion': 'string',
            'MarkLatest': True|False
        }
    },
    'Output': {
        'PackageId': 'string',
        'PackageVersion': 'string',
        'PatchVersion': 'string',
        'OutputS3Location': {
            'BucketName': 'string',
            'ObjectKey': 'string'
        }
    },
    'CreatedTime': datetime(2015, 1, 1),
    'LastUpdatedTime': datetime(2015, 1, 1),
    'Status': 'PENDING'|'SUCCEEDED'|'FAILED',
    'StatusMessage': 'string',
    'JobTags': [
        {
            'ResourceType': 'PACKAGE',
            'Tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

(dict) --
- JobId (string) --
  
  The job's ID.
- ClientToken (string) --
  
  The job's client token.
- JobType (string) --
  
  The job's type.
- InputConfig (dict) --
  
  The job's input config.
  - PackageVersionInputConfig (dict) --
    
    The package version's input configuration.
    - S3Location (dict) --
      
      A location in Amazon S3.
      - Region (string) --
        
        The bucket's Region.
      - BucketName (string) --
        
        A bucket name.
      - ObjectKey (string) --
        
        An object key.
- OutputConfig (dict) --
  
  The job's output config.
  - PackageVersionOutputConfig (dict) --
    
    The package version's output configuration.
    - PackageName (string) --
      
      The output's package name.
    - PackageVersion (string) --
      
      The output's package version.
    - MarkLatest (boolean) --
      
      Indicates that the version is recommended for all users.
- Output (dict) --
  
  The job's output.
  - PackageId (string) --
    
    The package's ID.
  - PackageVersion (string) --
    
    The package's version.
  - PatchVersion (string) --
    
    The package's patch version.
  - OutputS3Location (dict) --
    
    The package's output location.
    - BucketName (string) --
      
      The object's bucket.
    - ObjectKey (string) --
      
      The object's key.
- CreatedTime (datetime) --
  
  When the job was created.
- LastUpdatedTime (datetime) --
  
  When the job was updated.
- Status (string) --
  
  The job's status.
- StatusMessage (string) --
  
  The job's status message.
- JobTags (list) --
  
  The job's tags.
  - (dict) --
    
    Tags for a job.
    - ResourceType (string) --
      
      The job's type.
    - Tags (dict) --
      
      The job's tags.
      - (string) --
        
        (string) --

ProvisionDevice (new)

Link ¶

Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Transfer the configuration archive to the device with the included USB storage device within 5 minutes.

See also: AWS API Documentation

Request Syntax

client.provision_device(
    Name='string',
    Description='string',
    Tags={
        'string': 'string'
    },
    NetworkingConfiguration={
        'Ethernet0': {
            'ConnectionType': 'STATIC_IP'|'DHCP',
            'StaticIpConnectionInfo': {
                'IpAddress': 'string',
                'Mask': 'string',
                'Dns': [
                    'string',
                ],
                'DefaultGateway': 'string'
            }
        },
        'Ethernet1': {
            'ConnectionType': 'STATIC_IP'|'DHCP',
            'StaticIpConnectionInfo': {
                'IpAddress': 'string',
                'Mask': 'string',
                'Dns': [
                    'string',
                ],
                'DefaultGateway': 'string'
            }
        }
    }
)

type Name

string

param Name

[REQUIRED]

A name for the device.

type Description

string

param Description

A description for the device.

type Tags

dict

param Tags

Tags for the device.

(string) --
- (string) --

type NetworkingConfiguration

dict

param NetworkingConfiguration

A networking configuration for the device.

Ethernet0 (dict) --

Settings for Ethernet port 0.
- ConnectionType (string) -- [REQUIRED]
  
  How the device gets an IP address.
- StaticIpConnectionInfo (dict) --
  
  Network configuration for a static IP connection.
  - IpAddress (string) -- [REQUIRED]
    
    The connection's IP address.
  - Mask (string) -- [REQUIRED]
    
    The connection's DNS mask.
  - Dns (list) -- [REQUIRED]
    
    The connection's DNS address.
    - (string) --
  - DefaultGateway (string) -- [REQUIRED]
    
    The connection's default gateway.
Ethernet1 (dict) --

Settings for Ethernet port 1.
- ConnectionType (string) -- [REQUIRED]
  
  How the device gets an IP address.
- StaticIpConnectionInfo (dict) --
  
  Network configuration for a static IP connection.
  - IpAddress (string) -- [REQUIRED]
    
    The connection's IP address.
  - Mask (string) -- [REQUIRED]
    
    The connection's DNS mask.
  - Dns (list) -- [REQUIRED]
    
    The connection's DNS address.
    - (string) --
  - DefaultGateway (string) -- [REQUIRED]
    
    The connection's default gateway.

rtype

dict

returns

Response Syntax

{
    'DeviceId': 'string',
    'Arn': 'string',
    'Status': 'AWAITING_PROVISIONING'|'PENDING'|'SUCCEEDED'|'FAILED'|'ERROR'|'DELETING',
    'Certificates': b'bytes',
    'IotThingName': 'string'
}

Response Structure

(dict) --
- DeviceId (string) --
  
  The device's ID.
- Arn (string) --
  
  The device's ARN.
- Status (string) --
  
  The device's status.
- Certificates (bytes) --
  
  The device's configuration bundle.
- IotThingName (string) --
  
  The device's IoT thing name.

ListDevices (new)

Link ¶

Returns a list of devices.

See also: AWS API Documentation

Request Syntax

client.list_devices(
    NextToken='string',
    MaxResults=123
)

type NextToken

string

param NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of devices to return in one page of results.

rtype

dict

returns

Response Syntax

{
    'Devices': [
        {
            'DeviceId': 'string',
            'Name': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'ProvisioningStatus': 'AWAITING_PROVISIONING'|'PENDING'|'SUCCEEDED'|'FAILED'|'ERROR'|'DELETING',
            'LastUpdatedTime': datetime(2015, 1, 1),
            'LeaseExpirationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Devices (list) --
  
  A list of devices.
  - (dict) --
    
    A device.
    - DeviceId (string) --
      
      The device's ID.
    - Name (string) --
      
      The device's name.
    - CreatedTime (datetime) --
      
      When the device was created.
    - ProvisioningStatus (string) --
      
      The device's provisioning status.
    - LastUpdatedTime (datetime) --
      
      When the device was updated.
    - LeaseExpirationTime (datetime) --
      
      The device's lease expiration time.
- NextToken (string) --
  
  A pagination token that's included if more results are available.

UpdateDeviceMetadata (new)

Link ¶

Updates a device's metadata.

See also: AWS API Documentation

Request Syntax

client.update_device_metadata(
    DeviceId='string',
    Description='string'
)

type DeviceId

string

param DeviceId

[REQUIRED]

The device's ID.

type Description

string

param Description

A description for the device.

rtype

dict

returns

Response Syntax

{
    'DeviceId': 'string'
}

Response Structure

(dict) --
- DeviceId (string) --
  
  The device's ID.

ListNodeFromTemplateJobs (new)

Link ¶

Returns a list of camera stream node jobs.

See also: AWS API Documentation

Request Syntax

client.list_node_from_template_jobs(
    NextToken='string',
    MaxResults=123
)

type NextToken

string

param NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of node from template jobs to return in one page of results.

rtype

dict

returns

Response Syntax

{
    'NodeFromTemplateJobs': [
        {
            'JobId': 'string',
            'TemplateType': 'RTSP_CAMERA_STREAM',
            'Status': 'PENDING'|'SUCCEEDED'|'FAILED',
            'StatusMessage': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'NodeName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- NodeFromTemplateJobs (list) --
  
  A list of jobs.
  - (dict) --
    
    A job to create a camera stream node.
    - JobId (string) --
      
      The job's ID.
    - TemplateType (string) --
      
      The job's template type.
    - Status (string) --
      
      The job's status.
    - StatusMessage (string) --
      
      The job's status message.
    - CreatedTime (datetime) --
      
      When the job was created.
    - NodeName (string) --
      
      The node's name.
- NextToken (string) --
  
  A pagination token that's included if more results are available.

ListApplicationInstanceNodeInstances (new)

Link ¶

Returns a list of application node instances.

See also: AWS API Documentation

Request Syntax

client.list_application_instance_node_instances(
    ApplicationInstanceId='string',
    MaxResults=123,
    NextToken='string'
)

type ApplicationInstanceId

string

param ApplicationInstanceId

[REQUIRED]

The node instances' application instance ID.

type MaxResults

integer

param MaxResults

The maximum number of node instances to return in one page of results.

type NextToken

string

param NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

rtype

dict

returns

Response Syntax

{
    'NodeInstances': [
        {
            'NodeInstanceId': 'string',
            'NodeId': 'string',
            'PackageName': 'string',
            'PackageVersion': 'string',
            'PackagePatchVersion': 'string',
            'NodeName': 'string',
            'CurrentStatus': 'RUNNING'|'ERROR'|'NOT_AVAILABLE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- NodeInstances (list) --
  
  A list of node instances.
  - (dict) --
    
    A node instance.
    - NodeInstanceId (string) --
      
      The instance's ID.
    - NodeId (string) --
      
      The node's ID.
    - PackageName (string) --
      
      The instance's package name.
    - PackageVersion (string) --
      
      The instance's package version.
    - PackagePatchVersion (string) --
      
      The instance's package patch version.
    - NodeName (string) --
      
      The instance's name.
    - CurrentStatus (string) --
      
      The instance's current status.
- NextToken (string) --
  
  A pagination token that's included if more results are available.

DescribePackageVersion (new)

Link ¶

Returns information about a package version.

See also: AWS API Documentation

Request Syntax

client.describe_package_version(
    OwnerAccount='string',
    PackageId='string',
    PackageVersion='string',
    PatchVersion='string'
)

type OwnerAccount

string

param OwnerAccount

The version's owner account.

type PackageId

string

param PackageId

[REQUIRED]

The version's ID.

type PackageVersion

string

param PackageVersion

[REQUIRED]

The version's version.

type PatchVersion

string

param PatchVersion

The version's patch version.

rtype

dict

returns

Response Syntax

{
    'OwnerAccount': 'string',
    'PackageId': 'string',
    'PackageArn': 'string',
    'PackageName': 'string',
    'PackageVersion': 'string',
    'PatchVersion': 'string',
    'IsLatestPatch': True|False,
    'Status': 'REGISTER_PENDING'|'REGISTER_COMPLETED'|'FAILED'|'DELETING',
    'StatusDescription': 'string',
    'RegisteredTime': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- OwnerAccount (string) --
  
  The account ID of the version's owner.
- PackageId (string) --
  
  The version's ID.
- PackageArn (string) --
  
  The ARN of the package.
- PackageName (string) --
  
  The version's name.
- PackageVersion (string) --
  
  The version's version.
- PatchVersion (string) --
  
  The version's patch version.
- IsLatestPatch (boolean) --
  
  Whether the version is the latest available.
- Status (string) --
  
  The version's status.
- StatusDescription (string) --
  
  The version's status description.
- RegisteredTime (datetime) --
  
  The version's registered time.

ListApplicationInstanceDependencies (new)

Link ¶

Returns a list of application instance dependencies.

See also: AWS API Documentation

Request Syntax

client.list_application_instance_dependencies(
    ApplicationInstanceId='string',
    MaxResults=123,
    NextToken='string'
)

type ApplicationInstanceId

string

param ApplicationInstanceId

[REQUIRED]

The application instance's ID.

type MaxResults

integer

param MaxResults

The maximum number of application instance dependencies to return in one page of results.

type NextToken

string

param NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

rtype

dict

returns

Response Syntax

{
    'PackageObjects': [
        {
            'Name': 'string',
            'PackageVersion': 'string',
            'PatchVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- PackageObjects (list) --
  
  A list of package objects.
  - (dict) --
    
    A package object.
    - Name (string) --
      
      The object's name.
    - PackageVersion (string) --
      
      The object's package version.
    - PatchVersion (string) --
      
      The object's patch version.
- NextToken (string) --
  
  A pagination token that's included if more results are available.

DescribeNode (new)

Link ¶

Returns information about a node.

See also: AWS API Documentation

Request Syntax

client.describe_node(
    NodeId='string',
    OwnerAccount='string'
)

type NodeId

string

param NodeId

[REQUIRED]

The node's ID.

type OwnerAccount

string

param OwnerAccount

The account ID of the node's owner.

rtype

dict

returns

Response Syntax

{
    'NodeId': 'string',
    'Name': 'string',
    'Category': 'BUSINESS_LOGIC'|'ML_MODEL'|'MEDIA_SOURCE'|'MEDIA_SINK',
    'OwnerAccount': 'string',
    'PackageName': 'string',
    'PackageId': 'string',
    'PackageArn': 'string',
    'PackageVersion': 'string',
    'PatchVersion': 'string',
    'NodeInterface': {
        'Inputs': [
            {
                'Name': 'string',
                'Description': 'string',
                'Type': 'BOOLEAN'|'STRING'|'INT32'|'FLOAT32'|'MEDIA',
                'DefaultValue': 'string',
                'MaxConnections': 123
            },
        ],
        'Outputs': [
            {
                'Name': 'string',
                'Description': 'string',
                'Type': 'BOOLEAN'|'STRING'|'INT32'|'FLOAT32'|'MEDIA'
            },
        ]
    },
    'AssetName': 'string',
    'Description': 'string',
    'CreatedTime': datetime(2015, 1, 1),
    'LastUpdatedTime': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- NodeId (string) --
  
  The node's ID.
- Name (string) --
  
  The node's name.
- Category (string) --
  
  The node's category.
- OwnerAccount (string) --
  
  The account ID of the node's owner.
- PackageName (string) --
  
  The node's package name.
- PackageId (string) --
  
  The node's package ID.
- PackageArn (string) --
  
  The node's ARN.
- PackageVersion (string) --
  
  The node's package version.
- PatchVersion (string) --
  
  The node's patch version.
- NodeInterface (dict) --
  
  The node's interface.
  - Inputs (list) --
    
    The node interface's inputs.
    - (dict) --
      
      A node input port.
      - Name (string) --
        
        The input port's name.
      - Description (string) --
        
        The input port's description.
      - Type (string) --
        
        The input port's type.
      - DefaultValue (string) --
        
        The input port's default value.
      - MaxConnections (integer) --
        
        The input port's max connections.
  - Outputs (list) --
    
    The node interface's outputs.
    - (dict) --
      
      A node output port.
      - Name (string) --
        
        The output port's name.
      - Description (string) --
        
        The output port's description.
      - Type (string) --
        
        The output port's type.
- AssetName (string) --
  
  The node's asset name.
- Description (string) --
  
  The node's description.
- CreatedTime (datetime) --
  
  When the node was created.
- LastUpdatedTime (datetime) --
  
  When the node was updated.

CreateJobForDevices (new)

Link ¶

Creates a job to run on one or more devices.

See also: AWS API Documentation

Request Syntax

client.create_job_for_devices(
    DeviceIds=[
        'string',
    ],
    DeviceJobConfig={
        'OTAJobConfig': {
            'ImageVersion': 'string'
        }
    },
    JobType='OTA'
)

type DeviceIds

list

param DeviceIds

[REQUIRED]

IDs of target devices.

(string) --

type DeviceJobConfig

dict

param DeviceJobConfig

[REQUIRED]

Configuration settings for the job.

OTAJobConfig (dict) --

A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.
- ImageVersion (string) -- [REQUIRED]
  
  The target version of the device software.

type JobType

string

param JobType

[REQUIRED]

The type of job to run.

rtype

dict

returns

Response Syntax

{
    'Jobs': [
        {
            'JobId': 'string',
            'DeviceId': 'string'
        },
    ]
}

Response Structure

(dict) --
- Jobs (list) --
  
  A list of jobs.
  - (dict) --
    
    A job for a device.
    - JobId (string) --
      
      The job's ID.
    - DeviceId (string) --
      
      The target device's ID.

DescribeApplicationInstance (new)

Link ¶

Returns information about an application instance on a device.

See also: AWS API Documentation

Request Syntax

client.describe_application_instance(
    ApplicationInstanceId='string'
)

type ApplicationInstanceId

string

param ApplicationInstanceId

[REQUIRED]

The application instance's ID.

rtype

dict

returns

Response Syntax

{
    'Name': 'string',
    'Description': 'string',
    'DefaultRuntimeContextDevice': 'string',
    'DefaultRuntimeContextDeviceName': 'string',
    'ApplicationInstanceIdToReplace': 'string',
    'RuntimeRoleArn': 'string',
    'Status': 'DEPLOYMENT_PENDING'|'DEPLOYMENT_REQUESTED'|'DEPLOYMENT_IN_PROGRESS'|'DEPLOYMENT_ERROR'|'DEPLOYMENT_SUCCEEDED'|'REMOVAL_PENDING'|'REMOVAL_REQUESTED'|'REMOVAL_IN_PROGRESS'|'REMOVAL_FAILED'|'REMOVAL_SUCCEEDED',
    'HealthStatus': 'RUNNING'|'ERROR'|'NOT_AVAILABLE',
    'StatusDescription': 'string',
    'CreatedTime': datetime(2015, 1, 1),
    'LastUpdatedTime': datetime(2015, 1, 1),
    'ApplicationInstanceId': 'string',
    'Arn': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- Name (string) --
  
  The application instance's name.
- Description (string) --
  
  The application instance's description.
- DefaultRuntimeContextDevice (string) --
  
  The device's ID.
- DefaultRuntimeContextDeviceName (string) --
  
  The device's bane.
- ApplicationInstanceIdToReplace (string) --
  
  The ID of the application instance that this instance replaced.
- RuntimeRoleArn (string) --
  
  The application instance's runtime role ARN.
- Status (string) --
  
  The application instance's status.
- HealthStatus (string) --
  
  The application instance's health status.
- StatusDescription (string) --
  
  The application instance's status description.
- CreatedTime (datetime) --
  
  When the application instance was created.
- LastUpdatedTime (datetime) --
  
  The application instance was updated.
- ApplicationInstanceId (string) --
  
  The application instance's ID.
- Arn (string) --
  
  The application instance's ARN.
- Tags (dict) --
  
  The application instance's tags.
  - (string) --
    - (string) --

DeregisterPackageVersion (new)

Link ¶

Deregisters a package version.

See also: AWS API Documentation

Request Syntax

client.deregister_package_version(
    OwnerAccount='string',
    PackageId='string',
    PackageVersion='string',
    PatchVersion='string',
    UpdatedLatestPatchVersion='string'
)

type OwnerAccount

string

param OwnerAccount

An owner account.

type PackageId

string

param PackageId

[REQUIRED]

A package ID.

type PackageVersion

string

param PackageVersion

[REQUIRED]

A package version.

type PatchVersion

string

param PatchVersion

[REQUIRED]

A patch version.

type UpdatedLatestPatchVersion

string

param UpdatedLatestPatchVersion

If the version was marked latest, the new version to maker as latest.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DeletePackage (new)

Link ¶

Deletes a package.

See also: AWS API Documentation

Request Syntax

client.delete_package(
    PackageId='string',
    ForceDelete=True|False
)

type PackageId

string

param PackageId

[REQUIRED]

The package's ID.

type ForceDelete

boolean

param ForceDelete

Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

ListTagsForResource (new)

Link ¶

Returns a list of tags for a resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceArn='string'
)

type ResourceArn

string

param ResourceArn

[REQUIRED]

The resource's ARN.

rtype

dict

returns

Response Syntax

{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- Tags (dict) --
  
  A list of tags.
  - (string) --
    - (string) --

ListPackages (new)

Link ¶

Returns a list of packages.

See also: AWS API Documentation

Request Syntax

client.list_packages(
    MaxResults=123,
    NextToken='string'
)

type MaxResults

integer

param MaxResults

The maximum number of packages to return in one page of results.

type NextToken

string

param NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

rtype

dict

returns

Response Syntax

{
    'Packages': [
        {
            'PackageId': 'string',
            'PackageName': 'string',
            'Arn': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Packages (list) --
  
  A list of packages.
  - (dict) --
    
    A package summary.
    - PackageId (string) --
      
      The package's ID.
    - PackageName (string) --
      
      The package's name.
    - Arn (string) --
      
      The package's ARN.
    - CreatedTime (datetime) --
      
      When the package was created.
    - Tags (dict) --
      
      The package's tags.
      - (string) --
        
        (string) --
- NextToken (string) --
  
  A pagination token that's included if more results are available.

RegisterPackageVersion (new)

Link ¶

Registers a package version.

See also: AWS API Documentation

Request Syntax

client.register_package_version(
    OwnerAccount='string',
    PackageId='string',
    PackageVersion='string',
    PatchVersion='string',
    MarkLatest=True|False
)

type OwnerAccount

string

param OwnerAccount

An owner account.

type PackageId

string

param PackageId

[REQUIRED]

A package ID.

type PackageVersion

string

param PackageVersion

[REQUIRED]

A package version.

type PatchVersion

string

param PatchVersion

[REQUIRED]

A patch version.

type MarkLatest

boolean

param MarkLatest

Whether to mark the new version as the latest version.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

ListDevicesJobs (new)

Link ¶

Returns a list of jobs.

See also: AWS API Documentation

Request Syntax

client.list_devices_jobs(
    DeviceId='string',
    NextToken='string',
    MaxResults=123
)

type DeviceId

string

param DeviceId

Filter results by the job's target device ID.

type NextToken

string

param NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of device jobs to return in one page of results.

rtype

dict

returns

Response Syntax

{
    'DeviceJobs': [
        {
            'DeviceName': 'string',
            'DeviceId': 'string',
            'JobId': 'string',
            'CreatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- DeviceJobs (list) --
  
  A list of jobs.
  - (dict) --
    
    A job that runs on a device.
    - DeviceName (string) --
      
      The name of the target device
    - DeviceId (string) --
      
      The ID of the target device.
    - JobId (string) --
      
      The job's ID.
    - CreatedTime (datetime) --
      
      When the job was created.
- NextToken (string) --
  
  A pagination token that's included if more results are available.

ListApplicationInstances (new)

Link ¶

Returns a list of application instances.

See also: AWS API Documentation

Request Syntax

client.list_application_instances(
    DeviceId='string',
    StatusFilter='DEPLOYMENT_SUCCEEDED'|'DEPLOYMENT_ERROR'|'REMOVAL_SUCCEEDED'|'REMOVAL_FAILED'|'PROCESSING_DEPLOYMENT'|'PROCESSING_REMOVAL',
    MaxResults=123,
    NextToken='string'
)

type DeviceId

string

param DeviceId

The application instances' device ID.

type StatusFilter

string

param StatusFilter

Only include instances with a specific status.

type MaxResults

integer

param MaxResults

The maximum number of application instances to return in one page of results.

type NextToken

string

param NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

rtype

dict

returns

Response Syntax

{
    'ApplicationInstances': [
        {
            'Name': 'string',
            'ApplicationInstanceId': 'string',
            'DefaultRuntimeContextDevice': 'string',
            'DefaultRuntimeContextDeviceName': 'string',
            'Description': 'string',
            'Status': 'DEPLOYMENT_PENDING'|'DEPLOYMENT_REQUESTED'|'DEPLOYMENT_IN_PROGRESS'|'DEPLOYMENT_ERROR'|'DEPLOYMENT_SUCCEEDED'|'REMOVAL_PENDING'|'REMOVAL_REQUESTED'|'REMOVAL_IN_PROGRESS'|'REMOVAL_FAILED'|'REMOVAL_SUCCEEDED',
            'HealthStatus': 'RUNNING'|'ERROR'|'NOT_AVAILABLE',
            'StatusDescription': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'Arn': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ApplicationInstances (list) --
  
  A list of application instances.
  - (dict) --
    
    An application instance on a device.
    - Name (string) --
      
      The application instance's name.
    - ApplicationInstanceId (string) --
      
      The application instance's ID.
    - DefaultRuntimeContextDevice (string) --
      
      The device's ID.
    - DefaultRuntimeContextDeviceName (string) --
      
      The device's name.
    - Description (string) --
      
      The application instance's description.
    - Status (string) --
      
      The application instance's status.
    - HealthStatus (string) --
      
      The application instance's health status.
    - StatusDescription (string) --
      
      The application instance's status description.
    - CreatedTime (datetime) --
      
      When the application instance was created.
    - Arn (string) --
      
      The application instance's ARN.
    - Tags (dict) --
      
      The application instance's tags.
      - (string) --
        
        (string) --
- NextToken (string) --
  
  A pagination token that's included if more results are available.

CreatePackageImportJob (new)

Link ¶

Imports a node package.

See also: AWS API Documentation

Request Syntax

client.create_package_import_job(
    JobType='NODE_PACKAGE_VERSION',
    InputConfig={
        'PackageVersionInputConfig': {
            'S3Location': {
                'Region': 'string',
                'BucketName': 'string',
                'ObjectKey': 'string'
            }
        }
    },
    OutputConfig={
        'PackageVersionOutputConfig': {
            'PackageName': 'string',
            'PackageVersion': 'string',
            'MarkLatest': True|False
        }
    },
    ClientToken='string',
    JobTags=[
        {
            'ResourceType': 'PACKAGE',
            'Tags': {
                'string': 'string'
            }
        },
    ]
)

type JobType

string

param JobType

[REQUIRED]

A job type for the package import job.

type InputConfig

dict

param InputConfig

[REQUIRED]

An input config for the package import job.

PackageVersionInputConfig (dict) --

The package version's input configuration.
- S3Location (dict) -- [REQUIRED]
  
  A location in Amazon S3.
  - Region (string) --
    
    The bucket's Region.
  - BucketName (string) -- [REQUIRED]
    
    A bucket name.
  - ObjectKey (string) -- [REQUIRED]
    
    An object key.

type OutputConfig

dict

param OutputConfig

[REQUIRED]

An output config for the package import job.

PackageVersionOutputConfig (dict) --

The package version's output configuration.
- PackageName (string) -- [REQUIRED]
  
  The output's package name.
- PackageVersion (string) -- [REQUIRED]
  
  The output's package version.
- MarkLatest (boolean) --
  
  Indicates that the version is recommended for all users.

type ClientToken

string

param ClientToken

[REQUIRED]

A client token for the package import job.

type JobTags

list

param JobTags

Tags for the package import job.

(dict) --

Tags for a job.
- ResourceType (string) -- [REQUIRED]
  
  The job's type.
- Tags (dict) -- [REQUIRED]
  
  The job's tags.
  - (string) --
    - (string) --

rtype

dict

returns

Response Syntax

{
    'JobId': 'string'
}

Response Structure

(dict) --
- JobId (string) --
  
  The job's ID.

DescribeDevice (new)

Link ¶

Returns information about a device.

See also: AWS API Documentation

Request Syntax

client.describe_device(
    DeviceId='string'
)

type DeviceId

string

param DeviceId

[REQUIRED]

The device's ID.

rtype

dict

returns

Response Syntax

{
    'DeviceId': 'string',
    'Name': 'string',
    'Arn': 'string',
    'Description': 'string',
    'Type': 'PANORAMA_APPLIANCE_DEVELOPER_KIT'|'PANORAMA_APPLIANCE',
    'DeviceConnectionStatus': 'ONLINE'|'OFFLINE'|'AWAITING_CREDENTIALS'|'NOT_AVAILABLE'|'ERROR',
    'CreatedTime': datetime(2015, 1, 1),
    'ProvisioningStatus': 'AWAITING_PROVISIONING'|'PENDING'|'SUCCEEDED'|'FAILED'|'ERROR'|'DELETING',
    'LatestSoftware': 'string',
    'CurrentSoftware': 'string',
    'SerialNumber': 'string',
    'Tags': {
        'string': 'string'
    },
    'NetworkingConfiguration': {
        'Ethernet0': {
            'ConnectionType': 'STATIC_IP'|'DHCP',
            'StaticIpConnectionInfo': {
                'IpAddress': 'string',
                'Mask': 'string',
                'Dns': [
                    'string',
                ],
                'DefaultGateway': 'string'
            }
        },
        'Ethernet1': {
            'ConnectionType': 'STATIC_IP'|'DHCP',
            'StaticIpConnectionInfo': {
                'IpAddress': 'string',
                'Mask': 'string',
                'Dns': [
                    'string',
                ],
                'DefaultGateway': 'string'
            }
        }
    },
    'CurrentNetworkingStatus': {
        'Ethernet0Status': {
            'IpAddress': 'string',
            'ConnectionStatus': 'CONNECTED'|'NOT_CONNECTED',
            'HwAddress': 'string'
        },
        'Ethernet1Status': {
            'IpAddress': 'string',
            'ConnectionStatus': 'CONNECTED'|'NOT_CONNECTED',
            'HwAddress': 'string'
        }
    },
    'LeaseExpirationTime': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- DeviceId (string) --
  
  The device's ID.
- Name (string) --
  
  The device's name.
- Arn (string) --
  
  The device's ARN.
- Description (string) --
  
  The device's description.
- Type (string) --
  
  The device's type.
- DeviceConnectionStatus (string) --
  
  The device's connection status.
- CreatedTime (datetime) --
  
  When the device was created.
- ProvisioningStatus (string) --
  
  The device's provisioning status.
- LatestSoftware (string) --
  
  The latest software version available for the device.
- CurrentSoftware (string) --
  
  The device's current software version.
- SerialNumber (string) --
  
  The device's serial number.
- Tags (dict) --
  
  The device's tags.
  - (string) --
    - (string) --
- NetworkingConfiguration (dict) --
  
  The device's networking configuration.
  - Ethernet0 (dict) --
    
    Settings for Ethernet port 0.
    - ConnectionType (string) --
      
      How the device gets an IP address.
    - StaticIpConnectionInfo (dict) --
      
      Network configuration for a static IP connection.
      - IpAddress (string) --
        
        The connection's IP address.
      - Mask (string) --
        
        The connection's DNS mask.
      - Dns (list) --
        
        The connection's DNS address.
        
        (string) --
      - DefaultGateway (string) --
        
        The connection's default gateway.
  - Ethernet1 (dict) --
    
    Settings for Ethernet port 1.
    - ConnectionType (string) --
      
      How the device gets an IP address.
    - StaticIpConnectionInfo (dict) --
      
      Network configuration for a static IP connection.
      - IpAddress (string) --
        
        The connection's IP address.
      - Mask (string) --
        
        The connection's DNS mask.
      - Dns (list) --
        
        The connection's DNS address.
        
        (string) --
      - DefaultGateway (string) --
        
        The connection's default gateway.
- CurrentNetworkingStatus (dict) --
  
  The device's networking status.
  - Ethernet0Status (dict) --
    
    The status of Ethernet port 0.
    - IpAddress (string) --
      
      The device's IP address.
    - ConnectionStatus (string) --
      
      The device's connection status.
    - HwAddress (string) --
      
      The device's physical address.
  - Ethernet1Status (dict) --
    
    The status of Ethernet port 1.
    - IpAddress (string) --
      
      The device's IP address.
    - ConnectionStatus (string) --
      
      The device's connection status.
    - HwAddress (string) --
      
      The device's physical address.
- LeaseExpirationTime (datetime) --
  
  The device's lease expiration time.

DescribePackage (new)

Link ¶

Returns information about a package.

See also: AWS API Documentation

Request Syntax

client.describe_package(
    PackageId='string'
)

type PackageId

string

param PackageId

[REQUIRED]

The package's ID.

rtype

dict

returns

Response Syntax

{
    'PackageId': 'string',
    'PackageName': 'string',
    'Arn': 'string',
    'StorageLocation': {
        'Bucket': 'string',
        'RepoPrefixLocation': 'string',
        'GeneratedPrefixLocation': 'string',
        'BinaryPrefixLocation': 'string',
        'ManifestPrefixLocation': 'string'
    },
    'ReadAccessPrincipalArns': [
        'string',
    ],
    'WriteAccessPrincipalArns': [
        'string',
    ],
    'CreatedTime': datetime(2015, 1, 1),
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- PackageId (string) --
  
  The package's ID.
- PackageName (string) --
  
  The package's name.
- Arn (string) --
  
  The package's ARN.
- StorageLocation (dict) --
  
  The package's storage location.
  - Bucket (string) --
    
    The location's bucket.
  - RepoPrefixLocation (string) --
    
    The location's repo prefix.
  - GeneratedPrefixLocation (string) --
    
    The location's generated prefix.
  - BinaryPrefixLocation (string) --
    
    The location's binary prefix.
  - ManifestPrefixLocation (string) --
    
    The location's manifest prefix.
- ReadAccessPrincipalArns (list) --
  
  ARNs of accounts that have read access to the package.
  - (string) --
- WriteAccessPrincipalArns (list) --
  
  ARNs of accounts that have write access to the package.
  - (string) --
- CreatedTime (datetime) --
  
  When the package was created.
- Tags (dict) --
  
  The package's tags.
  - (string) --
    - (string) --

ListPackageImportJobs (new)

Link ¶

Returns a list of package import jobs.

See also: AWS API Documentation

Request Syntax

client.list_package_import_jobs(
    NextToken='string',
    MaxResults=123
)

type NextToken

string

param NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of package import jobs to return in one page of results.

rtype

dict

returns

Response Syntax

{
    'PackageImportJobs': [
        {
            'JobId': 'string',
            'JobType': 'NODE_PACKAGE_VERSION',
            'Status': 'PENDING'|'SUCCEEDED'|'FAILED',
            'StatusMessage': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- PackageImportJobs (list) --
  
  A list of package import jobs.
  - (dict) --
    
    A job to import a package version.
    - JobId (string) --
      
      The job's ID.
    - JobType (string) --
      
      The job's type.
    - Status (string) --
      
      The job's status.
    - StatusMessage (string) --
      
      The job's status message.
    - CreatedTime (datetime) --
      
      When the job was created.
    - LastUpdatedTime (datetime) --
      
      When the job was updated.
- NextToken (string) --
  
  A pagination token that's included if more results are available.

CreateNodeFromTemplateJob (new)

Link ¶

Creates a camera stream node.

See also: AWS API Documentation

Request Syntax

client.create_node_from_template_job(
    TemplateType='RTSP_CAMERA_STREAM',
    OutputPackageName='string',
    OutputPackageVersion='string',
    NodeName='string',
    NodeDescription='string',
    TemplateParameters={
        'string': 'string'
    },
    JobTags=[
        {
            'ResourceType': 'PACKAGE',
            'Tags': {
                'string': 'string'
            }
        },
    ]
)

type TemplateType

string

param TemplateType

[REQUIRED]

The type of node.

type OutputPackageName

string

param OutputPackageName

[REQUIRED]

An output package name for the node.

type OutputPackageVersion

string

param OutputPackageVersion

[REQUIRED]

An output package version for the node.

type NodeName

string

param NodeName

[REQUIRED]

A name for the node.

type NodeDescription

string

param NodeDescription

A description for the node.

type TemplateParameters

dict

param TemplateParameters

[REQUIRED]

Template parameters for the node.

(string) --
- (string) --

type JobTags

list

param JobTags

Tags for the job.

(dict) --

Tags for a job.
- ResourceType (string) -- [REQUIRED]
  
  The job's type.
- Tags (dict) -- [REQUIRED]
  
  The job's tags.
  - (string) --
    - (string) --

rtype

dict

returns

Response Syntax

{
    'JobId': 'string'
}

Response Structure

(dict) --
- JobId (string) --
  
  The job's ID.

TagResource (new)

Link ¶

Tags a resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)

type ResourceArn

string

param ResourceArn

[REQUIRED]

The resource's ARN.

type Tags

dict

param Tags

[REQUIRED]

Tags for the resource.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

UntagResource (new)

Link ¶

Removes tags from a resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)

type ResourceArn

string

param ResourceArn

[REQUIRED]

The resource's ARN.

type TagKeys

list

param TagKeys

[REQUIRED]

Tag keys to remove.

(string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DescribeApplicationInstanceDetails (new)

Link ¶

Returns information about an application instance's configuration manifest.

See also: AWS API Documentation

Request Syntax

client.describe_application_instance_details(
    ApplicationInstanceId='string'
)

type ApplicationInstanceId

string

param ApplicationInstanceId

[REQUIRED]

The application instance's ID.

rtype

dict

returns

Response Syntax

{
    'Name': 'string',
    'Description': 'string',
    'DefaultRuntimeContextDevice': 'string',
    'ManifestPayload': {
        'PayloadData': 'string'
    },
    'ManifestOverridesPayload': {
        'PayloadData': 'string'
    },
    'ApplicationInstanceIdToReplace': 'string',
    'CreatedTime': datetime(2015, 1, 1),
    'ApplicationInstanceId': 'string'
}

Response Structure

(dict) --
- Name (string) --
  
  The application instance's name.
- Description (string) --
  
  The application instance's description.
- DefaultRuntimeContextDevice (string) --
  
  The application instance's default runtime context device.
- ManifestPayload (dict) --
  
  The application instance's configuration manifest.
  - PayloadData (string) --
    
    The application manifest.
- ManifestOverridesPayload (dict) --
  
  Parameter overrides for the configuration manifest.
  - PayloadData (string) --
    
    The overrides document.
- ApplicationInstanceIdToReplace (string) --
  
  The ID of the application instance that this instance replaced.
- CreatedTime (datetime) --
  
  When the application instance was created.
- ApplicationInstanceId (string) --
  
  The application instance's ID.

RemoveApplicationInstance (new)

Link ¶

Removes an application instance.

See also: AWS API Documentation

Request Syntax

client.remove_application_instance(
    ApplicationInstanceId='string'
)

type ApplicationInstanceId

string

param ApplicationInstanceId

[REQUIRED]

An application instance ID.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DescribeNodeFromTemplateJob (new)

Link ¶

Returns information about a job to create a camera stream node.

See also: AWS API Documentation

Request Syntax

client.describe_node_from_template_job(
    JobId='string'
)

type JobId

string

param JobId

[REQUIRED]

The job's ID.

rtype

dict

returns

Response Syntax

{
    'JobId': 'string',
    'Status': 'PENDING'|'SUCCEEDED'|'FAILED',
    'StatusMessage': 'string',
    'CreatedTime': datetime(2015, 1, 1),
    'LastUpdatedTime': datetime(2015, 1, 1),
    'OutputPackageName': 'string',
    'OutputPackageVersion': 'string',
    'NodeName': 'string',
    'NodeDescription': 'string',
    'TemplateType': 'RTSP_CAMERA_STREAM',
    'TemplateParameters': {
        'string': 'string'
    },
    'JobTags': [
        {
            'ResourceType': 'PACKAGE',
            'Tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

(dict) --
- JobId (string) --
  
  The job's ID.
- Status (string) --
  
  The job's status.
- StatusMessage (string) --
  
  The job's status message.
- CreatedTime (datetime) --
  
  When the job was created.
- LastUpdatedTime (datetime) --
  
  When the job was updated.
- OutputPackageName (string) --
  
  The job's output package name.
- OutputPackageVersion (string) --
  
  The job's output package version.
- NodeName (string) --
  
  The node's name.
- NodeDescription (string) --
  
  The node's description.
- TemplateType (string) --
  
  The job's template type.
- TemplateParameters (dict) --
  
  The job's template parameters.
  - (string) --
    - (string) --
- JobTags (list) --
  
  The job's tags.
  - (dict) --
    
    Tags for a job.
    - ResourceType (string) --
      
      The job's type.
    - Tags (dict) --
      
      The job's tags.
      - (string) --
        
        (string) --

DeleteDevice (new)

Link ¶

Deletes a device.

See also: AWS API Documentation

Request Syntax

client.delete_device(
    DeviceId='string'
)

type DeviceId

string

param DeviceId

[REQUIRED]

The device's ID.

rtype

dict

returns

Response Syntax

{
    'DeviceId': 'string'
}

Response Structure

(dict) --
- DeviceId (string) --
  
  The device's ID.

CreateApplicationInstance (new)

Link ¶

Creates an application instance and deploys it to a device.

See also: AWS API Documentation

Request Syntax

client.create_application_instance(
    Name='string',
    Description='string',
    ManifestPayload={
        'PayloadData': 'string'
    },
    ManifestOverridesPayload={
        'PayloadData': 'string'
    },
    ApplicationInstanceIdToReplace='string',
    RuntimeRoleArn='string',
    DefaultRuntimeContextDevice='string',
    Tags={
        'string': 'string'
    }
)

type Name

string

param Name

A name for the application instance.

type Description

string

param Description

A description for the application instance.

type ManifestPayload

dict

param ManifestPayload

[REQUIRED]

The application's manifest document.

PayloadData (string) --

The application manifest.

type ManifestOverridesPayload

dict

param ManifestOverridesPayload

Setting overrides for the application manifest.

PayloadData (string) --

The overrides document.

type ApplicationInstanceIdToReplace

string

param ApplicationInstanceIdToReplace

The ID of an application instance to replace with the new instance.

type RuntimeRoleArn

string

param RuntimeRoleArn

The ARN of a runtime role for the application instance.

type DefaultRuntimeContextDevice

string

param DefaultRuntimeContextDevice

[REQUIRED]

A device's ID.

type Tags

dict

param Tags

Tags for the application instance.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'ApplicationInstanceId': 'string'
}

Response Structure

(dict) --
- ApplicationInstanceId (string) --
  
  The application instance's ID.