AssociateRoleToGroup

$result = $client->associateRoleToGroup([/* ... */]);
$promise = $client->associateRoleToGroupAsync([/* ... */]);

Associates a role with a group. Your Greengrass core will use the role to access AWS cloud services. The role's permissions should allow Greengrass core Lambda functions to perform actions against the cloud.

Parameter Syntax

$result = $client->associateRoleToGroup([
    'GroupId' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

General error information.

InternalServerErrorException:

General error information.

AssociateServiceRoleToAccount

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

Associates a role with your account. AWS IoT Greengrass will use the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. The role must have at least minimum permissions in the policy ''AWSGreengrassResourceAccessRolePolicy''.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

General error information.

InternalServerErrorException:

General error information.

CreateConnectorDefinition

$result = $client->createConnectorDefinition([/* ... */]);
$promise = $client->createConnectorDefinitionAsync([/* ... */]);

Creates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time.

Parameter Syntax

$result = $client->createConnectorDefinition([
    'AmznClientToken' => '<string>',
    'InitialVersion' => [
        'Connectors' => [
            [
                'ConnectorArn' => '<string>', // REQUIRED
                'Id' => '<string>', // REQUIRED
                'Parameters' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'Name' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'LastUpdatedTimestamp' => '<string>',
    'LatestVersion' => '<string>',
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

CreateConnectorDefinitionVersion

$result = $client->createConnectorDefinitionVersion([/* ... */]);
$promise = $client->createConnectorDefinitionVersionAsync([/* ... */]);

Creates a version of a connector definition which has already been defined.

Parameter Syntax

$result = $client->createConnectorDefinitionVersion([
    'AmznClientToken' => '<string>',
    'ConnectorDefinitionId' => '<string>', // REQUIRED
    'Connectors' => [
        [
            'ConnectorArn' => '<string>', // REQUIRED
            'Id' => '<string>', // REQUIRED
            'Parameters' => ['<string>', ...],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

CreateCoreDefinition

$result = $client->createCoreDefinition([/* ... */]);
$promise = $client->createCoreDefinitionAsync([/* ... */]);

Creates a core definition. You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass groups must each contain exactly one Greengrass core.

Parameter Syntax

$result = $client->createCoreDefinition([
    'AmznClientToken' => '<string>',
    'InitialVersion' => [
        'Cores' => [
            [
                'CertificateArn' => '<string>', // REQUIRED
                'Id' => '<string>', // REQUIRED
                'SyncShadow' => true || false,
                'ThingArn' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'Name' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'LastUpdatedTimestamp' => '<string>',
    'LatestVersion' => '<string>',
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

CreateCoreDefinitionVersion

$result = $client->createCoreDefinitionVersion([/* ... */]);
$promise = $client->createCoreDefinitionVersionAsync([/* ... */]);

Creates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core.

Parameter Syntax

$result = $client->createCoreDefinitionVersion([
    'AmznClientToken' => '<string>',
    'CoreDefinitionId' => '<string>', // REQUIRED
    'Cores' => [
        [
            'CertificateArn' => '<string>', // REQUIRED
            'Id' => '<string>', // REQUIRED
            'SyncShadow' => true || false,
            'ThingArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

CreateDeployment

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

Creates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters.

Parameter Syntax

$result = $client->createDeployment([
    'AmznClientToken' => '<string>',
    'DeploymentId' => '<string>',
    'DeploymentType' => 'NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment', // REQUIRED
    'GroupId' => '<string>', // REQUIRED
    'GroupVersionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DeploymentArn' => '<string>',
    'DeploymentId' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

CreateDeviceDefinition

$result = $client->createDeviceDefinition([/* ... */]);
$promise = $client->createDeviceDefinitionAsync([/* ... */]);

Creates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time.

Parameter Syntax

$result = $client->createDeviceDefinition([
    'AmznClientToken' => '<string>',
    'InitialVersion' => [
        'Devices' => [
            [
                'CertificateArn' => '<string>', // REQUIRED
                'Id' => '<string>', // REQUIRED
                'SyncShadow' => true || false,
                'ThingArn' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'Name' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'LastUpdatedTimestamp' => '<string>',
    'LatestVersion' => '<string>',
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

CreateDeviceDefinitionVersion

$result = $client->createDeviceDefinitionVersion([/* ... */]);
$promise = $client->createDeviceDefinitionVersionAsync([/* ... */]);

Creates a version of a device definition that has already been defined.

Parameter Syntax

$result = $client->createDeviceDefinitionVersion([
    'AmznClientToken' => '<string>',
    'DeviceDefinitionId' => '<string>', // REQUIRED
    'Devices' => [
        [
            'CertificateArn' => '<string>', // REQUIRED
            'Id' => '<string>', // REQUIRED
            'SyncShadow' => true || false,
            'ThingArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

CreateFunctionDefinition

$result = $client->createFunctionDefinition([/* ... */]);
$promise = $client->createFunctionDefinitionAsync([/* ... */]);

Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group. You can create an initial version of the definition by providing a list of Lambda functions and their configurations now, or use ''CreateFunctionDefinitionVersion'' later.

Parameter Syntax

$result = $client->createFunctionDefinition([
    'AmznClientToken' => '<string>',
    'InitialVersion' => [
        'DefaultConfig' => [
            'Execution' => [
                'IsolationMode' => 'GreengrassContainer|NoContainer',
                'RunAs' => [
                    'Gid' => <integer>,
                    'Uid' => <integer>,
                ],
            ],
        ],
        'Functions' => [
            [
                'FunctionArn' => '<string>',
                'FunctionConfiguration' => [
                    'EncodingType' => 'binary|json',
                    'Environment' => [
                        'AccessSysfs' => true || false,
                        'Execution' => [
                            'IsolationMode' => 'GreengrassContainer|NoContainer',
                            'RunAs' => [
                                'Gid' => <integer>,
                                'Uid' => <integer>,
                            ],
                        ],
                        'ResourceAccessPolicies' => [
                            [
                                'Permission' => 'ro|rw',
                                'ResourceId' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'Variables' => ['<string>', ...],
                    ],
                    'ExecArgs' => '<string>',
                    'Executable' => '<string>',
                    'FunctionRuntimeOverride' => '<string>',
                    'MemorySize' => <integer>,
                    'Pinned' => true || false,
                    'Timeout' => <integer>,
                ],
                'Id' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'Name' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'LastUpdatedTimestamp' => '<string>',
    'LatestVersion' => '<string>',
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

CreateFunctionDefinitionVersion

$result = $client->createFunctionDefinitionVersion([/* ... */]);
$promise = $client->createFunctionDefinitionVersionAsync([/* ... */]);

Creates a version of a Lambda function definition that has already been defined.

Parameter Syntax

$result = $client->createFunctionDefinitionVersion([
    'AmznClientToken' => '<string>',
    'DefaultConfig' => [
        'Execution' => [
            'IsolationMode' => 'GreengrassContainer|NoContainer',
            'RunAs' => [
                'Gid' => <integer>,
                'Uid' => <integer>,
            ],
        ],
    ],
    'FunctionDefinitionId' => '<string>', // REQUIRED
    'Functions' => [
        [
            'FunctionArn' => '<string>',
            'FunctionConfiguration' => [
                'EncodingType' => 'binary|json',
                'Environment' => [
                    'AccessSysfs' => true || false,
                    'Execution' => [
                        'IsolationMode' => 'GreengrassContainer|NoContainer',
                        'RunAs' => [
                            'Gid' => <integer>,
                            'Uid' => <integer>,
                        ],
                    ],
                    'ResourceAccessPolicies' => [
                        [
                            'Permission' => 'ro|rw',
                            'ResourceId' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'Variables' => ['<string>', ...],
                ],
                'ExecArgs' => '<string>',
                'Executable' => '<string>',
                'FunctionRuntimeOverride' => '<string>',
                'MemorySize' => <integer>,
                'Pinned' => true || false,
                'Timeout' => <integer>,
            ],
            'Id' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

CreateGroup

$result = $client->createGroup([/* ... */]);
$promise = $client->createGroupAsync([/* ... */]);

Creates a group. You may provide the initial version of the group or use ''CreateGroupVersion'' at a later time. Tip: You can use the ''gg_group_setup'' package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups.

Parameter Syntax

$result = $client->createGroup([
    'AmznClientToken' => '<string>',
    'InitialVersion' => [
        'ConnectorDefinitionVersionArn' => '<string>',
        'CoreDefinitionVersionArn' => '<string>',
        'DeviceDefinitionVersionArn' => '<string>',
        'FunctionDefinitionVersionArn' => '<string>',
        'LoggerDefinitionVersionArn' => '<string>',
        'ResourceDefinitionVersionArn' => '<string>',
        'SubscriptionDefinitionVersionArn' => '<string>',
    ],
    'Name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'LastUpdatedTimestamp' => '<string>',
    'LatestVersion' => '<string>',
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

CreateGroupCertificateAuthority

$result = $client->createGroupCertificateAuthority([/* ... */]);
$promise = $client->createGroupCertificateAuthorityAsync([/* ... */]);

Creates a CA for the group. If a CA already exists, it will rotate the existing CA.

Parameter Syntax

$result = $client->createGroupCertificateAuthority([
    'AmznClientToken' => '<string>',
    'GroupId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

General error information.

InternalServerErrorException:

General error information.

CreateGroupVersion

$result = $client->createGroupVersion([/* ... */]);
$promise = $client->createGroupVersionAsync([/* ... */]);

Creates a version of a group which has already been defined.

Parameter Syntax

$result = $client->createGroupVersion([
    'AmznClientToken' => '<string>',
    'ConnectorDefinitionVersionArn' => '<string>',
    'CoreDefinitionVersionArn' => '<string>',
    'DeviceDefinitionVersionArn' => '<string>',
    'FunctionDefinitionVersionArn' => '<string>',
    'GroupId' => '<string>', // REQUIRED
    'LoggerDefinitionVersionArn' => '<string>',
    'ResourceDefinitionVersionArn' => '<string>',
    'SubscriptionDefinitionVersionArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

CreateLoggerDefinition

$result = $client->createLoggerDefinition([/* ... */]);
$promise = $client->createLoggerDefinitionAsync([/* ... */]);

Creates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time.

Parameter Syntax

$result = $client->createLoggerDefinition([
    'AmznClientToken' => '<string>',
    'InitialVersion' => [
        'Loggers' => [
            [
                'Component' => 'GreengrassSystem|Lambda', // REQUIRED
                'Id' => '<string>', // REQUIRED
                'Level' => 'DEBUG|INFO|WARN|ERROR|FATAL', // REQUIRED
                'Space' => <integer>,
                'Type' => 'FileSystem|AWSCloudWatch', // REQUIRED
            ],
            // ...
        ],
    ],
    'Name' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'LastUpdatedTimestamp' => '<string>',
    'LatestVersion' => '<string>',
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

CreateLoggerDefinitionVersion

$result = $client->createLoggerDefinitionVersion([/* ... */]);
$promise = $client->createLoggerDefinitionVersionAsync([/* ... */]);

Creates a version of a logger definition that has already been defined.

Parameter Syntax

$result = $client->createLoggerDefinitionVersion([
    'AmznClientToken' => '<string>',
    'LoggerDefinitionId' => '<string>', // REQUIRED
    'Loggers' => [
        [
            'Component' => 'GreengrassSystem|Lambda', // REQUIRED
            'Id' => '<string>', // REQUIRED
            'Level' => 'DEBUG|INFO|WARN|ERROR|FATAL', // REQUIRED
            'Space' => <integer>,
            'Type' => 'FileSystem|AWSCloudWatch', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

CreateResourceDefinition

$result = $client->createResourceDefinition([/* ... */]);
$promise = $client->createResourceDefinitionAsync([/* ... */]);

Creates a resource definition which contains a list of resources to be used in a group. You can create an initial version of the definition by providing a list of resources now, or use ''CreateResourceDefinitionVersion'' later.

Parameter Syntax

$result = $client->createResourceDefinition([
    'AmznClientToken' => '<string>',
    'InitialVersion' => [
        'Resources' => [
            [
                'Id' => '<string>', // REQUIRED
                'Name' => '<string>', // REQUIRED
                'ResourceDataContainer' => [ // REQUIRED
                    'LocalDeviceResourceData' => [
                        'GroupOwnerSetting' => [
                            'AutoAddGroupOwner' => true || false,
                            'GroupOwner' => '<string>',
                        ],
                        'SourcePath' => '<string>',
                    ],
                    'LocalVolumeResourceData' => [
                        'DestinationPath' => '<string>',
                        'GroupOwnerSetting' => [
                            'AutoAddGroupOwner' => true || false,
                            'GroupOwner' => '<string>',
                        ],
                        'SourcePath' => '<string>',
                    ],
                    'S3MachineLearningModelResourceData' => [
                        'DestinationPath' => '<string>',
                        'OwnerSetting' => [
                            'GroupOwner' => '<string>', // REQUIRED
                            'GroupPermission' => 'ro|rw', // REQUIRED
                        ],
                        'S3Uri' => '<string>',
                    ],
                    'SageMakerMachineLearningModelResourceData' => [
                        'DestinationPath' => '<string>',
                        'OwnerSetting' => [
                            'GroupOwner' => '<string>', // REQUIRED
                            'GroupPermission' => 'ro|rw', // REQUIRED
                        ],
                        'SageMakerJobArn' => '<string>',
                    ],
                    'SecretsManagerSecretResourceData' => [
                        'ARN' => '<string>',
                        'AdditionalStagingLabelsToDownload' => ['<string>', ...],
                    ],
                ],
            ],
            // ...
        ],
    ],
    'Name' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'LastUpdatedTimestamp' => '<string>',
    'LatestVersion' => '<string>',
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

CreateResourceDefinitionVersion

$result = $client->createResourceDefinitionVersion([/* ... */]);
$promise = $client->createResourceDefinitionVersionAsync([/* ... */]);

Creates a version of a resource definition that has already been defined.

Parameter Syntax

$result = $client->createResourceDefinitionVersion([
    'AmznClientToken' => '<string>',
    'ResourceDefinitionId' => '<string>', // REQUIRED
    'Resources' => [
        [
            'Id' => '<string>', // REQUIRED
            'Name' => '<string>', // REQUIRED
            'ResourceDataContainer' => [ // REQUIRED
                'LocalDeviceResourceData' => [
                    'GroupOwnerSetting' => [
                        'AutoAddGroupOwner' => true || false,
                        'GroupOwner' => '<string>',
                    ],
                    'SourcePath' => '<string>',
                ],
                'LocalVolumeResourceData' => [
                    'DestinationPath' => '<string>',
                    'GroupOwnerSetting' => [
                        'AutoAddGroupOwner' => true || false,
                        'GroupOwner' => '<string>',
                    ],
                    'SourcePath' => '<string>',
                ],
                'S3MachineLearningModelResourceData' => [
                    'DestinationPath' => '<string>',
                    'OwnerSetting' => [
                        'GroupOwner' => '<string>', // REQUIRED
                        'GroupPermission' => 'ro|rw', // REQUIRED
                    ],
                    'S3Uri' => '<string>',
                ],
                'SageMakerMachineLearningModelResourceData' => [
                    'DestinationPath' => '<string>',
                    'OwnerSetting' => [
                        'GroupOwner' => '<string>', // REQUIRED
                        'GroupPermission' => 'ro|rw', // REQUIRED
                    ],
                    'SageMakerJobArn' => '<string>',
                ],
                'SecretsManagerSecretResourceData' => [
                    'ARN' => '<string>',
                    'AdditionalStagingLabelsToDownload' => ['<string>', ...],
                ],
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

CreateSoftwareUpdateJob

$result = $client->createSoftwareUpdateJob([/* ... */]);
$promise = $client->createSoftwareUpdateJobAsync([/* ... */]);

Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs feature which provides additional commands to manage a Greengrass core software update job.

Parameter Syntax

$result = $client->createSoftwareUpdateJob([
    'AmznClientToken' => '<string>',
    'S3UrlSignerRole' => '<string>', // REQUIRED
    'SoftwareToUpdate' => 'core|ota_agent', // REQUIRED
    'UpdateAgentLogLevel' => 'NONE|TRACE|DEBUG|VERBOSE|INFO|WARN|ERROR|FATAL',
    'UpdateTargets' => ['<string>', ...], // REQUIRED
    'UpdateTargetsArchitecture' => 'armv6l|armv7l|x86_64|aarch64', // REQUIRED
    'UpdateTargetsOperatingSystem' => 'ubuntu|raspbian|amazon_linux|openwrt', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'IotJobArn' => '<string>',
    'IotJobId' => '<string>',
    'PlatformSoftwareVersion' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

InternalServerErrorException:

General error information.

CreateSubscriptionDefinition

$result = $client->createSubscriptionDefinition([/* ... */]);
$promise = $client->createSubscriptionDefinitionAsync([/* ... */]);

Creates a subscription definition. You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time.

Parameter Syntax

$result = $client->createSubscriptionDefinition([
    'AmznClientToken' => '<string>',
    'InitialVersion' => [
        'Subscriptions' => [
            [
                'Id' => '<string>', // REQUIRED
                'Source' => '<string>', // REQUIRED
                'Subject' => '<string>', // REQUIRED
                'Target' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'Name' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'LastUpdatedTimestamp' => '<string>',
    'LatestVersion' => '<string>',
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

CreateSubscriptionDefinitionVersion

$result = $client->createSubscriptionDefinitionVersion([/* ... */]);
$promise = $client->createSubscriptionDefinitionVersionAsync([/* ... */]);

Creates a version of a subscription definition which has already been defined.

Parameter Syntax

$result = $client->createSubscriptionDefinitionVersion([
    'AmznClientToken' => '<string>',
    'SubscriptionDefinitionId' => '<string>', // REQUIRED
    'Subscriptions' => [
        [
            'Id' => '<string>', // REQUIRED
            'Source' => '<string>', // REQUIRED
            'Subject' => '<string>', // REQUIRED
            'Target' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

DeleteConnectorDefinition

$result = $client->deleteConnectorDefinition([/* ... */]);
$promise = $client->deleteConnectorDefinitionAsync([/* ... */]);

Deletes a connector definition.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

DeleteCoreDefinition

$result = $client->deleteCoreDefinition([/* ... */]);
$promise = $client->deleteCoreDefinitionAsync([/* ... */]);

Deletes a core definition.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

DeleteDeviceDefinition

$result = $client->deleteDeviceDefinition([/* ... */]);
$promise = $client->deleteDeviceDefinitionAsync([/* ... */]);

Deletes a device definition.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

DeleteFunctionDefinition

$result = $client->deleteFunctionDefinition([/* ... */]);
$promise = $client->deleteFunctionDefinitionAsync([/* ... */]);

Deletes a Lambda function definition.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

DeleteGroup

$result = $client->deleteGroup([/* ... */]);
$promise = $client->deleteGroupAsync([/* ... */]);

Deletes a group.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

DeleteLoggerDefinition

$result = $client->deleteLoggerDefinition([/* ... */]);
$promise = $client->deleteLoggerDefinitionAsync([/* ... */]);

Deletes a logger definition.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

DeleteResourceDefinition

$result = $client->deleteResourceDefinition([/* ... */]);
$promise = $client->deleteResourceDefinitionAsync([/* ... */]);

Deletes a resource definition.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

DeleteSubscriptionDefinition

$result = $client->deleteSubscriptionDefinition([/* ... */]);
$promise = $client->deleteSubscriptionDefinitionAsync([/* ... */]);

Deletes a subscription definition.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

DisassociateRoleFromGroup

$result = $client->disassociateRoleFromGroup([/* ... */]);
$promise = $client->disassociateRoleFromGroupAsync([/* ... */]);

Disassociates the role from a group.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

General error information.

InternalServerErrorException:

General error information.

DisassociateServiceRoleFromAccount

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

Disassociates the service role from your account. Without a service role, deployments will not work.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InternalServerErrorException:

General error information.

GetAssociatedRole

$result = $client->getAssociatedRole([/* ... */]);
$promise = $client->getAssociatedRoleAsync([/* ... */]);

Retrieves the role associated with a particular group.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AssociatedAt' => '<string>',
    'RoleArn' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

InternalServerErrorException:

General error information.

GetBulkDeploymentStatus

$result = $client->getBulkDeploymentStatus([/* ... */]);
$promise = $client->getBulkDeploymentStatusAsync([/* ... */]);

Returns the status of a bulk deployment.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'BulkDeploymentMetrics' => [
        'InvalidInputRecords' => <integer>,
        'RecordsProcessed' => <integer>,
        'RetryAttempts' => <integer>,
    ],
    'BulkDeploymentStatus' => 'Initializing|Running|Completed|Stopping|Stopped|Failed',
    'CreatedAt' => '<string>',
    'ErrorDetails' => [
        [
            'DetailedErrorCode' => '<string>',
            'DetailedErrorMessage' => '<string>',
        ],
        // ...
    ],
    'ErrorMessage' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

General error information.

GetConnectivityInfo

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

Retrieves the connectivity information for a core.

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

BadRequestException:

General error information.

InternalServerErrorException:

General error information.

GetConnectorDefinition

$result = $client->getConnectorDefinition([/* ... */]);
$promise = $client->getConnectorDefinitionAsync([/* ... */]);

Retrieves information about a connector definition.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'LastUpdatedTimestamp' => '<string>',
    'LatestVersion' => '<string>',
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

General error information.

GetConnectorDefinitionVersion

$result = $client->getConnectorDefinitionVersion([/* ... */]);
$promise = $client->getConnectorDefinitionVersionAsync([/* ... */]);

Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services.

Parameter Syntax

$result = $client->getConnectorDefinitionVersion([
    'ConnectorDefinitionId' => '<string>', // REQUIRED
    'ConnectorDefinitionVersionId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Definition' => [
        'Connectors' => [
            [
                'ConnectorArn' => '<string>',
                'Id' => '<string>',
                'Parameters' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'Id' => '<string>',
    'NextToken' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

GetCoreDefinition

$result = $client->getCoreDefinition([/* ... */]);
$promise = $client->getCoreDefinitionAsync([/* ... */]);

Retrieves information about a core definition version.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'LastUpdatedTimestamp' => '<string>',
    'LatestVersion' => '<string>',
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

General error information.

GetCoreDefinitionVersion

$result = $client->getCoreDefinitionVersion([/* ... */]);
$promise = $client->getCoreDefinitionVersionAsync([/* ... */]);

Retrieves information about a core definition version.

Parameter Syntax

$result = $client->getCoreDefinitionVersion([
    'CoreDefinitionId' => '<string>', // REQUIRED
    'CoreDefinitionVersionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Definition' => [
        'Cores' => [
            [
                'CertificateArn' => '<string>',
                'Id' => '<string>',
                'SyncShadow' => true || false,
                'ThingArn' => '<string>',
            ],
            // ...
        ],
    ],
    'Id' => '<string>',
    'NextToken' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

GetDeploymentStatus

$result = $client->getDeploymentStatus([/* ... */]);
$promise = $client->getDeploymentStatusAsync([/* ... */]);

Returns the status of a deployment.

Parameter Syntax

$result = $client->getDeploymentStatus([
    'DeploymentId' => '<string>', // REQUIRED
    'GroupId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DeploymentStatus' => '<string>',
    'DeploymentType' => 'NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment',
    'ErrorDetails' => [
        [
            'DetailedErrorCode' => '<string>',
            'DetailedErrorMessage' => '<string>',
        ],
        // ...
    ],
    'ErrorMessage' => '<string>',
    'UpdatedAt' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

GetDeviceDefinition

$result = $client->getDeviceDefinition([/* ... */]);
$promise = $client->getDeviceDefinitionAsync([/* ... */]);

Retrieves information about a device definition.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'LastUpdatedTimestamp' => '<string>',
    'LatestVersion' => '<string>',
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

General error information.

GetDeviceDefinitionVersion

$result = $client->getDeviceDefinitionVersion([/* ... */]);
$promise = $client->getDeviceDefinitionVersionAsync([/* ... */]);

Retrieves information about a device definition version.

Parameter Syntax

$result = $client->getDeviceDefinitionVersion([
    'DeviceDefinitionId' => '<string>', // REQUIRED
    'DeviceDefinitionVersionId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Definition' => [
        'Devices' => [
            [
                'CertificateArn' => '<string>',
                'Id' => '<string>',
                'SyncShadow' => true || false,
                'ThingArn' => '<string>',
            ],
            // ...
        ],
    ],
    'Id' => '<string>',
    'NextToken' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

GetFunctionDefinition

$result = $client->getFunctionDefinition([/* ... */]);
$promise = $client->getFunctionDefinitionAsync([/* ... */]);

Retrieves information about a Lambda function definition, including its creation time and latest version.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'LastUpdatedTimestamp' => '<string>',
    'LatestVersion' => '<string>',
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

General error information.

GetFunctionDefinitionVersion

$result = $client->getFunctionDefinitionVersion([/* ... */]);
$promise = $client->getFunctionDefinitionVersionAsync([/* ... */]);

Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.

Parameter Syntax

$result = $client->getFunctionDefinitionVersion([
    'FunctionDefinitionId' => '<string>', // REQUIRED
    'FunctionDefinitionVersionId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Definition' => [
        'DefaultConfig' => [
            'Execution' => [
                'IsolationMode' => 'GreengrassContainer|NoContainer',
                'RunAs' => [
                    'Gid' => <integer>,
                    'Uid' => <integer>,
                ],
            ],
        ],
        'Functions' => [
            [
                'FunctionArn' => '<string>',
                'FunctionConfiguration' => [
                    'EncodingType' => 'binary|json',
                    'Environment' => [
                        'AccessSysfs' => true || false,
                        'Execution' => [
                            'IsolationMode' => 'GreengrassContainer|NoContainer',
                            'RunAs' => [
                                'Gid' => <integer>,
                                'Uid' => <integer>,
                            ],
                        ],
                        'ResourceAccessPolicies' => [
                            [
                                'Permission' => 'ro|rw',
                                'ResourceId' => '<string>',
                            ],
                            // ...
                        ],
                        'Variables' => ['<string>', ...],
                    ],
                    'ExecArgs' => '<string>',
                    'Executable' => '<string>',
                    'FunctionRuntimeOverride' => '<string>',
                    'MemorySize' => <integer>,
                    'Pinned' => true || false,
                    'Timeout' => <integer>,
                ],
                'Id' => '<string>',
            ],
            // ...
        ],
    ],
    'Id' => '<string>',
    'NextToken' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

GetGroup

$result = $client->getGroup([/* ... */]);
$promise = $client->getGroupAsync([/* ... */]);

Retrieves information about a group.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'LastUpdatedTimestamp' => '<string>',
    'LatestVersion' => '<string>',
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

General error information.

GetGroupCertificateAuthority

$result = $client->getGroupCertificateAuthority([/* ... */]);
$promise = $client->getGroupCertificateAuthorityAsync([/* ... */]);

Retreives the CA associated with a group. Returns the public key of the CA.

Parameter Syntax

$result = $client->getGroupCertificateAuthority([
    'CertificateAuthorityId' => '<string>', // REQUIRED
    'GroupId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GroupCertificateAuthorityArn' => '<string>',
    'GroupCertificateAuthorityId' => '<string>',
    'PemEncodedCertificate' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

InternalServerErrorException:

General error information.

GetGroupCertificateConfiguration

$result = $client->getGroupCertificateConfiguration([/* ... */]);
$promise = $client->getGroupCertificateConfigurationAsync([/* ... */]);

Retrieves the current configuration for the CA used by the group.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CertificateAuthorityExpiryInMilliseconds' => '<string>',
    'CertificateExpiryInMilliseconds' => '<string>',
    'GroupId' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

InternalServerErrorException:

General error information.

GetGroupVersion

$result = $client->getGroupVersion([/* ... */]);
$promise = $client->getGroupVersionAsync([/* ... */]);

Retrieves information about a group version.

Parameter Syntax

$result = $client->getGroupVersion([
    'GroupId' => '<string>', // REQUIRED
    'GroupVersionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Definition' => [
        'ConnectorDefinitionVersionArn' => '<string>',
        'CoreDefinitionVersionArn' => '<string>',
        'DeviceDefinitionVersionArn' => '<string>',
        'FunctionDefinitionVersionArn' => '<string>',
        'LoggerDefinitionVersionArn' => '<string>',
        'ResourceDefinitionVersionArn' => '<string>',
        'SubscriptionDefinitionVersionArn' => '<string>',
    ],
    'Id' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

GetLoggerDefinition

$result = $client->getLoggerDefinition([/* ... */]);
$promise = $client->getLoggerDefinitionAsync([/* ... */]);

Retrieves information about a logger definition.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'LastUpdatedTimestamp' => '<string>',
    'LatestVersion' => '<string>',
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

General error information.

GetLoggerDefinitionVersion

$result = $client->getLoggerDefinitionVersion([/* ... */]);
$promise = $client->getLoggerDefinitionVersionAsync([/* ... */]);

Retrieves information about a logger definition version.

Parameter Syntax

$result = $client->getLoggerDefinitionVersion([
    'LoggerDefinitionId' => '<string>', // REQUIRED
    'LoggerDefinitionVersionId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Definition' => [
        'Loggers' => [
            [
                'Component' => 'GreengrassSystem|Lambda',
                'Id' => '<string>',
                'Level' => 'DEBUG|INFO|WARN|ERROR|FATAL',
                'Space' => <integer>,
                'Type' => 'FileSystem|AWSCloudWatch',
            ],
            // ...
        ],
    ],
    'Id' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

GetResourceDefinition

$result = $client->getResourceDefinition([/* ... */]);
$promise = $client->getResourceDefinitionAsync([/* ... */]);

Retrieves information about a resource definition, including its creation time and latest version.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'LastUpdatedTimestamp' => '<string>',
    'LatestVersion' => '<string>',
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

General error information.

GetResourceDefinitionVersion

$result = $client->getResourceDefinitionVersion([/* ... */]);
$promise = $client->getResourceDefinitionVersionAsync([/* ... */]);

Retrieves information about a resource definition version, including which resources are included in the version.

Parameter Syntax

$result = $client->getResourceDefinitionVersion([
    'ResourceDefinitionId' => '<string>', // REQUIRED
    'ResourceDefinitionVersionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Definition' => [
        'Resources' => [
            [
                'Id' => '<string>',
                'Name' => '<string>',
                'ResourceDataContainer' => [
                    'LocalDeviceResourceData' => [
                        'GroupOwnerSetting' => [
                            'AutoAddGroupOwner' => true || false,
                            'GroupOwner' => '<string>',
                        ],
                        'SourcePath' => '<string>',
                    ],
                    'LocalVolumeResourceData' => [
                        'DestinationPath' => '<string>',
                        'GroupOwnerSetting' => [
                            'AutoAddGroupOwner' => true || false,
                            'GroupOwner' => '<string>',
                        ],
                        'SourcePath' => '<string>',
                    ],
                    'S3MachineLearningModelResourceData' => [
                        'DestinationPath' => '<string>',
                        'OwnerSetting' => [
                            'GroupOwner' => '<string>',
                            'GroupPermission' => 'ro|rw',
                        ],
                        'S3Uri' => '<string>',
                    ],
                    'SageMakerMachineLearningModelResourceData' => [
                        'DestinationPath' => '<string>',
                        'OwnerSetting' => [
                            'GroupOwner' => '<string>',
                            'GroupPermission' => 'ro|rw',
                        ],
                        'SageMakerJobArn' => '<string>',
                    ],
                    'SecretsManagerSecretResourceData' => [
                        'ARN' => '<string>',
                        'AdditionalStagingLabelsToDownload' => ['<string>', ...],
                    ],
                ],
            ],
            // ...
        ],
    ],
    'Id' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

GetServiceRoleForAccount

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

Retrieves the service role that is attached to your account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AssociatedAt' => '<string>',
    'RoleArn' => '<string>',
]

Result Details

Errors

InternalServerErrorException:

General error information.

GetSubscriptionDefinition

$result = $client->getSubscriptionDefinition([/* ... */]);
$promise = $client->getSubscriptionDefinitionAsync([/* ... */]);

Retrieves information about a subscription definition.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Id' => '<string>',
    'LastUpdatedTimestamp' => '<string>',
    'LatestVersion' => '<string>',
    'LatestVersionArn' => '<string>',
    'Name' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

General error information.

GetSubscriptionDefinitionVersion

$result = $client->getSubscriptionDefinitionVersion([/* ... */]);
$promise = $client->getSubscriptionDefinitionVersionAsync([/* ... */]);

Retrieves information about a subscription definition version.

Parameter Syntax

$result = $client->getSubscriptionDefinitionVersion([
    'NextToken' => '<string>',
    'SubscriptionDefinitionId' => '<string>', // REQUIRED
    'SubscriptionDefinitionVersionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationTimestamp' => '<string>',
    'Definition' => [
        'Subscriptions' => [
            [
                'Id' => '<string>',
                'Source' => '<string>',
                'Subject' => '<string>',
                'Target' => '<string>',
            ],
            // ...
        ],
    ],
    'Id' => '<string>',
    'NextToken' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

GetThingRuntimeConfiguration

$result = $client->getThingRuntimeConfiguration([/* ... */]);
$promise = $client->getThingRuntimeConfigurationAsync([/* ... */]);

Get the runtime configuration of a thing.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'RuntimeConfiguration' => [
        'TelemetryConfiguration' => [
            'ConfigurationSyncStatus' => 'InSync|OutOfSync',
            'Telemetry' => 'On|Off',
        ],
    ],
]

Result Details

Errors

BadRequestException:

General error information.

InternalServerErrorException:

General error information.

ListBulkDeploymentDetailedReports

$result = $client->listBulkDeploymentDetailedReports([/* ... */]);
$promise = $client->listBulkDeploymentDetailedReportsAsync([/* ... */]);

Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.

Parameter Syntax

$result = $client->listBulkDeploymentDetailedReports([
    'BulkDeploymentId' => '<string>', // REQUIRED
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Deployments' => [
        [
            'CreatedAt' => '<string>',
            'DeploymentArn' => '<string>',
            'DeploymentId' => '<string>',
            'DeploymentStatus' => '<string>',
            'DeploymentType' => 'NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment',
            'ErrorDetails' => [
                [
                    'DetailedErrorCode' => '<string>',
                    'DetailedErrorMessage' => '<string>',
                ],
                // ...
            ],
            'ErrorMessage' => '<string>',
            'GroupArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

ListBulkDeployments

$result = $client->listBulkDeployments([/* ... */]);
$promise = $client->listBulkDeploymentsAsync([/* ... */]);

Returns a list of bulk deployments.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'BulkDeployments' => [
        [
            'BulkDeploymentArn' => '<string>',
            'BulkDeploymentId' => '<string>',
            'CreatedAt' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

ListConnectorDefinitionVersions

$result = $client->listConnectorDefinitionVersions([/* ... */]);
$promise = $client->listConnectorDefinitionVersionsAsync([/* ... */]);

Lists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.

Parameter Syntax

$result = $client->listConnectorDefinitionVersions([
    'ConnectorDefinitionId' => '<string>', // REQUIRED
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Versions' => [
        [
            'Arn' => '<string>',
            'CreationTimestamp' => '<string>',
            'Id' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

General error information.

ListConnectorDefinitions

$result = $client->listConnectorDefinitions([/* ... */]);
$promise = $client->listConnectorDefinitionsAsync([/* ... */]);

Retrieves a list of connector definitions.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Definitions' => [
        [
            'Arn' => '<string>',
            'CreationTimestamp' => '<string>',
            'Id' => '<string>',
            'LastUpdatedTimestamp' => '<string>',
            'LatestVersion' => '<string>',
            'LatestVersionArn' => '<string>',
            'Name' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListCoreDefinitionVersions

$result = $client->listCoreDefinitionVersions([/* ... */]);
$promise = $client->listCoreDefinitionVersionsAsync([/* ... */]);

Lists the versions of a core definition.

Parameter Syntax

$result = $client->listCoreDefinitionVersions([
    'CoreDefinitionId' => '<string>', // REQUIRED
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Versions' => [
        [
            'Arn' => '<string>',
            'CreationTimestamp' => '<string>',
            'Id' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

General error information.

ListCoreDefinitions

$result = $client->listCoreDefinitions([/* ... */]);
$promise = $client->listCoreDefinitionsAsync([/* ... */]);

Retrieves a list of core definitions.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Definitions' => [
        [
            'Arn' => '<string>',
            'CreationTimestamp' => '<string>',
            'Id' => '<string>',
            'LastUpdatedTimestamp' => '<string>',
            'LatestVersion' => '<string>',
            'LatestVersionArn' => '<string>',
            'Name' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListDeployments

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

Returns a history of deployments for the group.

Parameter Syntax

$result = $client->listDeployments([
    'GroupId' => '<string>', // REQUIRED
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Deployments' => [
        [
            'CreatedAt' => '<string>',
            'DeploymentArn' => '<string>',
            'DeploymentId' => '<string>',
            'DeploymentType' => 'NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment',
            'GroupArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

ListDeviceDefinitionVersions

$result = $client->listDeviceDefinitionVersions([/* ... */]);
$promise = $client->listDeviceDefinitionVersionsAsync([/* ... */]);

Lists the versions of a device definition.

Parameter Syntax

$result = $client->listDeviceDefinitionVersions([
    'DeviceDefinitionId' => '<string>', // REQUIRED
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Versions' => [
        [
            'Arn' => '<string>',
            'CreationTimestamp' => '<string>',
            'Id' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

General error information.

ListDeviceDefinitions

$result = $client->listDeviceDefinitions([/* ... */]);
$promise = $client->listDeviceDefinitionsAsync([/* ... */]);

Retrieves a list of device definitions.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Definitions' => [
        [
            'Arn' => '<string>',
            'CreationTimestamp' => '<string>',
            'Id' => '<string>',
            'LastUpdatedTimestamp' => '<string>',
            'LatestVersion' => '<string>',
            'LatestVersionArn' => '<string>',
            'Name' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListFunctionDefinitionVersions

$result = $client->listFunctionDefinitionVersions([/* ... */]);
$promise = $client->listFunctionDefinitionVersionsAsync([/* ... */]);

Lists the versions of a Lambda function definition.

Parameter Syntax

$result = $client->listFunctionDefinitionVersions([
    'FunctionDefinitionId' => '<string>', // REQUIRED
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Versions' => [
        [
            'Arn' => '<string>',
            'CreationTimestamp' => '<string>',
            'Id' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

General error information.

ListFunctionDefinitions

$result = $client->listFunctionDefinitions([/* ... */]);
$promise = $client->listFunctionDefinitionsAsync([/* ... */]);

Retrieves a list of Lambda function definitions.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Definitions' => [
        [
            'Arn' => '<string>',
            'CreationTimestamp' => '<string>',
            'Id' => '<string>',
            'LastUpdatedTimestamp' => '<string>',
            'LatestVersion' => '<string>',
            'LatestVersionArn' => '<string>',
            'Name' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListGroupCertificateAuthorities

$result = $client->listGroupCertificateAuthorities([/* ... */]);
$promise = $client->listGroupCertificateAuthoritiesAsync([/* ... */]);

Retrieves the current CAs for a group.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'GroupCertificateAuthorities' => [
        [
            'GroupCertificateAuthorityArn' => '<string>',
            'GroupCertificateAuthorityId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

General error information.

InternalServerErrorException:

General error information.

ListGroupVersions

$result = $client->listGroupVersions([/* ... */]);
$promise = $client->listGroupVersionsAsync([/* ... */]);

Lists the versions of a group.

Parameter Syntax

$result = $client->listGroupVersions([
    'GroupId' => '<string>', // REQUIRED
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Versions' => [
        [
            'Arn' => '<string>',
            'CreationTimestamp' => '<string>',
            'Id' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

General error information.

ListGroups

$result = $client->listGroups([/* ... */]);
$promise = $client->listGroupsAsync([/* ... */]);

Retrieves a list of groups.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Groups' => [
        [
            'Arn' => '<string>',
            'CreationTimestamp' => '<string>',
            'Id' => '<string>',
            'LastUpdatedTimestamp' => '<string>',
            'LatestVersion' => '<string>',
            'LatestVersionArn' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListLoggerDefinitionVersions

$result = $client->listLoggerDefinitionVersions([/* ... */]);
$promise = $client->listLoggerDefinitionVersionsAsync([/* ... */]);

Lists the versions of a logger definition.

Parameter Syntax

$result = $client->listLoggerDefinitionVersions([
    'LoggerDefinitionId' => '<string>', // REQUIRED
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Versions' => [
        [
            'Arn' => '<string>',
            'CreationTimestamp' => '<string>',
            'Id' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

General error information.

ListLoggerDefinitions

$result = $client->listLoggerDefinitions([/* ... */]);
$promise = $client->listLoggerDefinitionsAsync([/* ... */]);

Retrieves a list of logger definitions.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Definitions' => [
        [
            'Arn' => '<string>',
            'CreationTimestamp' => '<string>',
            'Id' => '<string>',
            'LastUpdatedTimestamp' => '<string>',
            'LatestVersion' => '<string>',
            'LatestVersionArn' => '<string>',
            'Name' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListResourceDefinitionVersions

$result = $client->listResourceDefinitionVersions([/* ... */]);
$promise = $client->listResourceDefinitionVersionsAsync([/* ... */]);

Lists the versions of a resource definition.

Parameter Syntax

$result = $client->listResourceDefinitionVersions([
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
    'ResourceDefinitionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Versions' => [
        [
            'Arn' => '<string>',
            'CreationTimestamp' => '<string>',
            'Id' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

General error information.

ListResourceDefinitions

$result = $client->listResourceDefinitions([/* ... */]);
$promise = $client->listResourceDefinitionsAsync([/* ... */]);

Retrieves a list of resource definitions.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Definitions' => [
        [
            'Arn' => '<string>',
            'CreationTimestamp' => '<string>',
            'Id' => '<string>',
            'LastUpdatedTimestamp' => '<string>',
            'LatestVersion' => '<string>',
            'LatestVersionArn' => '<string>',
            'Name' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListSubscriptionDefinitionVersions

$result = $client->listSubscriptionDefinitionVersions([/* ... */]);
$promise = $client->listSubscriptionDefinitionVersionsAsync([/* ... */]);

Lists the versions of a subscription definition.

Parameter Syntax

$result = $client->listSubscriptionDefinitionVersions([
    'MaxResults' => '<string>',
    'NextToken' => '<string>',
    'SubscriptionDefinitionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Versions' => [
        [
            'Arn' => '<string>',
            'CreationTimestamp' => '<string>',
            'Id' => '<string>',
            'Version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

General error information.

ListSubscriptionDefinitions

$result = $client->listSubscriptionDefinitions([/* ... */]);
$promise = $client->listSubscriptionDefinitionsAsync([/* ... */]);

Retrieves a list of subscription definitions.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Definitions' => [
        [
            'Arn' => '<string>',
            'CreationTimestamp' => '<string>',
            'Id' => '<string>',
            'LastUpdatedTimestamp' => '<string>',
            'LatestVersion' => '<string>',
            'LatestVersionArn' => '<string>',
            'Name' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListTagsForResource

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

Retrieves a list of resource tags for a resource arn.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

General error information.

ResetDeployments

$result = $client->resetDeployments([/* ... */]);
$promise = $client->resetDeploymentsAsync([/* ... */]);

Resets a group's deployments.

Parameter Syntax

$result = $client->resetDeployments([
    'AmznClientToken' => '<string>',
    'Force' => true || false,
    'GroupId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DeploymentArn' => '<string>',
    'DeploymentId' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

StartBulkDeployment

$result = $client->startBulkDeployment([/* ... */]);
$promise = $client->startBulkDeploymentAsync([/* ... */]);

Deploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be triggered with an adaptive rate that has a fixed upper limit. We recommend that you include an ''X-Amzn-Client-Token'' token in every ''StartBulkDeployment'' request. These requests are idempotent with respect to the token and the request parameters.

Parameter Syntax

$result = $client->startBulkDeployment([
    'AmznClientToken' => '<string>',
    'ExecutionRoleArn' => '<string>', // REQUIRED
    'InputFileUri' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'BulkDeploymentArn' => '<string>',
    'BulkDeploymentId' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

StopBulkDeployment

$result = $client->stopBulkDeployment([/* ... */]);
$promise = $client->stopBulkDeploymentAsync([/* ... */]);

Stops the execution of a bulk deployment. This action returns a status of ''Stopping'' until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the ''Stopping'' state. This action doesn't rollback completed deployments or cancel pending deployments.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

TagResource

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

Adds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

UntagResource

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

Remove resource tags from a Greengrass Resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

UpdateConnectivityInfo

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

Updates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it.

Parameter Syntax

$result = $client->updateConnectivityInfo([
    'ConnectivityInfo' => [
        [
            'HostAddress' => '<string>',
            'Id' => '<string>',
            'Metadata' => '<string>',
            'PortNumber' => <integer>,
        ],
        // ...
    ],
    'ThingName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Message' => '<string>',
    'Version' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

InternalServerErrorException:

General error information.

UpdateConnectorDefinition

$result = $client->updateConnectorDefinition([/* ... */]);
$promise = $client->updateConnectorDefinitionAsync([/* ... */]);

Updates a connector definition.

Parameter Syntax

$result = $client->updateConnectorDefinition([
    'ConnectorDefinitionId' => '<string>', // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

UpdateCoreDefinition

$result = $client->updateCoreDefinition([/* ... */]);
$promise = $client->updateCoreDefinitionAsync([/* ... */]);

Updates a core definition.

Parameter Syntax

$result = $client->updateCoreDefinition([
    'CoreDefinitionId' => '<string>', // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

UpdateDeviceDefinition

$result = $client->updateDeviceDefinition([/* ... */]);
$promise = $client->updateDeviceDefinitionAsync([/* ... */]);

Updates a device definition.

Parameter Syntax

$result = $client->updateDeviceDefinition([
    'DeviceDefinitionId' => '<string>', // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

UpdateFunctionDefinition

$result = $client->updateFunctionDefinition([/* ... */]);
$promise = $client->updateFunctionDefinitionAsync([/* ... */]);

Updates a Lambda function definition.

Parameter Syntax

$result = $client->updateFunctionDefinition([
    'FunctionDefinitionId' => '<string>', // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

UpdateGroup

$result = $client->updateGroup([/* ... */]);
$promise = $client->updateGroupAsync([/* ... */]);

Updates a group.

Parameter Syntax

$result = $client->updateGroup([
    'GroupId' => '<string>', // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

UpdateGroupCertificateConfiguration

$result = $client->updateGroupCertificateConfiguration([/* ... */]);
$promise = $client->updateGroupCertificateConfigurationAsync([/* ... */]);

Updates the Certificate expiry time for a group.

Parameter Syntax

$result = $client->updateGroupCertificateConfiguration([
    'CertificateExpiryInMilliseconds' => '<string>',
    'GroupId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CertificateAuthorityExpiryInMilliseconds' => '<string>',
    'CertificateExpiryInMilliseconds' => '<string>',
    'GroupId' => '<string>',
]

Result Details

Errors

BadRequestException:

General error information.

InternalServerErrorException:

General error information.

UpdateLoggerDefinition

$result = $client->updateLoggerDefinition([/* ... */]);
$promise = $client->updateLoggerDefinitionAsync([/* ... */]);

Updates a logger definition.

Parameter Syntax

$result = $client->updateLoggerDefinition([
    'LoggerDefinitionId' => '<string>', // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

UpdateResourceDefinition

$result = $client->updateResourceDefinition([/* ... */]);
$promise = $client->updateResourceDefinitionAsync([/* ... */]);

Updates a resource definition.

Parameter Syntax

$result = $client->updateResourceDefinition([
    'Name' => '<string>',
    'ResourceDefinitionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

UpdateSubscriptionDefinition

$result = $client->updateSubscriptionDefinition([/* ... */]);
$promise = $client->updateSubscriptionDefinitionAsync([/* ... */]);

Updates a subscription definition.

Parameter Syntax

$result = $client->updateSubscriptionDefinition([
    'Name' => '<string>',
    'SubscriptionDefinitionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

UpdateThingRuntimeConfiguration

$result = $client->updateThingRuntimeConfiguration([/* ... */]);
$promise = $client->updateThingRuntimeConfigurationAsync([/* ... */]);

Updates the runtime configuration of a thing.

Parameter Syntax

$result = $client->updateThingRuntimeConfiguration([
    'TelemetryConfiguration' => [
        'Telemetry' => 'On|Off', // REQUIRED
    ],
    'ThingName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

General error information.

InternalServerErrorException:

General error information.