GreengrassV2 / Client / list_effective_deployments

list_effective_deployments

GreengrassV2.Client.list_effective_deployments(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_effective_deployments(
    coreDeviceThingName='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

• coreDeviceThingName (string) –

  [REQUIRED]

  The name of the core device. This is also the name of the IoT thing.

• maxResults (integer) – The maximum number of results to be returned per paginated request.

• nextToken (string) – The token to be used for the next set of paginated results.

Return type:

dict

Returns:

Response Syntax

{
    'effectiveDeployments': [
        {
            'deploymentId': 'string',
            'deploymentName': 'string',
            'iotJobId': 'string',
            'iotJobArn': 'string',
            'description': 'string',
            'targetArn': 'string',
            'coreDeviceExecutionStatus': 'IN_PROGRESS'|'QUEUED'|'FAILED'|'COMPLETED'|'TIMED_OUT'|'CANCELED'|'REJECTED'|'SUCCEEDED',
            'reason': 'string',
            'creationTimestamp': datetime(2015, 1, 1),
            'modifiedTimestamp': datetime(2015, 1, 1),
            'statusDetails': {
                'errorStack': [
                    'string',
                ],
                'errorTypes': [
                    'string',
                ]
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • effectiveDeployments (list) –

    A list that summarizes each deployment on the core device.

    • (dict) –

      Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.

      • deploymentId (string) –

        The ID of the deployment.

      • deploymentName (string) –

        The name of the deployment.

      • iotJobId (string) –

        The ID of the IoT job that applies the deployment to target devices.

      • iotJobArn (string) –

        The ARN of the IoT job that applies the deployment to target devices.

      • description (string) –

        The description of the deployment job.

      • targetArn (string) –

        The ARN of the target IoT thing or thing group.

      • coreDeviceExecutionStatus (string) –

        The status of the deployment job on the Greengrass core device.

        • IN_PROGRESS – The deployment job is running.

        • QUEUED – The deployment job is in the job queue and waiting to run.

        • FAILED – The deployment failed. For more information, see the statusDetails field.

        • COMPLETED – The deployment to an IoT thing was completed successfully.

        • TIMED_OUT – The deployment didn’t complete in the allotted time.

        • CANCELED – The deployment was canceled by the user.

        • REJECTED – The deployment was rejected. For more information, see the statusDetails field.

        • SUCCEEDED – The deployment to an IoT thing group was completed successfully.

      • reason (string) –

        The reason code for the update, if the job was updated.

      • creationTimestamp (datetime) –

        The time at which the deployment was created, expressed in ISO 8601 format.

      • modifiedTimestamp (datetime) –

        The time at which the deployment job was last modified, expressed in ISO 8601 format.

      • statusDetails (dict) –

        The status details that explain why a deployment has an error. This response will be null if the deployment is in a success state.

        • errorStack (list) –

          Contains an ordered list of short error codes that range from the most generic error to the most specific one. The error codes describe the reason for failure whenever the coreDeviceExecutionStatus is in a failed state. The response will be an empty list if there is no error.

          • (string) –

        • errorTypes (list) –

          Contains tags which describe the error. You can use the error types to classify errors to assist with remediating the failure. The response will be an empty list if there is no error.

          • (string) –

  • nextToken (string) –

    The token for the next set of results, or null if there are no additional results.

Exceptions

• GreengrassV2.Client.exceptions.ValidationException

• GreengrassV2.Client.exceptions.ResourceNotFoundException

• GreengrassV2.Client.exceptions.AccessDeniedException

• GreengrassV2.Client.exceptions.InternalServerException

• GreengrassV2.Client.exceptions.ThrottlingException