SDK for PHP 3.x

AWS Panorama 2019-07-24

Client: Aws\Panorama\PanoramaClient
Service ID: panorama
Version: 2019-07-24

This page describes the parameters and results for the operations of the AWS Panorama (2019-07-24), and shows how to use the Aws\Panorama\PanoramaClient object to call the described operations. This documentation is specific to the 2019-07-24 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateApplicationInstance ( array $params = [] )
Creates an application instance and deploys it to a device.
CreateJobForDevices ( array $params = [] )
Creates a job to run on a device.
CreateNodeFromTemplateJob ( array $params = [] )
Creates a camera stream node.
CreatePackage ( array $params = [] )
Creates a package and storage location in an Amazon S3 access point.
CreatePackageImportJob ( array $params = [] )
Imports a node package.
DeleteDevice ( array $params = [] )
Deletes a device.
DeletePackage ( array $params = [] )
Deletes a package.
DeregisterPackageVersion ( array $params = [] )
Deregisters a package version.
DescribeApplicationInstance ( array $params = [] )
Returns information about an application instance on a device.
DescribeApplicationInstanceDetails ( array $params = [] )
Returns information about an application instance's configuration manifest.
DescribeDevice ( array $params = [] )
Returns information about a device.
DescribeDeviceJob ( array $params = [] )
Returns information about a device job.
DescribeNode ( array $params = [] )
Returns information about a node.
DescribeNodeFromTemplateJob ( array $params = [] )
Returns information about a job to create a camera stream node.
DescribePackage ( array $params = [] )
Returns information about a package.
DescribePackageImportJob ( array $params = [] )
Returns information about a package import job.
DescribePackageVersion ( array $params = [] )
Returns information about a package version.
ListApplicationInstanceDependencies ( array $params = [] )
Returns a list of application instance dependencies.
ListApplicationInstanceNodeInstances ( array $params = [] )
Returns a list of application node instances.
ListApplicationInstances ( array $params = [] )
Returns a list of application instances.
ListDevices ( array $params = [] )
Returns a list of devices.
ListDevicesJobs ( array $params = [] )
Returns a list of jobs.
ListNodeFromTemplateJobs ( array $params = [] )
Returns a list of camera stream node jobs.
ListNodes ( array $params = [] )
Returns a list of nodes.
ListPackageImportJobs ( array $params = [] )
Returns a list of package import jobs.
ListPackages ( array $params = [] )
Returns a list of packages.
ListTagsForResource ( array $params = [] )
Returns a list of tags for a resource.
ProvisionDevice ( array $params = [] )
Creates a device and returns a configuration archive.
RegisterPackageVersion ( array $params = [] )
Registers a package version.
RemoveApplicationInstance ( array $params = [] )
Removes an application instance.
SignalApplicationInstanceNodeInstances ( array $params = [] )
Signal camera nodes to stop or resume.
TagResource ( array $params = [] )
Tags a resource.
UntagResource ( array $params = [] )
Removes tags from a resource.
UpdateDeviceMetadata ( array $params = [] )
Updates a device's metadata.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListApplicationInstanceDependencies
ListApplicationInstanceNodeInstances
ListApplicationInstances
ListDevices
ListDevicesJobs
ListNodeFromTemplateJobs
ListNodes
ListPackageImportJobs
ListPackages

Operations

CreateApplicationInstance 

$result = $client->createApplicationInstance([/* ... */]);
$promise = $client->createApplicationInstanceAsync([/* ... */]);

Creates an application instance and deploys it to a device.

Parameter Syntax

$result = $client->createApplicationInstance([
    'ApplicationInstanceIdToReplace' => '<string>',
    'DefaultRuntimeContextDevice' => '<string>', // REQUIRED
    'Description' => '<string>',
    'ManifestOverridesPayload' => [
        'PayloadData' => '<string>',
    ],
    'ManifestPayload' => [ // REQUIRED
        'PayloadData' => '<string>',
    ],
    'Name' => '<string>',
    'RuntimeRoleArn' => '<string>',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
ApplicationInstanceIdToReplace
Type: string

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

DefaultRuntimeContextDevice
Required: Yes
Type: string

A device's ID.

Description
Type: string

A description for the application instance.

ManifestOverridesPayload
Type: ManifestOverridesPayload structure

Setting overrides for the application manifest.

ManifestPayload
Required: Yes
Type: ManifestPayload structure

The application's manifest document.

Name
Type: string

A name for the application instance.

RuntimeRoleArn
Type: string

The ARN of a runtime role for the application instance.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

Tags for the application instance.

Result Syntax

[
    'ApplicationInstanceId' => '<string>',
]

Result Details

Members
ApplicationInstanceId
Required: Yes
Type: string

The application instance's ID.

Errors

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ServiceQuotaExceededException:

The request would cause a limit to be exceeded.

InternalServerException:

An internal error occurred.

CreateJobForDevices 

$result = $client->createJobForDevices([/* ... */]);
$promise = $client->createJobForDevicesAsync([/* ... */]);

Creates a job to run on a device. A job can update a device's software or reboot it.

Parameter Syntax

$result = $client->createJobForDevices([
    'DeviceIds' => ['<string>', ...], // REQUIRED
    'DeviceJobConfig' => [
        'OTAJobConfig' => [
            'AllowMajorVersionUpdate' => true || false,
            'ImageVersion' => '<string>', // REQUIRED
        ],
    ],
    'JobType' => 'OTA|REBOOT', // REQUIRED
]);

Parameter Details

Members
DeviceIds
Required: Yes
Type: Array of strings

ID of target device.

DeviceJobConfig
Type: DeviceJobConfig structure

Configuration settings for a software update job.

JobType
Required: Yes
Type: string

The type of job to run.

Result Syntax

[
    'Jobs' => [
        [
            'DeviceId' => '<string>',
            'JobId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Jobs
Required: Yes
Type: Array of Job structures

A list of jobs.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

CreateNodeFromTemplateJob 

$result = $client->createNodeFromTemplateJob([/* ... */]);
$promise = $client->createNodeFromTemplateJobAsync([/* ... */]);

Creates a camera stream node.

Parameter Syntax

$result = $client->createNodeFromTemplateJob([
    'JobTags' => [
        [
            'ResourceType' => 'PACKAGE', // REQUIRED
            'Tags' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'NodeDescription' => '<string>',
    'NodeName' => '<string>', // REQUIRED
    'OutputPackageName' => '<string>', // REQUIRED
    'OutputPackageVersion' => '<string>', // REQUIRED
    'TemplateParameters' => ['<string>', ...], // REQUIRED
    'TemplateType' => 'RTSP_CAMERA_STREAM', // REQUIRED
]);

Parameter Details

Members
JobTags
Type: Array of JobResourceTags structures

Tags for the job.

NodeDescription
Type: string

A description for the node.

NodeName
Required: Yes
Type: string

A name for the node.

OutputPackageName
Required: Yes
Type: string

An output package name for the node.

OutputPackageVersion
Required: Yes
Type: string

An output package version for the node.

TemplateParameters
Required: Yes
Type: Associative array of custom strings keys (TemplateKey) to strings

Template parameters for the node.

TemplateType
Required: Yes
Type: string

The type of node.

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Members
JobId
Required: Yes
Type: string

The job's ID.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

InternalServerException:

An internal error occurred.

CreatePackage 

$result = $client->createPackage([/* ... */]);
$promise = $client->createPackageAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createPackage([
    'PackageName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
PackageName
Required: Yes
Type: string

A name for the package.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

Tags for the package.

Result Syntax

[
    'Arn' => '<string>',
    'PackageId' => '<string>',
    'StorageLocation' => [
        'BinaryPrefixLocation' => '<string>',
        'Bucket' => '<string>',
        'GeneratedPrefixLocation' => '<string>',
        'ManifestPrefixLocation' => '<string>',
        'RepoPrefixLocation' => '<string>',
    ],
]

Result Details

Members
Arn
Type: string

The package's ARN.

PackageId
Type: string

The package's ID.

StorageLocation
Required: Yes
Type: StorageLocation structure

The package's storage location.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

InternalServerException:

An internal error occurred.

CreatePackageImportJob 

$result = $client->createPackageImportJob([/* ... */]);
$promise = $client->createPackageImportJobAsync([/* ... */]);

Imports a node package.

Parameter Syntax

$result = $client->createPackageImportJob([
    'ClientToken' => '<string>', // REQUIRED
    'InputConfig' => [ // REQUIRED
        'PackageVersionInputConfig' => [
            'S3Location' => [ // REQUIRED
                'BucketName' => '<string>', // REQUIRED
                'ObjectKey' => '<string>', // REQUIRED
                'Region' => '<string>',
            ],
        ],
    ],
    'JobTags' => [
        [
            'ResourceType' => 'PACKAGE', // REQUIRED
            'Tags' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'JobType' => 'NODE_PACKAGE_VERSION|MARKETPLACE_NODE_PACKAGE_VERSION', // REQUIRED
    'OutputConfig' => [ // REQUIRED
        'PackageVersionOutputConfig' => [
            'MarkLatest' => true || false,
            'PackageName' => '<string>', // REQUIRED
            'PackageVersion' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
ClientToken
Required: Yes
Type: string

A client token for the package import job.

InputConfig
Required: Yes
Type: PackageImportJobInputConfig structure

An input config for the package import job.

JobTags
Type: Array of JobResourceTags structures

Tags for the package import job.

JobType
Required: Yes
Type: string

A job type for the package import job.

OutputConfig
Required: Yes
Type: PackageImportJobOutputConfig structure

An output config for the package import job.

Result Syntax

[
    'JobId' => '<string>',
]

Result Details

Members
JobId
Required: Yes
Type: string

The job's ID.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

InternalServerException:

An internal error occurred.

DeleteDevice 

$result = $client->deleteDevice([/* ... */]);
$promise = $client->deleteDeviceAsync([/* ... */]);

Deletes a device.

Parameter Syntax

$result = $client->deleteDevice([
    'DeviceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
DeviceId
Required: Yes
Type: string

The device's ID.

Result Syntax

[
    'DeviceId' => '<string>',
]

Result Details

Members
DeviceId
Type: string

The device's ID.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

DeletePackage 

$result = $client->deletePackage([/* ... */]);
$promise = $client->deletePackageAsync([/* ... */]);

Deletes a package.

To delete a package, you need permission to call s3:DeleteObject in addition to permissions for the AWS Panorama API.

Parameter Syntax

$result = $client->deletePackage([
    'ForceDelete' => true || false,
    'PackageId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ForceDelete
Type: boolean

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

PackageId
Required: Yes
Type: string

The package's ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

DeregisterPackageVersion 

$result = $client->deregisterPackageVersion([/* ... */]);
$promise = $client->deregisterPackageVersionAsync([/* ... */]);

Deregisters a package version.

Parameter Syntax

$result = $client->deregisterPackageVersion([
    'OwnerAccount' => '<string>',
    'PackageId' => '<string>', // REQUIRED
    'PackageVersion' => '<string>', // REQUIRED
    'PatchVersion' => '<string>', // REQUIRED
    'UpdatedLatestPatchVersion' => '<string>',
]);

Parameter Details

Members
OwnerAccount
Type: string

An owner account.

PackageId
Required: Yes
Type: string

A package ID.

PackageVersion
Required: Yes
Type: string

A package version.

PatchVersion
Required: Yes
Type: string

A patch version.

UpdatedLatestPatchVersion
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

DescribeApplicationInstance 

$result = $client->describeApplicationInstance([/* ... */]);
$promise = $client->describeApplicationInstanceAsync([/* ... */]);

Returns information about an application instance on a device.

Parameter Syntax

$result = $client->describeApplicationInstance([
    'ApplicationInstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ApplicationInstanceId
Required: Yes
Type: string

The application instance's ID.

Result Syntax

[
    'ApplicationInstanceId' => '<string>',
    'ApplicationInstanceIdToReplace' => '<string>',
    'Arn' => '<string>',
    'CreatedTime' => <DateTime>,
    'DefaultRuntimeContextDevice' => '<string>',
    'DefaultRuntimeContextDeviceName' => '<string>',
    'Description' => '<string>',
    'HealthStatus' => 'RUNNING|ERROR|NOT_AVAILABLE',
    'LastUpdatedTime' => <DateTime>,
    'Name' => '<string>',
    'RuntimeContextStates' => [
        [
            'DesiredState' => 'RUNNING|STOPPED|REMOVED',
            'DeviceReportedStatus' => 'STOPPING|STOPPED|STOP_ERROR|REMOVAL_FAILED|REMOVAL_IN_PROGRESS|STARTING|RUNNING|INSTALL_ERROR|LAUNCHED|LAUNCH_ERROR|INSTALL_IN_PROGRESS',
            'DeviceReportedTime' => <DateTime>,
            'RuntimeContextName' => '<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|DEPLOYMENT_FAILED',
    'StatusDescription' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members
ApplicationInstanceId
Type: string

The application instance's ID.

ApplicationInstanceIdToReplace
Type: string

The ID of the application instance that this instance replaced.

Arn
Type: string

The application instance's ARN.

CreatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the application instance was created.

DefaultRuntimeContextDevice
Type: string

The device's ID.

DefaultRuntimeContextDeviceName
Type: string

The device's bane.

Description
Type: string

The application instance's description.

HealthStatus
Type: string

The application instance's health status.

LastUpdatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The application instance was updated.

Name
Type: string

The application instance's name.

RuntimeContextStates
Type: Array of ReportedRuntimeContextState structures

The application instance's state.

RuntimeRoleArn
Type: string

The application instance's runtime role ARN.

Status
Type: string

The application instance's status.

StatusDescription
Type: string

The application instance's status description.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The application instance's tags.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

DescribeApplicationInstanceDetails 

$result = $client->describeApplicationInstanceDetails([/* ... */]);
$promise = $client->describeApplicationInstanceDetailsAsync([/* ... */]);

Returns information about an application instance's configuration manifest.

Parameter Syntax

$result = $client->describeApplicationInstanceDetails([
    'ApplicationInstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ApplicationInstanceId
Required: Yes
Type: string

The application instance's ID.

Result Syntax

[
    'ApplicationInstanceId' => '<string>',
    'ApplicationInstanceIdToReplace' => '<string>',
    'CreatedTime' => <DateTime>,
    'DefaultRuntimeContextDevice' => '<string>',
    'Description' => '<string>',
    'ManifestOverridesPayload' => [
        'PayloadData' => '<string>',
    ],
    'ManifestPayload' => [
        'PayloadData' => '<string>',
    ],
    'Name' => '<string>',
]

Result Details

Members
ApplicationInstanceId
Type: string

The application instance's ID.

ApplicationInstanceIdToReplace
Type: string

The ID of the application instance that this instance replaced.

CreatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the application instance was created.

DefaultRuntimeContextDevice
Type: string

The application instance's default runtime context device.

Description
Type: string

The application instance's description.

ManifestOverridesPayload
Type: ManifestOverridesPayload structure

Parameter overrides for the configuration manifest.

ManifestPayload
Type: ManifestPayload structure

The application instance's configuration manifest.

Name
Type: string

The application instance's name.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

DescribeDevice 

$result = $client->describeDevice([/* ... */]);
$promise = $client->describeDeviceAsync([/* ... */]);

Returns information about a device.

Parameter Syntax

$result = $client->describeDevice([
    'DeviceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
DeviceId
Required: Yes
Type: string

The device's ID.

Result Syntax

[
    'AlternateSoftwares' => [
        [
            'Version' => '<string>',
        ],
        // ...
    ],
    'Arn' => '<string>',
    'Brand' => 'AWS_PANORAMA|LENOVO',
    'CreatedTime' => <DateTime>,
    'CurrentNetworkingStatus' => [
        'Ethernet0Status' => [
            'ConnectionStatus' => 'CONNECTED|NOT_CONNECTED|CONNECTING',
            'HwAddress' => '<string>',
            'IpAddress' => '<string>',
        ],
        'Ethernet1Status' => [
            'ConnectionStatus' => 'CONNECTED|NOT_CONNECTED|CONNECTING',
            'HwAddress' => '<string>',
            'IpAddress' => '<string>',
        ],
        'LastUpdatedTime' => <DateTime>,
        'NtpStatus' => [
            'ConnectionStatus' => 'CONNECTED|NOT_CONNECTED|CONNECTING',
            'IpAddress' => '<string>',
            'NtpServerName' => '<string>',
        ],
    ],
    'CurrentSoftware' => '<string>',
    'Description' => '<string>',
    'DeviceAggregatedStatus' => 'ERROR|AWAITING_PROVISIONING|PENDING|FAILED|DELETING|ONLINE|OFFLINE|LEASE_EXPIRED|UPDATE_NEEDED|REBOOTING',
    'DeviceConnectionStatus' => 'ONLINE|OFFLINE|AWAITING_CREDENTIALS|NOT_AVAILABLE|ERROR',
    'DeviceId' => '<string>',
    'LatestAlternateSoftware' => '<string>',
    'LatestDeviceJob' => [
        'ImageVersion' => '<string>',
        'JobType' => 'OTA|REBOOT',
        'Status' => 'PENDING|IN_PROGRESS|VERIFYING|REBOOTING|DOWNLOADING|COMPLETED|FAILED',
    ],
    'LatestSoftware' => '<string>',
    'LeaseExpirationTime' => <DateTime>,
    'Name' => '<string>',
    'NetworkingConfiguration' => [
        'Ethernet0' => [
            'ConnectionType' => 'STATIC_IP|DHCP',
            'StaticIpConnectionInfo' => [
                'DefaultGateway' => '<string>',
                'Dns' => ['<string>', ...],
                'IpAddress' => '<string>',
                'Mask' => '<string>',
            ],
        ],
        'Ethernet1' => [
            'ConnectionType' => 'STATIC_IP|DHCP',
            'StaticIpConnectionInfo' => [
                'DefaultGateway' => '<string>',
                'Dns' => ['<string>', ...],
                'IpAddress' => '<string>',
                'Mask' => '<string>',
            ],
        ],
        'Ntp' => [
            'NtpServers' => ['<string>', ...],
        ],
    ],
    'ProvisioningStatus' => 'AWAITING_PROVISIONING|PENDING|SUCCEEDED|FAILED|ERROR|DELETING',
    'SerialNumber' => '<string>',
    'Tags' => ['<string>', ...],
    'Type' => 'PANORAMA_APPLIANCE_DEVELOPER_KIT|PANORAMA_APPLIANCE',
]

Result Details

Members
AlternateSoftwares
Type: Array of AlternateSoftwareMetadata structures

Beta software releases available for the device.

Arn
Type: string

The device's ARN.

Brand
Type: string

The device's maker.

CreatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the device was created.

CurrentNetworkingStatus
Type: NetworkStatus structure

The device's networking status.

CurrentSoftware
Type: string

The device's current software version.

Description
Type: string

The device's description.

DeviceAggregatedStatus
Type: string

A device's aggregated status. Including the device's connection status, provisioning status, and lease status.

DeviceConnectionStatus
Type: string

The device's connection status.

DeviceId
Type: string

The device's ID.

LatestAlternateSoftware
Type: string

The most recent beta software release.

LatestDeviceJob
Type: LatestDeviceJob structure

A device's latest job. Includes the target image version, and the job status.

LatestSoftware
Type: string

The latest software version available for the device.

LeaseExpirationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The device's lease expiration time.

Name
Type: string

The device's name.

NetworkingConfiguration
Type: NetworkPayload structure

The device's networking configuration.

ProvisioningStatus
Type: string

The device's provisioning status.

SerialNumber
Type: string

The device's serial number.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The device's tags.

Type
Type: string

The device's type.

Errors

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

DescribeDeviceJob 

$result = $client->describeDeviceJob([/* ... */]);
$promise = $client->describeDeviceJobAsync([/* ... */]);

Returns information about a device job.

Parameter Syntax

$result = $client->describeDeviceJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
JobId
Required: Yes
Type: string

The job's ID.

Result Syntax

[
    'CreatedTime' => <DateTime>,
    'DeviceArn' => '<string>',
    'DeviceId' => '<string>',
    'DeviceName' => '<string>',
    'DeviceType' => 'PANORAMA_APPLIANCE_DEVELOPER_KIT|PANORAMA_APPLIANCE',
    'ImageVersion' => '<string>',
    'JobId' => '<string>',
    'JobType' => 'OTA|REBOOT',
    'Status' => 'PENDING|IN_PROGRESS|VERIFYING|REBOOTING|DOWNLOADING|COMPLETED|FAILED',
]

Result Details

Members
CreatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the job was created.

DeviceArn
Type: string

The device's ARN.

DeviceId
Type: string

The device's ID.

DeviceName
Type: string

The device's name.

DeviceType
Type: string

The device's type.

ImageVersion
Type: string

For an OTA job, the target version of the device software.

JobId
Type: string

The job's ID.

JobType
Type: string

The job's type.

Status
Type: string

The job's status.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

DescribeNode 

$result = $client->describeNode([/* ... */]);
$promise = $client->describeNodeAsync([/* ... */]);

Returns information about a node.

Parameter Syntax

$result = $client->describeNode([
    'NodeId' => '<string>', // REQUIRED
    'OwnerAccount' => '<string>',
]);

Parameter Details

Members
NodeId
Required: Yes
Type: string

The node's ID.

OwnerAccount
Type: string

The account ID of the node's owner.

Result Syntax

[
    'AssetName' => '<string>',
    'Category' => 'BUSINESS_LOGIC|ML_MODEL|MEDIA_SOURCE|MEDIA_SINK',
    'CreatedTime' => <DateTime>,
    'Description' => '<string>',
    'LastUpdatedTime' => <DateTime>,
    'Name' => '<string>',
    'NodeId' => '<string>',
    'NodeInterface' => [
        'Inputs' => [
            [
                'DefaultValue' => '<string>',
                'Description' => '<string>',
                'MaxConnections' => <integer>,
                'Name' => '<string>',
                'Type' => 'BOOLEAN|STRING|INT32|FLOAT32|MEDIA',
            ],
            // ...
        ],
        'Outputs' => [
            [
                'Description' => '<string>',
                'Name' => '<string>',
                'Type' => 'BOOLEAN|STRING|INT32|FLOAT32|MEDIA',
            ],
            // ...
        ],
    ],
    'OwnerAccount' => '<string>',
    'PackageArn' => '<string>',
    'PackageId' => '<string>',
    'PackageName' => '<string>',
    'PackageVersion' => '<string>',
    'PatchVersion' => '<string>',
]

Result Details

Members
AssetName
Type: string

The node's asset name.

Category
Required: Yes
Type: string

The node's category.

CreatedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the node was created.

Description
Required: Yes
Type: string

The node's description.

LastUpdatedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the node was updated.

Name
Required: Yes
Type: string

The node's name.

NodeId
Required: Yes
Type: string

The node's ID.

NodeInterface
Required: Yes
Type: NodeInterface structure

The node's interface.

OwnerAccount
Required: Yes
Type: string

The account ID of the node's owner.

PackageArn
Type: string

The node's ARN.

PackageId
Required: Yes
Type: string

The node's package ID.

PackageName
Required: Yes
Type: string

The node's package name.

PackageVersion
Required: Yes
Type: string

The node's package version.

PatchVersion
Required: Yes
Type: string

The node's patch version.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

DescribeNodeFromTemplateJob 

$result = $client->describeNodeFromTemplateJob([/* ... */]);
$promise = $client->describeNodeFromTemplateJobAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeNodeFromTemplateJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
JobId
Required: Yes
Type: string

The job's ID.

Result Syntax

[
    'CreatedTime' => <DateTime>,
    'JobId' => '<string>',
    'JobTags' => [
        [
            'ResourceType' => 'PACKAGE',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'LastUpdatedTime' => <DateTime>,
    'NodeDescription' => '<string>',
    'NodeName' => '<string>',
    'OutputPackageName' => '<string>',
    'OutputPackageVersion' => '<string>',
    'Status' => 'PENDING|SUCCEEDED|FAILED',
    'StatusMessage' => '<string>',
    'TemplateParameters' => ['<string>', ...],
    'TemplateType' => 'RTSP_CAMERA_STREAM',
]

Result Details

Members
CreatedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the job was created.

JobId
Required: Yes
Type: string

The job's ID.

JobTags
Type: Array of JobResourceTags structures

The job's tags.

LastUpdatedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the job was updated.

NodeDescription
Type: string

The node's description.

NodeName
Required: Yes
Type: string

The node's name.

OutputPackageName
Required: Yes
Type: string

The job's output package name.

OutputPackageVersion
Required: Yes
Type: string

The job's output package version.

Status
Required: Yes
Type: string

The job's status.

StatusMessage
Required: Yes
Type: string

The job's status message.

TemplateParameters
Required: Yes
Type: Associative array of custom strings keys (TemplateKey) to strings

The job's template parameters.

TemplateType
Required: Yes
Type: string

The job's template type.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

InternalServerException:

An internal error occurred.

DescribePackage 

$result = $client->describePackage([/* ... */]);
$promise = $client->describePackageAsync([/* ... */]);

Returns information about a package.

Parameter Syntax

$result = $client->describePackage([
    'PackageId' => '<string>', // REQUIRED
]);

Parameter Details

Members
PackageId
Required: Yes
Type: string

The package's ID.

Result Syntax

[
    'Arn' => '<string>',
    'CreatedTime' => <DateTime>,
    'PackageId' => '<string>',
    'PackageName' => '<string>',
    'ReadAccessPrincipalArns' => ['<string>', ...],
    'StorageLocation' => [
        'BinaryPrefixLocation' => '<string>',
        'Bucket' => '<string>',
        'GeneratedPrefixLocation' => '<string>',
        'ManifestPrefixLocation' => '<string>',
        'RepoPrefixLocation' => '<string>',
    ],
    'Tags' => ['<string>', ...],
    'WriteAccessPrincipalArns' => ['<string>', ...],
]

Result Details

Members
Arn
Required: Yes
Type: string

The package's ARN.

CreatedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the package was created.

PackageId
Required: Yes
Type: string

The package's ID.

PackageName
Required: Yes
Type: string

The package's name.

ReadAccessPrincipalArns
Type: Array of strings

ARNs of accounts that have read access to the package.

StorageLocation
Required: Yes
Type: StorageLocation structure

The package's storage location.

Tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The package's tags.

WriteAccessPrincipalArns
Type: Array of strings

ARNs of accounts that have write access to the package.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

DescribePackageImportJob 

$result = $client->describePackageImportJob([/* ... */]);
$promise = $client->describePackageImportJobAsync([/* ... */]);

Returns information about a package import job.

Parameter Syntax

$result = $client->describePackageImportJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members
JobId
Required: Yes
Type: string

The job's ID.

Result Syntax

[
    'ClientToken' => '<string>',
    'CreatedTime' => <DateTime>,
    'InputConfig' => [
        'PackageVersionInputConfig' => [
            'S3Location' => [
                'BucketName' => '<string>',
                'ObjectKey' => '<string>',
                'Region' => '<string>',
            ],
        ],
    ],
    'JobId' => '<string>',
    'JobTags' => [
        [
            'ResourceType' => 'PACKAGE',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'JobType' => 'NODE_PACKAGE_VERSION|MARKETPLACE_NODE_PACKAGE_VERSION',
    'LastUpdatedTime' => <DateTime>,
    'Output' => [
        'OutputS3Location' => [
            'BucketName' => '<string>',
            'ObjectKey' => '<string>',
        ],
        'PackageId' => '<string>',
        'PackageVersion' => '<string>',
        'PatchVersion' => '<string>',
    ],
    'OutputConfig' => [
        'PackageVersionOutputConfig' => [
            'MarkLatest' => true || false,
            'PackageName' => '<string>',
            'PackageVersion' => '<string>',
        ],
    ],
    'Status' => 'PENDING|SUCCEEDED|FAILED',
    'StatusMessage' => '<string>',
]

Result Details

Members
ClientToken
Type: string

The job's client token.

CreatedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the job was created.

InputConfig
Required: Yes
Type: PackageImportJobInputConfig structure

The job's input config.

JobId
Required: Yes
Type: string

The job's ID.

JobTags
Type: Array of JobResourceTags structures

The job's tags.

JobType
Required: Yes
Type: string

The job's type.

LastUpdatedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the job was updated.

Output
Required: Yes
Type: PackageImportJobOutput structure

The job's output.

OutputConfig
Required: Yes
Type: PackageImportJobOutputConfig structure

The job's output config.

Status
Required: Yes
Type: string

The job's status.

StatusMessage
Required: Yes
Type: string

The job's status message.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

InternalServerException:

An internal error occurred.

DescribePackageVersion 

$result = $client->describePackageVersion([/* ... */]);
$promise = $client->describePackageVersionAsync([/* ... */]);

Returns information about a package version.

Parameter Syntax

$result = $client->describePackageVersion([
    'OwnerAccount' => '<string>',
    'PackageId' => '<string>', // REQUIRED
    'PackageVersion' => '<string>', // REQUIRED
    'PatchVersion' => '<string>',
]);

Parameter Details

Members
OwnerAccount
Type: string

The version's owner account.

PackageId
Required: Yes
Type: string

The version's ID.

PackageVersion
Required: Yes
Type: string

The version's version.

PatchVersion
Type: string

The version's patch version.

Result Syntax

[
    'IsLatestPatch' => true || false,
    'OwnerAccount' => '<string>',
    'PackageArn' => '<string>',
    'PackageId' => '<string>',
    'PackageName' => '<string>',
    'PackageVersion' => '<string>',
    'PatchVersion' => '<string>',
    'RegisteredTime' => <DateTime>,
    'Status' => 'REGISTER_PENDING|REGISTER_COMPLETED|FAILED|DELETING',
    'StatusDescription' => '<string>',
]

Result Details

Members
IsLatestPatch
Required: Yes
Type: boolean

Whether the version is the latest available.

OwnerAccount
Type: string

The account ID of the version's owner.

PackageArn
Type: string

The ARN of the package.

PackageId
Required: Yes
Type: string

The version's ID.

PackageName
Required: Yes
Type: string

The version's name.

PackageVersion
Required: Yes
Type: string

The version's version.

PatchVersion
Required: Yes
Type: string

The version's patch version.

RegisteredTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The version's registered time.

Status
Required: Yes
Type: string

The version's status.

StatusDescription
Type: string

The version's status description.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

ListApplicationInstanceDependencies 

$result = $client->listApplicationInstanceDependencies([/* ... */]);
$promise = $client->listApplicationInstanceDependenciesAsync([/* ... */]);

Returns a list of application instance dependencies.

Parameter Syntax

$result = $client->listApplicationInstanceDependencies([
    'ApplicationInstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ApplicationInstanceId
Required: Yes
Type: string

The application instance's ID.

MaxResults
Type: int

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

NextToken
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'PackageObjects' => [
        [
            'Name' => '<string>',
            'PackageVersion' => '<string>',
            'PatchVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

A pagination token that's included if more results are available.

PackageObjects
Type: Array of PackageObject structures

A list of package objects.

Errors

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

InternalServerException:

An internal error occurred.

ListApplicationInstanceNodeInstances 

$result = $client->listApplicationInstanceNodeInstances([/* ... */]);
$promise = $client->listApplicationInstanceNodeInstancesAsync([/* ... */]);

Returns a list of application node instances.

Parameter Syntax

$result = $client->listApplicationInstanceNodeInstances([
    'ApplicationInstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ApplicationInstanceId
Required: Yes
Type: string

The node instances' application instance ID.

MaxResults
Type: int

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

NextToken
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'NodeInstances' => [
        [
            'CurrentStatus' => 'RUNNING|ERROR|NOT_AVAILABLE|PAUSED',
            'NodeId' => '<string>',
            'NodeInstanceId' => '<string>',
            'NodeName' => '<string>',
            'PackageName' => '<string>',
            'PackagePatchVersion' => '<string>',
            'PackageVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

A pagination token that's included if more results are available.

NodeInstances
Type: Array of NodeInstance structures

A list of node instances.

Errors

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

InternalServerException:

An internal error occurred.

ListApplicationInstances 

$result = $client->listApplicationInstances([/* ... */]);
$promise = $client->listApplicationInstancesAsync([/* ... */]);

Returns a list of application instances.

Parameter Syntax

$result = $client->listApplicationInstances([
    'DeviceId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StatusFilter' => 'DEPLOYMENT_SUCCEEDED|DEPLOYMENT_ERROR|REMOVAL_SUCCEEDED|REMOVAL_FAILED|PROCESSING_DEPLOYMENT|PROCESSING_REMOVAL|DEPLOYMENT_FAILED',
]);

Parameter Details

Members
DeviceId
Type: string

The application instances' device ID.

MaxResults
Type: int

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

NextToken
Type: string

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

StatusFilter
Type: string

Only include instances with a specific status.

Result Syntax

[
    'ApplicationInstances' => [
        [
            'ApplicationInstanceId' => '<string>',
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
            'DefaultRuntimeContextDevice' => '<string>',
            'DefaultRuntimeContextDeviceName' => '<string>',
            'Description' => '<string>',
            'HealthStatus' => 'RUNNING|ERROR|NOT_AVAILABLE',
            'Name' => '<string>',
            'RuntimeContextStates' => [
                [
                    'DesiredState' => 'RUNNING|STOPPED|REMOVED',
                    'DeviceReportedStatus' => 'STOPPING|STOPPED|STOP_ERROR|REMOVAL_FAILED|REMOVAL_IN_PROGRESS|STARTING|RUNNING|INSTALL_ERROR|LAUNCHED|LAUNCH_ERROR|INSTALL_IN_PROGRESS',
                    'DeviceReportedTime' => <DateTime>,
                    'RuntimeContextName' => '<string>',
                ],
                // ...
            ],
            'Status' => 'DEPLOYMENT_PENDING|DEPLOYMENT_REQUESTED|DEPLOYMENT_IN_PROGRESS|DEPLOYMENT_ERROR|DEPLOYMENT_SUCCEEDED|REMOVAL_PENDING|REMOVAL_REQUESTED|REMOVAL_IN_PROGRESS|REMOVAL_FAILED|REMOVAL_SUCCEEDED|DEPLOYMENT_FAILED',
            'StatusDescription' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ApplicationInstances
Type: Array of ApplicationInstance structures

A list of application instances.

NextToken
Type: string

A pagination token that's included if more results are available.

Errors

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

InternalServerException:

An internal error occurred.

ListDevices 

$result = $client->listDevices([/* ... */]);
$promise = $client->listDevicesAsync([/* ... */]);

Returns a list of devices.

Parameter Syntax

$result = $client->listDevices([
    'DeviceAggregatedStatusFilter' => 'ERROR|AWAITING_PROVISIONING|PENDING|FAILED|DELETING|ONLINE|OFFLINE|LEASE_EXPIRED|UPDATE_NEEDED|REBOOTING',
    'MaxResults' => <integer>,
    'NameFilter' => '<string>',
    'NextToken' => '<string>',
    'SortBy' => 'DEVICE_ID|CREATED_TIME|NAME|DEVICE_AGGREGATED_STATUS',
    'SortOrder' => 'ASCENDING|DESCENDING',
]);

Parameter Details

Members
DeviceAggregatedStatusFilter
Type: string

Filter based on a device's status.

MaxResults
Type: int

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

NameFilter
Type: string

Filter based on device's name. Prefixes supported.

NextToken
Type: string

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

SortBy
Type: string

The target column to be sorted on. Default column sort is CREATED_TIME.

SortOrder
Type: string

The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

Result Syntax

[
    'Devices' => [
        [
            'Brand' => 'AWS_PANORAMA|LENOVO',
            'CreatedTime' => <DateTime>,
            'CurrentSoftware' => '<string>',
            'Description' => '<string>',
            'DeviceAggregatedStatus' => 'ERROR|AWAITING_PROVISIONING|PENDING|FAILED|DELETING|ONLINE|OFFLINE|LEASE_EXPIRED|UPDATE_NEEDED|REBOOTING',
            'DeviceId' => '<string>',
            'LastUpdatedTime' => <DateTime>,
            'LatestDeviceJob' => [
                'ImageVersion' => '<string>',
                'JobType' => 'OTA|REBOOT',
                'Status' => 'PENDING|IN_PROGRESS|VERIFYING|REBOOTING|DOWNLOADING|COMPLETED|FAILED',
            ],
            'LeaseExpirationTime' => <DateTime>,
            'Name' => '<string>',
            'ProvisioningStatus' => 'AWAITING_PROVISIONING|PENDING|SUCCEEDED|FAILED|ERROR|DELETING',
            'Tags' => ['<string>', ...],
            'Type' => 'PANORAMA_APPLIANCE_DEVELOPER_KIT|PANORAMA_APPLIANCE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Devices
Required: Yes
Type: Array of Device structures

A list of devices.

NextToken
Type: string

A pagination token that's included if more results are available.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

InternalServerException:

An internal error occurred.

ListDevicesJobs 

$result = $client->listDevicesJobs([/* ... */]);
$promise = $client->listDevicesJobsAsync([/* ... */]);

Returns a list of jobs.

Parameter Syntax

$result = $client->listDevicesJobs([
    'DeviceId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
DeviceId
Type: string

Filter results by the job's target device ID.

MaxResults
Type: int

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

NextToken
Type: string

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

Result Syntax

[
    'DeviceJobs' => [
        [
            'CreatedTime' => <DateTime>,
            'DeviceId' => '<string>',
            'DeviceName' => '<string>',
            'JobId' => '<string>',
            'JobType' => 'OTA|REBOOT',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
DeviceJobs
Type: Array of DeviceJob structures

A list of jobs.

NextToken
Type: string

A pagination token that's included if more results are available.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

ListNodeFromTemplateJobs 

$result = $client->listNodeFromTemplateJobs([/* ... */]);
$promise = $client->listNodeFromTemplateJobsAsync([/* ... */]);

Returns a list of camera stream node jobs.

Parameter Syntax

$result = $client->listNodeFromTemplateJobs([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

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

NextToken
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'NodeFromTemplateJobs' => [
        [
            'CreatedTime' => <DateTime>,
            'JobId' => '<string>',
            'NodeName' => '<string>',
            'Status' => 'PENDING|SUCCEEDED|FAILED',
            'StatusMessage' => '<string>',
            'TemplateType' => 'RTSP_CAMERA_STREAM',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

A pagination token that's included if more results are available.

NodeFromTemplateJobs
Required: Yes
Type: Array of NodeFromTemplateJob structures

A list of jobs.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

InternalServerException:

An internal error occurred.

ListNodes 

$result = $client->listNodes([/* ... */]);
$promise = $client->listNodesAsync([/* ... */]);

Returns a list of nodes.

Parameter Syntax

$result = $client->listNodes([
    'Category' => 'BUSINESS_LOGIC|ML_MODEL|MEDIA_SOURCE|MEDIA_SINK',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OwnerAccount' => '<string>',
    'PackageName' => '<string>',
    'PackageVersion' => '<string>',
    'PatchVersion' => '<string>',
]);

Parameter Details

Members
Category
Type: string

Search for nodes by category.

MaxResults
Type: int

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

NextToken
Type: string

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

OwnerAccount
Type: string

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

PackageName
Type: string

Search for nodes by name.

PackageVersion
Type: string

Search for nodes by version.

PatchVersion
Type: string

Search for nodes by patch version.

Result Syntax

[
    'NextToken' => '<string>',
    'Nodes' => [
        [
            'Category' => 'BUSINESS_LOGIC|ML_MODEL|MEDIA_SOURCE|MEDIA_SINK',
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'Name' => '<string>',
            'NodeId' => '<string>',
            'OwnerAccount' => '<string>',
            'PackageArn' => '<string>',
            'PackageId' => '<string>',
            'PackageName' => '<string>',
            'PackageVersion' => '<string>',
            'PatchVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

A pagination token that's included if more results are available.

Nodes
Type: Array of Node structures

A list of nodes.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

InternalServerException:

An internal error occurred.

ListPackageImportJobs 

$result = $client->listPackageImportJobs([/* ... */]);
$promise = $client->listPackageImportJobsAsync([/* ... */]);

Returns a list of package import jobs.

Parameter Syntax

$result = $client->listPackageImportJobs([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

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

NextToken
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'PackageImportJobs' => [
        [
            'CreatedTime' => <DateTime>,
            'JobId' => '<string>',
            'JobType' => 'NODE_PACKAGE_VERSION|MARKETPLACE_NODE_PACKAGE_VERSION',
            'LastUpdatedTime' => <DateTime>,
            'Status' => 'PENDING|SUCCEEDED|FAILED',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

A pagination token that's included if more results are available.

PackageImportJobs
Required: Yes
Type: Array of PackageImportJob structures

A list of package import jobs.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

InternalServerException:

An internal error occurred.

ListPackages 

$result = $client->listPackages([/* ... */]);
$promise = $client->listPackagesAsync([/* ... */]);

Returns a list of packages.

Parameter Syntax

$result = $client->listPackages([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

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

NextToken
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'Packages' => [
        [
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
            'PackageId' => '<string>',
            'PackageName' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

A pagination token that's included if more results are available.

Packages
Type: Array of PackageListItem structures

A list of packages.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of tags for a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The resource's ARN.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members
Tags
Type: Associative array of custom strings keys (TagKey) to strings

A list of tags.

Errors

ValidationException:

The request contains an invalid parameter value.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

ProvisionDevice 

$result = $client->provisionDevice([/* ... */]);
$promise = $client->provisionDeviceAsync([/* ... */]);

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. Name the configuration archive certificates-omni_device-name.zip and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.

Parameter Syntax

$result = $client->provisionDevice([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'NetworkingConfiguration' => [
        'Ethernet0' => [
            'ConnectionType' => 'STATIC_IP|DHCP', // REQUIRED
            'StaticIpConnectionInfo' => [
                'DefaultGateway' => '<string>', // REQUIRED
                'Dns' => ['<string>', ...], // REQUIRED
                'IpAddress' => '<string>', // REQUIRED
                'Mask' => '<string>', // REQUIRED
            ],
        ],
        'Ethernet1' => [
            'ConnectionType' => 'STATIC_IP|DHCP', // REQUIRED
            'StaticIpConnectionInfo' => [
                'DefaultGateway' => '<string>', // REQUIRED
                'Dns' => ['<string>', ...], // REQUIRED
                'IpAddress' => '<string>', // REQUIRED
                'Mask' => '<string>', // REQUIRED
            ],
        ],
        'Ntp' => [
            'NtpServers' => ['<string>', ...], // REQUIRED
        ],
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
Description
Type: string

A description for the device.

Name
Required: Yes
Type: string

A name for the device.

NetworkingConfiguration
Type: NetworkPayload structure

A networking configuration for the device.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

Tags for the device.

Result Syntax

[
    'Arn' => '<string>',
    'Certificates' => <string || resource || Psr\Http\Message\StreamInterface>,
    'DeviceId' => '<string>',
    'IotThingName' => '<string>',
    'Status' => 'AWAITING_PROVISIONING|PENDING|SUCCEEDED|FAILED|ERROR|DELETING',
]

Result Details

Members
Arn
Required: Yes
Type: string

The device's ARN.

Certificates
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The device's configuration bundle.

DeviceId
Type: string

The device's ID.

IotThingName
Type: string

The device's IoT thing name.

Status
Required: Yes
Type: string

The device's status.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ServiceQuotaExceededException:

The request would cause a limit to be exceeded.

InternalServerException:

An internal error occurred.

RegisterPackageVersion 

$result = $client->registerPackageVersion([/* ... */]);
$promise = $client->registerPackageVersionAsync([/* ... */]);

Registers a package version.

Parameter Syntax

$result = $client->registerPackageVersion([
    'MarkLatest' => true || false,
    'OwnerAccount' => '<string>',
    'PackageId' => '<string>', // REQUIRED
    'PackageVersion' => '<string>', // REQUIRED
    'PatchVersion' => '<string>', // REQUIRED
]);

Parameter Details

Members
MarkLatest
Type: boolean

Whether to mark the new version as the latest version.

OwnerAccount
Type: string

An owner account.

PackageId
Required: Yes
Type: string

A package ID.

PackageVersion
Required: Yes
Type: string

A package version.

PatchVersion
Required: Yes
Type: string

A patch version.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

InternalServerException:

An internal error occurred.

RemoveApplicationInstance 

$result = $client->removeApplicationInstance([/* ... */]);
$promise = $client->removeApplicationInstanceAsync([/* ... */]);

Removes an application instance.

Parameter Syntax

$result = $client->removeApplicationInstance([
    'ApplicationInstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ApplicationInstanceId
Required: Yes
Type: string

An application instance ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

SignalApplicationInstanceNodeInstances 

$result = $client->signalApplicationInstanceNodeInstances([/* ... */]);
$promise = $client->signalApplicationInstanceNodeInstancesAsync([/* ... */]);

Signal camera nodes to stop or resume.

Parameter Syntax

$result = $client->signalApplicationInstanceNodeInstances([
    'ApplicationInstanceId' => '<string>', // REQUIRED
    'NodeSignals' => [ // REQUIRED
        [
            'NodeInstanceId' => '<string>', // REQUIRED
            'Signal' => 'PAUSE|RESUME', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ApplicationInstanceId
Required: Yes
Type: string

An application instance ID.

NodeSignals
Required: Yes
Type: Array of NodeSignal structures

A list of signals.

Result Syntax

[
    'ApplicationInstanceId' => '<string>',
]

Result Details

Members
ApplicationInstanceId
Required: Yes
Type: string

An application instance ID.

Errors

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ServiceQuotaExceededException:

The request would cause a limit to be exceeded.

InternalServerException:

An internal error occurred.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Tags a resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The resource's ARN.

Tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

Tags for the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The request contains an invalid parameter value.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The resource's ARN.

TagKeys
Required: Yes
Type: Array of strings

Tag keys to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

The request contains an invalid parameter value.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

UpdateDeviceMetadata 

$result = $client->updateDeviceMetadata([/* ... */]);
$promise = $client->updateDeviceMetadataAsync([/* ... */]);

Updates a device's metadata.

Parameter Syntax

$result = $client->updateDeviceMetadata([
    'Description' => '<string>',
    'DeviceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Description
Type: string

A description for the device.

DeviceId
Required: Yes
Type: string

The device's ID.

Result Syntax

[
    'DeviceId' => '<string>',
]

Result Details

Members
DeviceId
Type: string

The device's ID.

Errors

ConflictException:

The target resource is in use.

ValidationException:

The request contains an invalid parameter value.

AccessDeniedException:

The requestor does not have permission to access the target action or resource.

ResourceNotFoundException:

The target resource was not found.

InternalServerException:

An internal error occurred.

Shapes

AccessDeniedException

Description

The requestor does not have permission to access the target action or resource.

Members
Message
Required: Yes
Type: string

AlternateSoftwareMetadata

Description

Details about a beta appliance software update.

Members
Version
Type: string

The appliance software version.

ApplicationInstance

Description

An application instance on a device.

Members
ApplicationInstanceId
Type: string

The application instance's ID.

Arn
Type: string

The application instance's ARN.

CreatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the application instance was created.

DefaultRuntimeContextDevice
Type: string

The device's ID.

DefaultRuntimeContextDeviceName
Type: string

The device's name.

Description
Type: string

The application instance's description.

HealthStatus
Type: string

The application instance's health status.

Name
Type: string

The application instance's name.

RuntimeContextStates
Type: Array of ReportedRuntimeContextState structures

The application's state.

Status
Type: string

The application instance's status.

StatusDescription
Type: string

The application instance's status description.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The application instance's tags.

ConflictException

Description

The target resource is in use.

Members
ErrorArguments
Type: Array of ConflictExceptionErrorArgument structures

A list of attributes that led to the exception and their values.

ErrorId
Type: string

A unique ID for the error.

Message
Required: Yes
Type: string
ResourceId
Required: Yes
Type: string

The resource's ID.

ResourceType
Required: Yes
Type: string

The resource's type.

ConflictExceptionErrorArgument

Description

A conflict exception error argument.

Members
Name
Required: Yes
Type: string

The error argument's name.

Value
Required: Yes
Type: string

The error argument's value.

Device

Description

A device.

Members
Brand
Type: string

The device's maker.

CreatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the device was created.

CurrentSoftware
Type: string

A device's current software.

Description
Type: string

A description for the device.

DeviceAggregatedStatus
Type: string

A device's aggregated status. Including the device's connection status, provisioning status, and lease status.

DeviceId
Type: string

The device's ID.

LastUpdatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the device was updated.

LatestDeviceJob
Type: LatestDeviceJob structure

A device's latest job. Includes the target image version, and the update job status.

LeaseExpirationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The device's lease expiration time.

Name
Type: string

The device's name.

ProvisioningStatus
Type: string

The device's provisioning status.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The device's tags.

Type
Type: string

The device's type.

DeviceJob

Description

A job that runs on a device.

Members
CreatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the job was created.

DeviceId
Type: string

The ID of the target device.

DeviceName
Type: string

The name of the target device

JobId
Type: string

The job's ID.

JobType
Type: string

The job's type.

DeviceJobConfig

Description

A job's configuration.

Members
OTAJobConfig
Type: OTAJobConfig structure

A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.

EthernetPayload

Description

A device's network configuration.

Members
ConnectionType
Required: Yes
Type: string

How the device gets an IP address.

StaticIpConnectionInfo
Type: StaticIpConnectionInfo structure

Network configuration for a static IP connection.

EthernetStatus

Description

A device's Ethernet status.

Members
ConnectionStatus
Type: string

The device's connection status.

HwAddress
Type: string

The device's physical address.

IpAddress
Type: string

The device's IP address.

InternalServerException

Description

An internal error occurred.

Members
Message
Required: Yes
Type: string
RetryAfterSeconds
Type: int

The number of seconds a client should wait before retrying the call.

Job

Description

A job for a device.

Members
DeviceId
Type: string

The target device's ID.

JobId
Type: string

The job's ID.

JobResourceTags

Description

Tags for a job.

Members
ResourceType
Required: Yes
Type: string

The job's type.

Tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The job's tags.

LatestDeviceJob

Description

Returns information about the latest device job.

Members
ImageVersion
Type: string

The target version of the device software.

JobType
Type: string

The job's type.

Status
Type: string

Status of the latest device job.

ManifestOverridesPayload

Description

Parameter overrides for an application instance. This is a JSON document that has a single key (PayloadData) where the value is an escaped string representation of the overrides document.

Members
PayloadData
Type: string

The overrides document.

ManifestPayload

Description

A application verion's manifest file. This is a JSON document that has a single key (PayloadData) where the value is an escaped string representation of the application manifest (graph.json). This file is located in the graphs folder in your application source.

Members
PayloadData
Type: string

The application manifest.

NetworkPayload

Description

The network configuration for a device.

Members
Ethernet0
Type: EthernetPayload structure

Settings for Ethernet port 0.

Ethernet1
Type: EthernetPayload structure

Settings for Ethernet port 1.

Ntp
Type: NtpPayload structure

Network time protocol (NTP) server settings.

NetworkStatus

Description

The network status of a device.

Members
Ethernet0Status
Type: EthernetStatus structure

The status of Ethernet port 0.

Ethernet1Status
Type: EthernetStatus structure

The status of Ethernet port 1.

LastUpdatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the network status changed.

NtpStatus
Type: NtpStatus structure

Details about a network time protocol (NTP) server connection.

Node

Description

An application node that represents a camera stream, a model, code, or output.

Members
Category
Required: Yes
Type: string

The node's category.

CreatedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the node was created.

Description
Type: string

The node's description.

Name
Required: Yes
Type: string

The node's name.

NodeId
Required: Yes
Type: string

The node's ID.

OwnerAccount
Type: string

The account ID of the node's owner.

PackageArn
Type: string

The node's ARN.

PackageId
Required: Yes
Type: string

The node's package ID.

PackageName
Required: Yes
Type: string

The node's package name.

PackageVersion
Required: Yes
Type: string

The node's package version.

PatchVersion
Required: Yes
Type: string

The node's patch version.

NodeFromTemplateJob

Description

A job to create a camera stream node.

Members
CreatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the job was created.

JobId
Type: string

The job's ID.

NodeName
Type: string

The node's name.

Status
Type: string

The job's status.

StatusMessage
Type: string

The job's status message.

TemplateType
Type: string

The job's template type.

NodeInputPort

Description

A node input port.

Members
DefaultValue
Type: string

The input port's default value.

Description
Type: string

The input port's description.

MaxConnections
Type: int

The input port's max connections.

Name
Type: string

The input port's name.

Type
Type: string

The input port's type.

NodeInstance

Description

A node instance.

Members
CurrentStatus
Required: Yes
Type: string

The instance's current status.

NodeId
Type: string

The node's ID.

NodeInstanceId
Required: Yes
Type: string

The instance's ID.

NodeName
Type: string

The instance's name.

PackageName
Type: string

The instance's package name.

PackagePatchVersion
Type: string

The instance's package patch version.

PackageVersion
Type: string

The instance's package version.

NodeInterface

Description

A node interface.

Members
Inputs
Required: Yes
Type: Array of NodeInputPort structures

The node interface's inputs.

Outputs
Required: Yes
Type: Array of NodeOutputPort structures

The node interface's outputs.

NodeOutputPort

Description

A node output port.

Members
Description
Type: string

The output port's description.

Name
Type: string

The output port's name.

Type
Type: string

The output port's type.

NodeSignal

Description

A signal to a camera node to start or stop processing video.

Members
NodeInstanceId
Required: Yes
Type: string

The camera node's name, from the application manifest.

Signal
Required: Yes
Type: string

The signal value.

NtpPayload

Description

Network time protocol (NTP) server settings. Use this option to connect to local NTP servers instead of pool.ntp.org.

Members
NtpServers
Required: Yes
Type: Array of strings

NTP servers to use, in order of preference.

NtpStatus

Description

Details about an NTP server connection.

Members
ConnectionStatus
Type: string

The connection's status.

IpAddress
Type: string

The IP address of the server.

NtpServerName
Type: string

The domain name of the server.

OTAJobConfig

Description

An over-the-air update (OTA) job configuration.

Members
AllowMajorVersionUpdate
Type: boolean

Whether to apply the update if it is a major version change.

ImageVersion
Required: Yes
Type: string

The target version of the device software.

OutPutS3Location

Description

The location of an output object in Amazon S3.

Members
BucketName
Required: Yes
Type: string

The object's bucket.

ObjectKey
Required: Yes
Type: string

The object's key.

PackageImportJob

Description

A job to import a package version.

Members
CreatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the job was created.

JobId
Type: string

The job's ID.

JobType
Type: string

The job's type.

LastUpdatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the job was updated.

Status
Type: string

The job's status.

StatusMessage
Type: string

The job's status message.

PackageImportJobInputConfig

Description

A configuration for a package import job.

Members
PackageVersionInputConfig
Type: PackageVersionInputConfig structure

The package version's input configuration.

PackageImportJobOutput

Description

Results of a package import job.

Members
OutputS3Location
Required: Yes
Type: OutPutS3Location structure

The package's output location.

PackageId
Required: Yes
Type: string

The package's ID.

PackageVersion
Required: Yes
Type: string

The package's version.

PatchVersion
Required: Yes
Type: string

The package's patch version.

PackageImportJobOutputConfig

Description

An output configuration for a package import job.

Members
PackageVersionOutputConfig
Type: PackageVersionOutputConfig structure

The package version's output configuration.

PackageListItem

Description

A package summary.

Members
Arn
Type: string

The package's ARN.

CreatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the package was created.

PackageId
Type: string

The package's ID.

PackageName
Type: string

The package's name.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The package's tags.

PackageObject

Description

A package object.

Members
Name
Required: Yes
Type: string

The object's name.

PackageVersion
Required: Yes
Type: string

The object's package version.

PatchVersion
Required: Yes
Type: string

The object's patch version.

PackageVersionInputConfig

Description

A package version input configuration.

Members
S3Location
Required: Yes
Type: S3Location structure

A location in Amazon S3.

PackageVersionOutputConfig

Description

A package version output configuration.

Members
MarkLatest
Type: boolean

Indicates that the version is recommended for all users.

PackageName
Required: Yes
Type: string

The output's package name.

PackageVersion
Required: Yes
Type: string

The output's package version.

ReportedRuntimeContextState

Description

An application instance's state.

Members
DesiredState
Required: Yes
Type: string

The application's desired state.

DeviceReportedStatus
Required: Yes
Type: string

The application's reported status.

DeviceReportedTime
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

When the device reported the application's state.

RuntimeContextName
Required: Yes
Type: string

The device's name.

ResourceNotFoundException

Description

The target resource was not found.

Members
Message
Required: Yes
Type: string
ResourceId
Required: Yes
Type: string

The resource's ID.

ResourceType
Required: Yes
Type: string

The resource's type.

S3Location

Description

A location in Amazon S3.

Members
BucketName
Required: Yes
Type: string

A bucket name.

ObjectKey
Required: Yes
Type: string

An object key.

Region
Type: string

The bucket's Region.

ServiceQuotaExceededException

Description

The request would cause a limit to be exceeded.

Members
Message
Required: Yes
Type: string
QuotaCode
Required: Yes
Type: string

The name of the limit.

ResourceId
Type: string

The target resource's ID.

ResourceType
Type: string

The target resource's type.

ServiceCode
Required: Yes
Type: string

The name of the service.

StaticIpConnectionInfo

Description

A static IP configuration.

Members
DefaultGateway
Required: Yes
Type: string

The connection's default gateway.

Dns
Required: Yes
Type: Array of strings

The connection's DNS address.

IpAddress
Required: Yes
Type: string

The connection's IP address.

Mask
Required: Yes
Type: string

The connection's DNS mask.

StorageLocation

Description

A storage location.

Members
BinaryPrefixLocation
Required: Yes
Type: string

The location's binary prefix.

Bucket
Required: Yes
Type: string

The location's bucket.

GeneratedPrefixLocation
Required: Yes
Type: string

The location's generated prefix.

ManifestPrefixLocation
Required: Yes
Type: string

The location's manifest prefix.

RepoPrefixLocation
Required: Yes
Type: string

The location's repo prefix.

ValidationException

Description

The request contains an invalid parameter value.

Members
ErrorArguments
Type: Array of ValidationExceptionErrorArgument structures

A list of attributes that led to the exception and their values.

ErrorId
Type: string

A unique ID for the error.

Fields
Type: Array of ValidationExceptionField structures

A list of request parameters that failed validation.

Message
Required: Yes
Type: string
Reason
Type: string

The reason that validation failed.

ValidationExceptionErrorArgument

Description

A validation exception error argument.

Members
Name
Required: Yes
Type: string

The argument's name.

Value
Required: Yes
Type: string

The argument's value.

ValidationExceptionField

Description

A validation exception field.

Members
Message
Required: Yes
Type: string

The field's message.

Name
Required: Yes
Type: string

The field's name.