AssociateServiceRoleToAccount

$result = $client->associateServiceRoleToAccount([/* ... */]);
$promise = $client->associateServiceRoleToAccountAsync([/* ... */]);

Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that defines equivalent permissions for the IoT Greengrass features that you use. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

BatchAssociateClientDeviceWithCoreDevice

$result = $client->batchAssociateClientDeviceWithCoreDevice([/* ... */]);
$promise = $client->batchAssociateClientDeviceWithCoreDeviceAsync([/* ... */]);

Associates a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud discovery in the IoT Greengrass V2 Developer Guide.

Parameter Syntax

$result = $client->batchAssociateClientDeviceWithCoreDevice([
    'coreDeviceThingName' => '<string>', // REQUIRED
    'entries' => [
        [
            'thingName' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'errorEntries' => [
        [
            'code' => '<string>',
            'message' => '<string>',
            'thingName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ResourceNotFoundException:

The requested resource can't be found.

AccessDeniedException:

You don't have permission to perform the action.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

BatchDisassociateClientDeviceFromCoreDevice

$result = $client->batchDisassociateClientDeviceFromCoreDevice([/* ... */]);
$promise = $client->batchDisassociateClientDeviceFromCoreDeviceAsync([/* ... */]);

Disassociates a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use cloud discovery to retrieve the core device's connectivity information and certificates.

Parameter Syntax

$result = $client->batchDisassociateClientDeviceFromCoreDevice([
    'coreDeviceThingName' => '<string>', // REQUIRED
    'entries' => [
        [
            'thingName' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'errorEntries' => [
        [
            'code' => '<string>',
            'message' => '<string>',
            'thingName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ResourceNotFoundException:

The requested resource can't be found.

AccessDeniedException:

You don't have permission to perform the action.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

CancelDeployment

$result = $client->cancelDeployment([/* ... */]);
$promise = $client->cancelDeploymentAsync([/* ... */]);

Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this operation doesn't change anything for that device.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

The requested resource can't be found.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

AccessDeniedException:

You don't have permission to perform the action.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

CreateComponentVersion

$result = $client->createComponentVersion([/* ... */]);
$promise = $client->createComponentVersionAsync([/* ... */]);

Creates a component. Components are software that run on Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to IoT Greengrass. Then, you can deploy the component to other core devices.

You can use this operation to do the following:

• Create components from recipes

  Create a component from a recipe, which is a file that defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see IoT Greengrass component recipe reference in the IoT Greengrass V2 Developer Guide.

  To create a component from a recipe, specify inlineRecipe when you call this operation.

• Create components from Lambda functions

  Create a component from an Lambda function that runs on IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2.

  This function accepts Lambda functions in all supported versions of Python, Node.js, and Java runtimes. IoT Greengrass doesn't apply any additional restrictions on deprecated Lambda runtime versions.

  To create a component from a Lambda function, specify lambdaFunction when you call this operation.

  IoT Greengrass currently supports Lambda functions on only Linux core devices.

Parameter Syntax

$result = $client->createComponentVersion([
    'clientToken' => '<string>',
    'inlineRecipe' => <string || resource || Psr\Http\Message\StreamInterface>,
    'lambdaFunction' => [
        'componentDependencies' => [
            '<NonEmptyString>' => [
                'dependencyType' => 'HARD|SOFT',
                'versionRequirement' => '<string>',
            ],
            // ...
        ],
        'componentLambdaParameters' => [
            'environmentVariables' => ['<string>', ...],
            'eventSources' => [
                [
                    'topic' => '<string>', // REQUIRED
                    'type' => 'PUB_SUB|IOT_CORE', // REQUIRED
                ],
                // ...
            ],
            'execArgs' => ['<string>', ...],
            'inputPayloadEncodingType' => 'json|binary',
            'linuxProcessParams' => [
                'containerParams' => [
                    'devices' => [
                        [
                            'addGroupOwner' => true || false,
                            'path' => '<string>', // REQUIRED
                            'permission' => 'ro|rw',
                        ],
                        // ...
                    ],
                    'memorySizeInKB' => <integer>,
                    'mountROSysfs' => true || false,
                    'volumes' => [
                        [
                            'addGroupOwner' => true || false,
                            'destinationPath' => '<string>', // REQUIRED
                            'permission' => 'ro|rw',
                            'sourcePath' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'isolationMode' => 'GreengrassContainer|NoContainer',
            ],
            'maxIdleTimeInSeconds' => <integer>,
            'maxInstancesCount' => <integer>,
            'maxQueueSize' => <integer>,
            'pinned' => true || false,
            'statusTimeoutInSeconds' => <integer>,
            'timeoutInSeconds' => <integer>,
        ],
        'componentName' => '<string>',
        'componentPlatforms' => [
            [
                'attributes' => ['<string>', ...],
                'name' => '<string>',
            ],
            // ...
        ],
        'componentVersion' => '<string>',
        'lambdaArn' => '<string>', // REQUIRED
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'componentName' => '<string>',
    'componentVersion' => '<string>',
    'creationTimestamp' => <DateTime>,
    'status' => [
        'componentState' => 'REQUESTED|INITIATED|DEPLOYABLE|FAILED|DEPRECATED',
        'errors' => ['<string>', ...],
        'message' => '<string>',
        'vendorGuidance' => 'ACTIVE|DISCONTINUED|DELETED',
        'vendorGuidanceMessage' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ServiceQuotaExceededException:

Your request exceeds a service quota. For example, you might have the maximum number of components that you can create.

AccessDeniedException:

You don't have permission to perform the action.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

RequestAlreadyInProgressException:

The request is already in progress. This exception occurs when you use a client token for multiple requests while IoT Greengrass is still processing an earlier request that uses the same client token.

CreateDeployment

$result = $client->createDeployment([/* ... */]);
$promise = $client->createDeploymentAsync([/* ... */]);

Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass deploys that group's deployment to the new device.

You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the new deployment to the target devices.

Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment.

For more information, see the Create deployments in the IoT Greengrass V2 Developer Guide.

Parameter Syntax

$result = $client->createDeployment([
    'clientToken' => '<string>',
    'components' => [
        '<NonEmptyString>' => [
            'componentVersion' => '<string>', // REQUIRED
            'configurationUpdate' => [
                'merge' => '<string>',
                'reset' => ['<string>', ...],
            ],
            'runWith' => [
                'posixUser' => '<string>',
                'systemResourceLimits' => [
                    'cpus' => <float>,
                    'memory' => <integer>,
                ],
                'windowsUser' => '<string>',
            ],
        ],
        // ...
    ],
    'deploymentName' => '<string>',
    'deploymentPolicies' => [
        'componentUpdatePolicy' => [
            'action' => 'NOTIFY_COMPONENTS|SKIP_NOTIFY_COMPONENTS',
            'timeoutInSeconds' => <integer>,
        ],
        'configurationValidationPolicy' => [
            'timeoutInSeconds' => <integer>,
        ],
        'failureHandlingPolicy' => 'ROLLBACK|DO_NOTHING',
    ],
    'iotJobConfiguration' => [
        'abortConfig' => [
            'criteriaList' => [ // REQUIRED
                [
                    'action' => 'CANCEL', // REQUIRED
                    'failureType' => 'FAILED|REJECTED|TIMED_OUT|ALL', // REQUIRED
                    'minNumberOfExecutedThings' => <integer>, // REQUIRED
                    'thresholdPercentage' => <float>, // REQUIRED
                ],
                // ...
            ],
        ],
        'jobExecutionsRolloutConfig' => [
            'exponentialRate' => [
                'baseRatePerMinute' => <integer>, // REQUIRED
                'incrementFactor' => <float>, // REQUIRED
                'rateIncreaseCriteria' => [ // REQUIRED
                    'numberOfNotifiedThings' => <integer>,
                    'numberOfSucceededThings' => <integer>,
                ],
            ],
            'maximumPerMinute' => <integer>,
        ],
        'timeoutConfig' => [
            'inProgressTimeoutInMinutes' => <integer>,
        ],
    ],
    'parentTargetArn' => '<string>',
    'tags' => ['<string>', ...],
    'targetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'deploymentId' => '<string>',
    'iotJobArn' => '<string>',
    'iotJobId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The requested resource can't be found.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

AccessDeniedException:

You don't have permission to perform the action.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

RequestAlreadyInProgressException:

The request is already in progress. This exception occurs when you use a client token for multiple requests while IoT Greengrass is still processing an earlier request that uses the same client token.

DeleteComponent

$result = $client->deleteComponent([/* ... */]);
$promise = $client->deleteComponentAsync([/* ... */]);

Deletes a version of a component from IoT Greengrass.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

AccessDeniedException:

You don't have permission to perform the action.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

DeleteCoreDevice

$result = $client->deleteCoreDevice([/* ... */]);
$promise = $client->deleteCoreDeviceAsync([/* ... */]);

Deletes a Greengrass core device, which is an IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the IoT thing. For more information about how to delete the IoT thing, see DeleteThing in the IoT API Reference.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ResourceNotFoundException:

The requested resource can't be found.

AccessDeniedException:

You don't have permission to perform the action.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

DeleteDeployment

$result = $client->deleteDeployment([/* ... */]);
$promise = $client->deleteDeploymentAsync([/* ... */]);

Deletes a deployment. To delete an active deployment, you must first cancel it. For more information, see CancelDeployment.

Deleting a deployment doesn't affect core devices that run that deployment, because core devices store the deployment's configuration on the device. Additionally, core devices can roll back to a previous deployment that has been deleted.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The requested resource can't be found.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

AccessDeniedException:

You don't have permission to perform the action.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

DescribeComponent

$result = $client->describeComponent([/* ... */]);
$promise = $client->describeComponentAsync([/* ... */]);

Retrieves metadata for a version of a component.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'componentName' => '<string>',
    'componentVersion' => '<string>',
    'creationTimestamp' => <DateTime>,
    'description' => '<string>',
    'platforms' => [
        [
            'attributes' => ['<string>', ...],
            'name' => '<string>',
        ],
        // ...
    ],
    'publisher' => '<string>',
    'status' => [
        'componentState' => 'REQUESTED|INITIATED|DEPLOYABLE|FAILED|DEPRECATED',
        'errors' => ['<string>', ...],
        'message' => '<string>',
        'vendorGuidance' => 'ACTIVE|DISCONTINUED|DELETED',
        'vendorGuidanceMessage' => '<string>',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

AccessDeniedException:

You don't have permission to perform the action.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

DisassociateServiceRoleFromAccount

$result = $client->disassociateServiceRoleFromAccount([/* ... */]);
$promise = $client->disassociateServiceRoleFromAccountAsync([/* ... */]);

Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. Without a service role, IoT Greengrass can't verify the identity of client devices or manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.

Parameter Syntax

$result = $client->disassociateServiceRoleFromAccount([
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

GetComponent

$result = $client->getComponent([/* ... */]);
$promise = $client->getComponentAsync([/* ... */]);

Gets the recipe for a version of a component.

Parameter Syntax

$result = $client->getComponent([
    'arn' => '<string>', // REQUIRED
    'recipeOutputFormat' => 'JSON|YAML',
]);

Parameter Details

Result Syntax

[
    'recipe' => <string || resource || Psr\Http\Message\StreamInterface>,
    'recipeOutputFormat' => 'JSON|YAML',
    'tags' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

AccessDeniedException:

You don't have permission to perform the action.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

GetComponentVersionArtifact

$result = $client->getComponentVersionArtifact([/* ... */]);
$promise = $client->getComponentVersionArtifactAsync([/* ... */]);

Gets the pre-signed URL to download a public or a Lambda component artifact. Core devices call this operation to identify the URL that they can use to download an artifact to install.

Parameter Syntax

$result = $client->getComponentVersionArtifact([
    'arn' => '<string>', // REQUIRED
    'artifactName' => '<string>', // REQUIRED
    'iotEndpointType' => 'fips|standard',
    's3EndpointType' => 'REGIONAL|GLOBAL',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

AccessDeniedException:

You don't have permission to perform the action.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

GetConnectivityInfo

$result = $client->getConnectivityInfo([/* ... */]);
$promise = $client->getConnectivityInfoAsync([/* ... */]);

Retrieves connectivity information for a Greengrass core device.

Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'connectivityInfo' => [
        [
            'hostAddress' => '<string>',
            'id' => '<string>',
            'metadata' => '<string>',
            'portNumber' => <integer>,
        ],
        // ...
    ],
    'message' => '<string>',
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

GetCoreDevice

$result = $client->getCoreDevice([/* ... */]);
$promise = $client->getCoreDeviceAsync([/* ... */]);

Retrieves metadata for a Greengrass core device.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'architecture' => '<string>',
    'coreDeviceThingName' => '<string>',
    'coreVersion' => '<string>',
    'lastStatusUpdateTimestamp' => <DateTime>,
    'platform' => '<string>',
    'status' => 'HEALTHY|UNHEALTHY',
    'tags' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ResourceNotFoundException:

The requested resource can't be found.

AccessDeniedException:

You don't have permission to perform the action.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

GetDeployment

$result = $client->getDeployment([/* ... */]);
$promise = $client->getDeploymentAsync([/* ... */]);

Gets a deployment. Deployments define the components that run on Greengrass core devices.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'components' => [
        '<NonEmptyString>' => [
            'componentVersion' => '<string>',
            'configurationUpdate' => [
                'merge' => '<string>',
                'reset' => ['<string>', ...],
            ],
            'runWith' => [
                'posixUser' => '<string>',
                'systemResourceLimits' => [
                    'cpus' => <float>,
                    'memory' => <integer>,
                ],
                'windowsUser' => '<string>',
            ],
        ],
        // ...
    ],
    'creationTimestamp' => <DateTime>,
    'deploymentId' => '<string>',
    'deploymentName' => '<string>',
    'deploymentPolicies' => [
        'componentUpdatePolicy' => [
            'action' => 'NOTIFY_COMPONENTS|SKIP_NOTIFY_COMPONENTS',
            'timeoutInSeconds' => <integer>,
        ],
        'configurationValidationPolicy' => [
            'timeoutInSeconds' => <integer>,
        ],
        'failureHandlingPolicy' => 'ROLLBACK|DO_NOTHING',
    ],
    'deploymentStatus' => 'ACTIVE|COMPLETED|CANCELED|FAILED|INACTIVE',
    'iotJobArn' => '<string>',
    'iotJobConfiguration' => [
        'abortConfig' => [
            'criteriaList' => [
                [
                    'action' => 'CANCEL',
                    'failureType' => 'FAILED|REJECTED|TIMED_OUT|ALL',
                    'minNumberOfExecutedThings' => <integer>,
                    'thresholdPercentage' => <float>,
                ],
                // ...
            ],
        ],
        'jobExecutionsRolloutConfig' => [
            'exponentialRate' => [
                'baseRatePerMinute' => <integer>,
                'incrementFactor' => <float>,
                'rateIncreaseCriteria' => [
                    'numberOfNotifiedThings' => <integer>,
                    'numberOfSucceededThings' => <integer>,
                ],
            ],
            'maximumPerMinute' => <integer>,
        ],
        'timeoutConfig' => [
            'inProgressTimeoutInMinutes' => <integer>,
        ],
    ],
    'iotJobId' => '<string>',
    'isLatestForTarget' => true || false,
    'parentTargetArn' => '<string>',
    'revisionId' => '<string>',
    'tags' => ['<string>', ...],
    'targetArn' => '<string>',
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ResourceNotFoundException:

The requested resource can't be found.

AccessDeniedException:

You don't have permission to perform the action.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

GetServiceRoleForAccount

$result = $client->getServiceRoleForAccount([/* ... */]);
$promise = $client->getServiceRoleForAccountAsync([/* ... */]);

Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. For more information, see Greengrass service role in the IoT Greengrass Version 2 Developer Guide.

Parameter Syntax

$result = $client->getServiceRoleForAccount([
]);

Parameter Details

Result Syntax

[
    'associatedAt' => '<string>',
    'roleArn' => '<string>',
]

Result Details

Errors

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ListClientDevicesAssociatedWithCoreDevice

$result = $client->listClientDevicesAssociatedWithCoreDevice([/* ... */]);
$promise = $client->listClientDevicesAssociatedWithCoreDeviceAsync([/* ... */]);

Retrieves a paginated list of client devices that are associated with a core device.

Parameter Syntax

$result = $client->listClientDevicesAssociatedWithCoreDevice([
    'coreDeviceThingName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'associatedClientDevices' => [
        [
            'associationTimestamp' => <DateTime>,
            'thingName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ResourceNotFoundException:

The requested resource can't be found.

AccessDeniedException:

You don't have permission to perform the action.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

ListComponentVersions

$result = $client->listComponentVersions([/* ... */]);
$promise = $client->listComponentVersionsAsync([/* ... */]);

Retrieves a paginated list of all versions for a component. Greater versions are listed first.

Parameter Syntax

$result = $client->listComponentVersions([
    'arn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'componentVersions' => [
        [
            'arn' => '<string>',
            'componentName' => '<string>',
            'componentVersion' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

AccessDeniedException:

You don't have permission to perform the action.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ListComponents

$result = $client->listComponents([/* ... */]);
$promise = $client->listComponentsAsync([/* ... */]);

Retrieves a paginated list of component summaries. This list includes components that you have permission to view.

Parameter Syntax

$result = $client->listComponents([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'scope' => 'PRIVATE|PUBLIC',
]);

Parameter Details

Result Syntax

[
    'components' => [
        [
            'arn' => '<string>',
            'componentName' => '<string>',
            'latestVersion' => [
                'arn' => '<string>',
                'componentVersion' => '<string>',
                'creationTimestamp' => <DateTime>,
                'description' => '<string>',
                'platforms' => [
                    [
                        'attributes' => ['<string>', ...],
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'publisher' => '<string>',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

AccessDeniedException:

You don't have permission to perform the action.

ResourceNotFoundException:

The requested resource can't be found.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ListCoreDevices

$result = $client->listCoreDevices([/* ... */]);
$promise = $client->listCoreDevicesAsync([/* ... */]);

Retrieves a paginated list of Greengrass core devices.

Parameter Syntax

$result = $client->listCoreDevices([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'HEALTHY|UNHEALTHY',
    'thingGroupArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'coreDevices' => [
        [
            'coreDeviceThingName' => '<string>',
            'lastStatusUpdateTimestamp' => <DateTime>,
            'status' => 'HEALTHY|UNHEALTHY',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

AccessDeniedException:

You don't have permission to perform the action.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

ListDeployments

$result = $client->listDeployments([/* ... */]);
$promise = $client->listDeploymentsAsync([/* ... */]);

Retrieves a paginated list of deployments.

Parameter Syntax

$result = $client->listDeployments([
    'historyFilter' => 'ALL|LATEST_ONLY',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'parentTargetArn' => '<string>',
    'targetArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'deployments' => [
        [
            'creationTimestamp' => <DateTime>,
            'deploymentId' => '<string>',
            'deploymentName' => '<string>',
            'deploymentStatus' => 'ACTIVE|COMPLETED|CANCELED|FAILED|INACTIVE',
            'isLatestForTarget' => true || false,
            'parentTargetArn' => '<string>',
            'revisionId' => '<string>',
            'targetArn' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

AccessDeniedException:

You don't have permission to perform the action.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

ListEffectiveDeployments

$result = $client->listEffectiveDeployments([/* ... */]);
$promise = $client->listEffectiveDeploymentsAsync([/* ... */]);

Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.

Parameter Syntax

$result = $client->listEffectiveDeployments([
    'coreDeviceThingName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'effectiveDeployments' => [
        [
            'coreDeviceExecutionStatus' => 'IN_PROGRESS|QUEUED|FAILED|COMPLETED|TIMED_OUT|CANCELED|REJECTED|SUCCEEDED',
            'creationTimestamp' => <DateTime>,
            'deploymentId' => '<string>',
            'deploymentName' => '<string>',
            'description' => '<string>',
            'iotJobArn' => '<string>',
            'iotJobId' => '<string>',
            'modifiedTimestamp' => <DateTime>,
            'reason' => '<string>',
            'statusDetails' => [
                'errorStack' => ['<string>', ...],
                'errorTypes' => ['<string>', ...],
            ],
            'targetArn' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ResourceNotFoundException:

The requested resource can't be found.

AccessDeniedException:

You don't have permission to perform the action.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

ListInstalledComponents

$result = $client->listInstalledComponents([/* ... */]);
$promise = $client->listInstalledComponentsAsync([/* ... */]);

Retrieves a paginated list of the components that a Greengrass core device runs. By default, this list doesn't include components that are deployed as dependencies of other components. To include dependencies in the response, set the topologyFilter parameter to ALL.

Parameter Syntax

$result = $client->listInstalledComponents([
    'coreDeviceThingName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'topologyFilter' => 'ALL|ROOT',
]);

Parameter Details

Result Syntax

[
    'installedComponents' => [
        [
            'componentName' => '<string>',
            'componentVersion' => '<string>',
            'isRoot' => true || false,
            'lastInstallationSource' => '<string>',
            'lastReportedTimestamp' => <DateTime>,
            'lastStatusChangeTimestamp' => <DateTime>,
            'lifecycleState' => 'NEW|INSTALLED|STARTING|RUNNING|STOPPING|ERRORED|BROKEN|FINISHED',
            'lifecycleStateDetails' => '<string>',
            'lifecycleStatusCodes' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ResourceNotFoundException:

The requested resource can't be found.

AccessDeniedException:

You don't have permission to perform the action.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

ListTagsForResource

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

Retrieves the list of tags for an IoT Greengrass resource.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ResourceNotFoundException:

The requested resource can't be found.

ResolveComponentCandidates

$result = $client->resolveComponentCandidates([/* ... */]);
$promise = $client->resolveComponentCandidatesAsync([/* ... */]);

Retrieves a list of components that meet the component, version, and platform requirements of a deployment. Greengrass core devices call this operation when they receive a deployment to identify the components to install.

This operation identifies components that meet all dependency requirements for a deployment. If the requirements conflict, then this operation returns an error and the deployment fails. For example, this occurs if component A requires version >2.0.0 and component B requires version <2.0.0 of a component dependency.

When you specify the component candidates to resolve, IoT Greengrass compares each component's digest from the core device with the component's digest in the Amazon Web Services Cloud. If the digests don't match, then IoT Greengrass specifies to use the version from the Amazon Web Services Cloud.

Parameter Syntax

$result = $client->resolveComponentCandidates([
    'componentCandidates' => [
        [
            'componentName' => '<string>',
            'componentVersion' => '<string>',
            'versionRequirements' => ['<string>', ...],
        ],
        // ...
    ],
    'platform' => [
        'attributes' => ['<string>', ...],
        'name' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'resolvedComponentVersions' => [
        [
            'arn' => '<string>',
            'componentName' => '<string>',
            'componentVersion' => '<string>',
            'message' => '<string>',
            'recipe' => <string || resource || Psr\Http\Message\StreamInterface>,
            'vendorGuidance' => 'ACTIVE|DISCONTINUED|DELETED',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

AccessDeniedException:

You don't have permission to perform the action.

ResourceNotFoundException:

The requested resource can't be found.

ConflictException:

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

ThrottlingException:

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

TagResource

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

Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ResourceNotFoundException:

The requested resource can't be found.

UntagResource

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

Removes a tag from an IoT Greengrass resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

ResourceNotFoundException:

The requested resource can't be found.

UpdateConnectivityInfo

$result = $client->updateConnectivityInfo([/* ... */]);
$promise = $client->updateConnectivityInfoAsync([/* ... */]);

Updates connectivity information for a Greengrass core device.

Connectivity information includes endpoints and ports where client devices can connect to an MQTT broker on the core device. When a client device calls the IoT Greengrass discovery API, IoT Greengrass returns connectivity information for all of the core devices where the client device can connect. For more information, see Connect client devices to core devices in the IoT Greengrass Version 2 Developer Guide.

Parameter Syntax

$result = $client->updateConnectivityInfo([
    'connectivityInfo' => [ // REQUIRED
        [
            'hostAddress' => '<string>',
            'id' => '<string>',
            'metadata' => '<string>',
            'portNumber' => <integer>,
        ],
        // ...
    ],
    'thingName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'message' => '<string>',
    'version' => '<string>',
]

Result Details

Errors

ValidationException:

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

InternalServerException:

IoT Greengrass can't process your request right now. Try again later.