AWS Greengrass 2017-06-07
- Client: Aws\Greengrass\GreengrassClient
- Service ID: greengrass
- Version: 2017-06-07
This page describes the parameters and results for the operations of the AWS Greengrass (2017-06-07), and shows how to use the Aws\Greengrass\GreengrassClient object to call the described operations. This documentation is specific to the 2017-06-07 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AssociateRoleToGroup ( array $params = [] )
Associates a role with a group.
- AssociateServiceRoleToAccount ( array $params = [] )
Associates a role with your account.
- CreateConnectorDefinition ( array $params = [] )
Creates a connector definition.
- CreateConnectorDefinitionVersion ( array $params = [] )
Creates a version of a connector definition which has already been defined.
- CreateCoreDefinition ( array $params = [] )
Creates a core definition.
- CreateCoreDefinitionVersion ( array $params = [] )
Creates a version of a core definition that has already been defined.
- CreateDeployment ( array $params = [] )
Creates a deployment.
- CreateDeviceDefinition ( array $params = [] )
Creates a device definition.
- CreateDeviceDefinitionVersion ( array $params = [] )
Creates a version of a device definition that has already been defined.
- CreateFunctionDefinition ( array $params = [] )
Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group.
- CreateFunctionDefinitionVersion ( array $params = [] )
Creates a version of a Lambda function definition that has already been defined.
- CreateGroup ( array $params = [] )
Creates a group.
- CreateGroupCertificateAuthority ( array $params = [] )
Creates a CA for the group.
- CreateGroupVersion ( array $params = [] )
Creates a version of a group which has already been defined.
- CreateLoggerDefinition ( array $params = [] )
Creates a logger definition.
- CreateLoggerDefinitionVersion ( array $params = [] )
Creates a version of a logger definition that has already been defined.
- CreateResourceDefinition ( array $params = [] )
Creates a resource definition which contains a list of resources to be used in a group.
- CreateResourceDefinitionVersion ( array $params = [] )
Creates a version of a resource definition that has already been defined.
- CreateSoftwareUpdateJob ( array $params = [] )
Creates a software update for a core or group of cores (specified as an IoT thing group.
- CreateSubscriptionDefinition ( array $params = [] )
Creates a subscription definition.
- CreateSubscriptionDefinitionVersion ( array $params = [] )
Creates a version of a subscription definition which has already been defined.
- DeleteConnectorDefinition ( array $params = [] )
Deletes a connector definition.
- DeleteCoreDefinition ( array $params = [] )
Deletes a core definition.
- DeleteDeviceDefinition ( array $params = [] )
Deletes a device definition.
- DeleteFunctionDefinition ( array $params = [] )
Deletes a Lambda function definition.
- DeleteGroup ( array $params = [] )
Deletes a group.
- DeleteLoggerDefinition ( array $params = [] )
Deletes a logger definition.
- DeleteResourceDefinition ( array $params = [] )
Deletes a resource definition.
- DeleteSubscriptionDefinition ( array $params = [] )
Deletes a subscription definition.
- DisassociateRoleFromGroup ( array $params = [] )
Disassociates the role from a group.
- DisassociateServiceRoleFromAccount ( array $params = [] )
Disassociates the service role from your account.
- GetAssociatedRole ( array $params = [] )
Retrieves the role associated with a particular group.
- GetBulkDeploymentStatus ( array $params = [] )
Returns the status of a bulk deployment.
- GetConnectivityInfo ( array $params = [] )
Retrieves the connectivity information for a core.
- GetConnectorDefinition ( array $params = [] )
Retrieves information about a connector definition.
- GetConnectorDefinitionVersion ( array $params = [] )
Retrieves information about a connector definition version, including the connectors that the version contains.
- GetCoreDefinition ( array $params = [] )
Retrieves information about a core definition version.
- GetCoreDefinitionVersion ( array $params = [] )
Retrieves information about a core definition version.
- GetDeploymentStatus ( array $params = [] )
Returns the status of a deployment.
- GetDeviceDefinition ( array $params = [] )
Retrieves information about a device definition.
- GetDeviceDefinitionVersion ( array $params = [] )
Retrieves information about a device definition version.
- GetFunctionDefinition ( array $params = [] )
Retrieves information about a Lambda function definition, including its creation time and latest version.
- GetFunctionDefinitionVersion ( array $params = [] )
Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.
- GetGroup ( array $params = [] )
Retrieves information about a group.
- GetGroupCertificateAuthority ( array $params = [] )
Retreives the CA associated with a group.
- GetGroupCertificateConfiguration ( array $params = [] )
Retrieves the current configuration for the CA used by the group.
- GetGroupVersion ( array $params = [] )
Retrieves information about a group version.
- GetLoggerDefinition ( array $params = [] )
Retrieves information about a logger definition.
- GetLoggerDefinitionVersion ( array $params = [] )
Retrieves information about a logger definition version.
- GetResourceDefinition ( array $params = [] )
Retrieves information about a resource definition, including its creation time and latest version.
- GetResourceDefinitionVersion ( array $params = [] )
Retrieves information about a resource definition version, including which resources are included in the version.
- GetServiceRoleForAccount ( array $params = [] )
Retrieves the service role that is attached to your account.
- GetSubscriptionDefinition ( array $params = [] )
Retrieves information about a subscription definition.
- GetSubscriptionDefinitionVersion ( array $params = [] )
Retrieves information about a subscription definition version.
- ListBulkDeploymentDetailedReports ( array $params = [] )
Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.
- ListBulkDeployments ( array $params = [] )
Returns a list of bulk deployments.
- ListConnectorDefinitionVersions ( array $params = [] )
Lists the versions of a connector definition, which are containers for connectors.
- ListConnectorDefinitions ( array $params = [] )
Retrieves a list of connector definitions.
- ListCoreDefinitionVersions ( array $params = [] )
Lists the versions of a core definition.
- ListCoreDefinitions ( array $params = [] )
Retrieves a list of core definitions.
- ListDeployments ( array $params = [] )
Returns a history of deployments for the group.
- ListDeviceDefinitionVersions ( array $params = [] )
Lists the versions of a device definition.
- ListDeviceDefinitions ( array $params = [] )
Retrieves a list of device definitions.
- ListFunctionDefinitionVersions ( array $params = [] )
Lists the versions of a Lambda function definition.
- ListFunctionDefinitions ( array $params = [] )
Retrieves a list of Lambda function definitions.
- ListGroupCertificateAuthorities ( array $params = [] )
Retrieves the current CAs for a group.
- ListGroupVersions ( array $params = [] )
Lists the versions of a group.
- ListGroups ( array $params = [] )
Retrieves a list of groups.
- ListLoggerDefinitionVersions ( array $params = [] )
Lists the versions of a logger definition.
- ListLoggerDefinitions ( array $params = [] )
Retrieves a list of logger definitions.
- ListResourceDefinitionVersions ( array $params = [] )
Lists the versions of a resource definition.
- ListResourceDefinitions ( array $params = [] )
Retrieves a list of resource definitions.
- ListSubscriptionDefinitionVersions ( array $params = [] )
Lists the versions of a subscription definition.
- ListSubscriptionDefinitions ( array $params = [] )
Retrieves a list of subscription definitions.
- ListTagsForResource ( array $params = [] )
Retrieves a list of resource tags for a resource arn.
- ResetDeployments ( array $params = [] )
Resets a group's deployments.
- StartBulkDeployment ( array $params = [] )
Deploys multiple groups in one operation.
- StopBulkDeployment ( array $params = [] )
Stops the execution of a bulk deployment.
- TagResource ( array $params = [] )
Adds tags to a Greengrass resource.
- UntagResource ( array $params = [] )
Remove resource tags from a Greengrass Resource.
- UpdateConnectivityInfo ( array $params = [] )
Updates the connectivity information for the core.
- UpdateConnectorDefinition ( array $params = [] )
Updates a connector definition.
- UpdateCoreDefinition ( array $params = [] )
Updates a core definition.
- UpdateDeviceDefinition ( array $params = [] )
Updates a device definition.
- UpdateFunctionDefinition ( array $params = [] )
Updates a Lambda function definition.
- UpdateGroup ( array $params = [] )
Updates a group.
- UpdateGroupCertificateConfiguration ( array $params = [] )
Updates the Certificate expiry time for a group.
- UpdateLoggerDefinition ( array $params = [] )
Updates a logger definition.
- UpdateResourceDefinition ( array $params = [] )
Updates a resource definition.
- UpdateSubscriptionDefinition ( array $params = [] )
Updates a subscription definition.
Operations
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
Members
Result Syntax
[
'AssociatedAt' => '<string>',
]
Result Details
Members
Errors
-
General error information.
-
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
Members
Result Syntax
[
'AssociatedAt' => '<string>',
]
Result Details
Errors
-
General error information.
-
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
Members
- AmznClientToken
-
- Type: string
- InitialVersion
-
- Type: ConnectorDefinitionVersion structure
Information about the connector definition version, which is a container for connectors. - Name
-
- Type: string
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
The key-value pair for the resource tag.
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'LastUpdatedTimestamp' => '<string>',
'LatestVersion' => '<string>',
'LatestVersionArn' => '<string>',
'Name' => '<string>',
]
Result Details
Members
Errors
-
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
Members
- AmznClientToken
-
- Type: string
- ConnectorDefinitionId
-
- Required: Yes
- Type: string
- Connectors
-
- Type: Array of Connector structures
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'Version' => '<string>',
]
Result Details
Errors
-
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
Members
- AmznClientToken
-
- Type: string
- InitialVersion
-
- Type: CoreDefinitionVersion structure
Information about a core definition version. - Name
-
- Type: string
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
The key-value pair for the resource tag.
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'LastUpdatedTimestamp' => '<string>',
'LatestVersion' => '<string>',
'LatestVersionArn' => '<string>',
'Name' => '<string>',
]
Result Details
Members
Errors
-
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
Members
- AmznClientToken
-
- Type: string
- CoreDefinitionId
-
- Required: Yes
- Type: string
- Cores
-
- Type: Array of Core structures
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'Version' => '<string>',
]
Result Details
Errors
-
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
Members
- AmznClientToken
-
- Type: string
- DeploymentId
-
- Type: string
The ID of the deployment if you wish to redeploy a previous deployment. - DeploymentType
-
- Required: Yes
- Type: string
The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid. - GroupId
-
- Required: Yes
- Type: string
- GroupVersionId
-
- Type: string
The ID of the group version to be deployed.
Result Syntax
[
'DeploymentArn' => '<string>',
'DeploymentId' => '<string>',
]
Result Details
Members
Errors
-
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
Members
- AmznClientToken
-
- Type: string
- InitialVersion
-
- Type: DeviceDefinitionVersion structure
Information about a device definition version. - Name
-
- Type: string
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
The key-value pair for the resource tag.
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'LastUpdatedTimestamp' => '<string>',
'LatestVersion' => '<string>',
'LatestVersionArn' => '<string>',
'Name' => '<string>',
]
Result Details
Members
Errors
-
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
Members
- AmznClientToken
-
- Type: string
- DeviceDefinitionId
-
- Required: Yes
- Type: string
- Devices
-
- Type: Array of Device structures
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'Version' => '<string>',
]
Result Details
Errors
-
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>',
'MemorySize' => <integer>,
'Pinned' => true || false,
'Timeout' => <integer>,
],
'Id' => '<string>', // REQUIRED
],
// ...
],
],
'Name' => '<string>',
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- AmznClientToken
-
- Type: string
- InitialVersion
-
- Type: FunctionDefinitionVersion structure
Information about a function definition version. - Name
-
- Type: string
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
The key-value pair for the resource tag.
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'LastUpdatedTimestamp' => '<string>',
'LatestVersion' => '<string>',
'LatestVersionArn' => '<string>',
'Name' => '<string>',
]
Result Details
Members
Errors
-
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>',
'MemorySize' => <integer>,
'Pinned' => true || false,
'Timeout' => <integer>,
],
'Id' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AmznClientToken
-
- Type: string
- DefaultConfig
-
- Type: FunctionDefaultConfig structure
The default configuration that applies to all Lambda functions in the group. Individual Lambda functions can override these settings. - FunctionDefinitionId
-
- Required: Yes
- Type: string
- Functions
-
- Type: Array of Function structures
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'Version' => '<string>',
]
Result Details
Errors
-
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>',
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- AmznClientToken
-
- Type: string
- InitialVersion
-
- Type: GroupVersion structure
Information about a group version. - Name
-
- Type: string
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
The key-value pair for the resource tag.
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'LastUpdatedTimestamp' => '<string>',
'LatestVersion' => '<string>',
'LatestVersionArn' => '<string>',
'Name' => '<string>',
]
Result Details
Members
Errors
-
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
-
General error information.
-
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
Members
- AmznClientToken
-
- Type: string
- ConnectorDefinitionVersionArn
-
- Type: string
- CoreDefinitionVersionArn
-
- Type: string
- DeviceDefinitionVersionArn
-
- Type: string
- FunctionDefinitionVersionArn
-
- Type: string
- GroupId
-
- Required: Yes
- Type: string
- LoggerDefinitionVersionArn
-
- Type: string
- ResourceDefinitionVersionArn
-
- Type: string
- SubscriptionDefinitionVersionArn
-
- Type: string
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'Version' => '<string>',
]
Result Details
Errors
-
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
Members
- AmznClientToken
-
- Type: string
- InitialVersion
-
- Type: LoggerDefinitionVersion structure
Information about a logger definition version. - Name
-
- Type: string
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
The key-value pair for the resource tag.
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'LastUpdatedTimestamp' => '<string>',
'LatestVersion' => '<string>',
'LatestVersionArn' => '<string>',
'Name' => '<string>',
]
Result Details
Members
Errors
-
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
Members
- AmznClientToken
-
- Type: string
- LoggerDefinitionId
-
- Required: Yes
- Type: string
- Loggers
-
- Type: Array of Logger structures
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'Version' => '<string>',
]
Result Details
Errors
-
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
Members
- AmznClientToken
-
- Type: string
- InitialVersion
-
- Type: ResourceDefinitionVersion structure
Information about a resource definition version. - Name
-
- Type: string
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
The key-value pair for the resource tag.
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'LastUpdatedTimestamp' => '<string>',
'LatestVersion' => '<string>',
'LatestVersionArn' => '<string>',
'Name' => '<string>',
]
Result Details
Members
Errors
-
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
Members
- AmznClientToken
-
- Type: string
- ResourceDefinitionId
-
- Required: Yes
- Type: string
- Resources
-
- Type: Array of Resource structures
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'Version' => '<string>',
]
Result Details
Errors
-
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
Members
- AmznClientToken
-
- Type: string
- S3UrlSignerRole
-
- Required: Yes
- Type: string
The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the update artifact. - SoftwareToUpdate
-
- Required: Yes
- Type: string
The piece of software on the Greengrass core that will be updated. - UpdateAgentLogLevel
-
- Type: string
The minimum level of log statements that should be logged by the OTA Agent during an update. - UpdateTargets
-
- Required: Yes
- Type: Array of strings
The ARNs of the targets (IoT things or IoT thing groups) that this update will be applied to. - UpdateTargetsArchitecture
-
- Required: Yes
- Type: string
The architecture of the cores which are the targets of an update. - UpdateTargetsOperatingSystem
-
- Required: Yes
- Type: string
The operating system of the cores which are the targets of an update.
Result Syntax
[
'IotJobArn' => '<string>',
'IotJobId' => '<string>',
'PlatformSoftwareVersion' => '<string>',
]
Result Details
Members
Errors
-
General error information.
-
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
Members
- AmznClientToken
-
- Type: string
- InitialVersion
-
- Type: SubscriptionDefinitionVersion structure
Information about a subscription definition version. - Name
-
- Type: string
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
The key-value pair for the resource tag.
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'LastUpdatedTimestamp' => '<string>',
'LatestVersion' => '<string>',
'LatestVersionArn' => '<string>',
'Name' => '<string>',
]
Result Details
Members
Errors
-
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
Members
- AmznClientToken
-
- Type: string
- SubscriptionDefinitionId
-
- Required: Yes
- Type: string
- Subscriptions
-
- Type: Array of Subscription structures
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'Version' => '<string>',
]
Result Details
Errors
-
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
The results for this operation are always empty.
Errors
-
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
The results for this operation are always empty.
Errors
-
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
The results for this operation are always empty.
Errors
-
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
The results for this operation are always empty.
Errors
-
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
The results for this operation are always empty.
Errors
-
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
The results for this operation are always empty.
Errors
-
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
The results for this operation are always empty.
Errors
-
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
The results for this operation are always empty.
Errors
-
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
Members
Errors
-
General error information.
-
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
Members
Result Syntax
[
'DisassociatedAt' => '<string>',
]
Result Details
Members
Errors
-
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
Members
Errors
-
General error information.
-
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
Members
- BulkDeploymentMetrics
-
- Type: BulkDeploymentMetrics structure
Relevant metrics on input records processed during bulk deployment. - BulkDeploymentStatus
-
- Type: string
The status of the bulk deployment. - CreatedAt
-
- Type: string
The time, in ISO format, when the deployment was created. - ErrorDetails
-
- Type: Array of ErrorDetail structures
Error details - ErrorMessage
-
- Type: string
Error message - tags
-
- Type: Associative array of custom strings keys (__string) to strings
The key-value pair for the resource tag.
Errors
-
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
Members
- ConnectivityInfo
-
- Type: Array of ConnectivityInfo structures
Connectivity info list. - Message
-
- Type: string
A message about the connectivity info request.
Errors
-
General error information.
-
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
Members
Errors
-
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
Members
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Definition' => [
'Connectors' => [
[
'ConnectorArn' => '<string>',
'Id' => '<string>',
'Parameters' => ['<string>', ...],
],
// ...
],
],
'Id' => '<string>',
'NextToken' => '<string>',
'Version' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the connector definition version. - CreationTimestamp
-
- Type: string
The time, in milliseconds since the epoch, when the connector definition version was created. - Definition
-
- Type: ConnectorDefinitionVersion structure
Information about the connector definition version. - Id
-
- Type: string
The ID of the connector definition version. - NextToken
-
- Type: string
The token for the next set of results, or ''null'' if there are no additional results. - Version
-
- Type: string
The version of the connector definition version.
Errors
-
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
Members
Errors
-
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
Members
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
Members
- Arn
-
- Type: string
The ARN of the core definition version. - CreationTimestamp
-
- Type: string
The time, in milliseconds since the epoch, when the core definition version was created. - Definition
-
- Type: CoreDefinitionVersion structure
Information about the core definition version. - Id
-
- Type: string
The ID of the core definition version. - NextToken
-
- Type: string
The token for the next set of results, or ''null'' if there are no additional results. - Version
-
- Type: string
The version of the core definition version.
Errors
-
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
Members
- DeploymentStatus
-
- Type: string
The status of the deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''. - DeploymentType
-
- Type: string
The type of the deployment. - ErrorDetails
-
- Type: Array of ErrorDetail structures
Error details - ErrorMessage
-
- Type: string
Error message - UpdatedAt
-
- Type: string
The time, in milliseconds since the epoch, when the deployment status was updated.
Errors
-
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
Members
Errors
-
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
Members
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
Members
- Arn
-
- Type: string
The ARN of the device definition version. - CreationTimestamp
-
- Type: string
The time, in milliseconds since the epoch, when the device definition version was created. - Definition
-
- Type: DeviceDefinitionVersion structure
Information about the device definition version. - Id
-
- Type: string
The ID of the device definition version. - NextToken
-
- Type: string
The token for the next set of results, or ''null'' if there are no additional results. - Version
-
- Type: string
The version of the device definition version.
Errors
-
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
Members
Errors
-
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
Members
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>',
'MemorySize' => <integer>,
'Pinned' => true || false,
'Timeout' => <integer>,
],
'Id' => '<string>',
],
// ...
],
],
'Id' => '<string>',
'NextToken' => '<string>',
'Version' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the function definition version. - CreationTimestamp
-
- Type: string
The time, in milliseconds since the epoch, when the function definition version was created. - Definition
-
- Type: FunctionDefinitionVersion structure
Information on the definition. - Id
-
- Type: string
The ID of the function definition version. - NextToken
-
- Type: string
The token for the next set of results, or ''null'' if there are no additional results. - Version
-
- Type: string
The version of the function definition version.
Errors
-
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
Members
Errors
-
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
Members
Errors
-
General error information.
-
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
Members
Errors
-
General error information.
-
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
Members
- Arn
-
- Type: string
The ARN of the group version. - CreationTimestamp
-
- Type: string
The time, in milliseconds since the epoch, when the group version was created. - Definition
-
- Type: GroupVersion structure
Information about the group version definition. - Id
-
- Type: string
The ID of the group that the version is associated with. - Version
-
- Type: string
The ID of the group version.
Errors
-
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
Members
Errors
-
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
Members
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
Members
- Arn
-
- Type: string
The ARN of the logger definition version. - CreationTimestamp
-
- Type: string
The time, in milliseconds since the epoch, when the logger definition version was created. - Definition
-
- Type: LoggerDefinitionVersion structure
Information about the logger definition version. - Id
-
- Type: string
The ID of the logger definition version. - Version
-
- Type: string
The version of the logger definition version.
Errors
-
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
Members
Errors
-
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
Members
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
Members
- Arn
-
- Type: string
Arn of the resource definition version. - CreationTimestamp
-
- Type: string
The time, in milliseconds since the epoch, when the resource definition version was created. - Definition
-
- Type: ResourceDefinitionVersion structure
Information about the definition. - Id
-
- Type: string
The ID of the resource definition version. - Version
-
- Type: string
The version of the resource definition version.
Errors
-
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
Members
Result Syntax
[
'AssociatedAt' => '<string>',
'RoleArn' => '<string>',
]
Result Details
Members
Errors
-
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
Members
Errors
-
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
Members
Result Syntax
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Definition' => [
'Subscriptions' => [
[
'Id' => '<string>',
'Source' => '<string>',
'Subject' => '<string>',
'Target' => '<string>',
],
// ...
],
],
'Id' => '<string>',
'NextToken' => '<string>',
'Version' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the subscription definition version. - CreationTimestamp
-
- Type: string
The time, in milliseconds since the epoch, when the subscription definition version was created. - Definition
-
- Type: SubscriptionDefinitionVersion structure
Information about the subscription definition version. - Id
-
- Type: string
The ID of the subscription definition version. - NextToken
-
- Type: string
The token for the next set of results, or ''null'' if there are no additional results. - Version
-
- Type: string
The version of the subscription definition version.
Errors
-
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
Members
- Deployments
-
- Type: Array of BulkDeploymentResult structures
A list of the individual group deployments in the bulk deployment operation. - NextToken
-
- Type: string
The token for the next set of results, or ''null'' if there are no additional results.
Errors
-
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
Members
- BulkDeployments
-
- Type: Array of BulkDeployment structures
A list of bulk deployments. - NextToken
-
- Type: string
The token for the next set of results, or ''null'' if there are no additional results.
Errors
-
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
Members
Result Syntax
[
'NextToken' => '<string>',
'Versions' => [
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'Version' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
- Versions
-
- Type: Array of VersionInformation structures
Errors
-
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
Members
- Definitions
-
- Type: Array of DefinitionInformation structures
- NextToken
-
- Type: string
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
Members
- NextToken
-
- Type: string
- Versions
-
- Type: Array of VersionInformation structures
Errors
-
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
Members
- Definitions
-
- Type: Array of DefinitionInformation structures
- NextToken
-
- Type: string
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
Members
- Deployments
-
- Type: Array of Deployment structures
A list of deployments for the requested groups. - NextToken
-
- Type: string
The token for the next set of results, or ''null'' if there are no additional results.
Errors
-
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
Members
Result Syntax
[
'NextToken' => '<string>',
'Versions' => [
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'Version' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
- Versions
-
- Type: Array of VersionInformation structures
Errors
-
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
Members
- Definitions
-
- Type: Array of DefinitionInformation structures
- NextToken
-
- Type: string
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
Members
Result Syntax
[
'NextToken' => '<string>',
'Versions' => [
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'Version' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
- Versions
-
- Type: Array of VersionInformation structures
Errors
-
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
Members
- Definitions
-
- Type: Array of DefinitionInformation structures
- NextToken
-
- Type: string
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
Members
- GroupCertificateAuthorities
-
- Type: Array of GroupCertificateAuthorityProperties structures
A list of certificate authorities associated with the group.
Errors
-
General error information.
-
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
Members
- NextToken
-
- Type: string
- Versions
-
- Type: Array of VersionInformation structures
Errors
-
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
Members
- Groups
-
- Type: Array of GroupInformation structures
Information about a group. - NextToken
-
- Type: string
The token for the next set of results, or ''null'' if there are no additional results.
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
Members
Result Syntax
[
'NextToken' => '<string>',
'Versions' => [
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'Version' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
- Versions
-
- Type: Array of VersionInformation structures
Errors
-
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
Members
- Definitions
-
- Type: Array of DefinitionInformation structures
- NextToken
-
- Type: string
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
Members
Result Syntax
[
'NextToken' => '<string>',
'Versions' => [
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'Version' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
- Versions
-
- Type: Array of VersionInformation structures
Errors
-
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
Members
- Definitions
-
- Type: Array of DefinitionInformation structures
- NextToken
-
- Type: string
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
Members
Result Syntax
[
'NextToken' => '<string>',
'Versions' => [
[
'Arn' => '<string>',
'CreationTimestamp' => '<string>',
'Id' => '<string>',
'Version' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
- Versions
-
- Type: Array of VersionInformation structures
Errors
-
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
Members
- Definitions
-
- Type: Array of DefinitionInformation structures
- NextToken
-
- Type: string
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
Members
Errors
-
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
Members
Result Syntax
[
'DeploymentArn' => '<string>',
'DeploymentId' => '<string>',
]
Result Details
Members
Errors
-
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
Members
- AmznClientToken
-
- Type: string
- ExecutionRoleArn
-
- Required: Yes
- Type: string
The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the ''greengrass:CreateDeployment'' action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket containing the input file. - InputFileUri
-
- Required: Yes
- Type: string
The URI of the input file contained in the S3 bucket. The execution role must have ''getObject'' permissions on this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only ''NewDeployment'' deployment types. - tags
-
- Type: Associative array of custom strings keys (__string) to strings
The key-value pair for the resource tag.
Result Syntax
[
'BulkDeploymentArn' => '<string>',
'BulkDeploymentId' => '<string>',
]
Result Details
Members
Errors
-
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
The results for this operation are always empty.
Errors
-
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
Members
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
-
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
The results for this operation are always empty.
Errors
-
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
Members
- ConnectivityInfo
-
- Type: Array of ConnectivityInfo structures
A list of connectivity info. - ThingName
-
- Required: Yes
- Type: string
Result Syntax
[
'Message' => '<string>',
'Version' => '<string>',
]
Result Details
Members
Errors
-
General error information.
-
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
The results for this operation are always empty.
Errors
-
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
The results for this operation are always empty.
Errors
-
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
The results for this operation are always empty.
Errors
-
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
The results for this operation are always empty.
Errors
-
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
The results for this operation are always empty.
Errors
-
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
Members
Result Syntax
[
'CertificateAuthorityExpiryInMilliseconds' => '<string>',
'CertificateExpiryInMilliseconds' => '<string>',
'GroupId' => '<string>',
]
Result Details
Members
Errors
-
General error information.
-
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
The results for this operation are always empty.
Errors
-
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
The results for this operation are always empty.
Errors
-
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
The results for this operation are always empty.
Errors
-
General error information.
Shapes
BadRequestException
Description
General error information.
Members
- ErrorDetails
-
- Type: Array of ErrorDetail structures
A list of error details. - Message
-
- Type: string
BulkDeployment
Description
Information about a bulk deployment. You cannot start a new bulk deployment while another one is still running or in a non-terminal state.
Members
BulkDeploymentMetrics
Description
Relevant metrics on input records processed during bulk deployment.
Members
- InvalidInputRecords
-
- Type: int
The total number of records that returned a non-retryable error. For example, this can occur if a group record from the input file uses an invalid format or specifies a nonexistent group version, or if the execution role doesn't grant permission to deploy a group or group version. - RecordsProcessed
-
- Type: int
The total number of group records from the input file that have been processed so far, or attempted. - RetryAttempts
-
- Type: int
The total number of deployment attempts that returned a retryable error. For example, a retry is triggered if the attempt to deploy a group returns a throttling error. ''StartBulkDeployment'' retries a group deployment up to five times.
BulkDeploymentResult
Description
Information about an individual group deployment in a bulk deployment operation.
Members
- CreatedAt
-
- Type: string
The time, in ISO format, when the deployment was created. - DeploymentArn
-
- Type: string
The ARN of the group deployment. - DeploymentId
-
- Type: string
The ID of the group deployment. - DeploymentStatus
-
- Type: string
The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''. - DeploymentType
-
- Type: string
The type of the deployment. - ErrorDetails
-
- Type: Array of ErrorDetail structures
Details about the error. - ErrorMessage
-
- Type: string
The error message for a failed deployment - GroupArn
-
- Type: string
The ARN of the Greengrass group.
ConnectivityInfo
Description
Information about a Greengrass core's connectivity.
Members
Connector
Description
Information about a connector. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.
Members
- ConnectorArn
-
- Required: Yes
- Type: string
The ARN of the connector. - Id
-
- Required: Yes
- Type: string
A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+. - Parameters
-
- Type: Associative array of custom strings keys (__string) to strings
The parameters or configuration that the connector uses.
ConnectorDefinitionVersion
Description
Information about the connector definition version, which is a container for connectors.
Members
- Connectors
-
- Type: Array of Connector structures
A list of references to connectors in this version, with their corresponding configuration settings.
Core
Description
Information about a core.
Members
- CertificateArn
-
- Required: Yes
- Type: string
The ARN of the certificate associated with the core. - Id
-
- Required: Yes
- Type: string
A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. - SyncShadow
-
- Type: boolean
If true, the core's local shadow is automatically synced with the cloud. - ThingArn
-
- Required: Yes
- Type: string
The ARN of the thing which is the core.
CoreDefinitionVersion
Description
Information about a core definition version.
Members
- Cores
-
- Type: Array of Core structures
A list of cores in the core definition version.
DefinitionInformation
Description
Information about a definition.
Members
- Arn
-
- Type: string
The ARN of the definition. - CreationTimestamp
-
- Type: string
The time, in milliseconds since the epoch, when the definition was created. - Id
-
- Type: string
The ID of the definition. - LastUpdatedTimestamp
-
- Type: string
The time, in milliseconds since the epoch, when the definition was last updated. - LatestVersion
-
- Type: string
The ID of the latest version associated with the definition. - LatestVersionArn
-
- Type: string
The ARN of the latest version associated with the definition. - Name
-
- Type: string
The name of the definition. - Tags
-
- Type: Associative array of custom strings keys (__string) to strings
Tag(s) attached to the resource arn.
Deployment
Description
Information about a deployment.
Members
- CreatedAt
-
- Type: string
The time, in milliseconds since the epoch, when the deployment was created. - DeploymentArn
-
- Type: string
The ARN of the deployment. - DeploymentId
-
- Type: string
The ID of the deployment. - DeploymentType
-
- Type: string
The type of the deployment. - GroupArn
-
- Type: string
The ARN of the group for this deployment.
Device
Description
Information about a device.
Members
- CertificateArn
-
- Required: Yes
- Type: string
The ARN of the certificate associated with the device. - Id
-
- Required: Yes
- Type: string
A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. - SyncShadow
-
- Type: boolean
If true, the device's local shadow will be automatically synced with the cloud. - ThingArn
-
- Required: Yes
- Type: string
The thing ARN of the device.
DeviceDefinitionVersion
Description
Information about a device definition version.
Members
- Devices
-
- Type: Array of Device structures
A list of devices in the definition version.
Empty
Description
Empty
Members
ErrorDetail
Description
Details about the error.
Members
Function
Description
Information about a Lambda function.
Members
- FunctionArn
-
- Type: string
The ARN of the Lambda function. - FunctionConfiguration
-
- Type: FunctionConfiguration structure
The configuration of the Lambda function. - Id
-
- Required: Yes
- Type: string
A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
FunctionConfiguration
Description
The configuration of the Lambda function.
Members
- EncodingType
-
- Type: string
The expected encoding type of the input payload for the function. The default is ''json''. - Environment
-
- Type: FunctionConfigurationEnvironment structure
The environment configuration of the function. - ExecArgs
-
- Type: string
The execution arguments. - Executable
-
- Type: string
The name of the function executable. - MemorySize
-
- Type: int
The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization. - Pinned
-
- Type: boolean
True if the function is pinned. Pinned means the function is long-lived and starts when the core starts. - Timeout
-
- Type: int
The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.
FunctionConfigurationEnvironment
Description
The environment configuration of the function.
Members
- AccessSysfs
-
- Type: boolean
If true, the Lambda function is allowed to access the host's /sys folder. Use this when the Lambda function needs to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass container. - Execution
-
- Type: FunctionExecutionConfig structure
Configuration related to executing the Lambda function - ResourceAccessPolicies
-
- Type: Array of ResourceAccessPolicy structures
A list of the resources, with their permissions, to which the Lambda function will be granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies apply only when you run the Lambda function in a Greengrass container. - Variables
-
- Type: Associative array of custom strings keys (__string) to strings
Environment variables for the Lambda function's configuration.
FunctionDefaultConfig
Description
The default configuration that applies to all Lambda functions in the group. Individual Lambda functions can override these settings.
Members
- Execution
-
- Type: FunctionDefaultExecutionConfig structure
Configuration information that specifies how a Lambda function runs.
FunctionDefaultExecutionConfig
Description
Configuration information that specifies how a Lambda function runs.
Members
- IsolationMode
-
- Type: string
Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group. - RunAs
-
- Type: FunctionRunAsConfig structure
Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ''IsolationMode'' to ''NoContainer'' and update config.json in ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''.
FunctionDefinitionVersion
Description
Information about a function definition version.
Members
- DefaultConfig
-
- Type: FunctionDefaultConfig structure
The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings. - Functions
-
- Type: Array of Function structures
A list of Lambda functions in this function definition version.
FunctionExecutionConfig
Description
Configuration information that specifies how a Lambda function runs.
Members
- IsolationMode
-
- Type: string
Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group. - RunAs
-
- Type: FunctionRunAsConfig structure
Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ''IsolationMode'' to ''NoContainer'' and update config.json in ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''.
FunctionRunAsConfig
Description
Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ''IsolationMode'' to ''NoContainer'' and update config.json in ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''.
Members
GeneralError
Description
General error information.
Members
- ErrorDetails
-
- Type: Array of ErrorDetail structures
Details about the error. - Message
-
- Type: string
A message containing information about the error.
GroupCertificateAuthorityProperties
Description
Information about a certificate authority for a group.
Members
GroupCertificateConfiguration
Description
Information about a group certificate configuration.
Members
- CertificateAuthorityExpiryInMilliseconds
-
- Type: string
The amount of time remaining before the certificate authority expires, in milliseconds. - CertificateExpiryInMilliseconds
-
- Type: string
The amount of time remaining before the certificate expires, in milliseconds. - GroupId
-
- Type: string
The ID of the group certificate configuration.
GroupInformation
Description
Information about a group.
Members
- Arn
-
- Type: string
The ARN of the group. - CreationTimestamp
-
- Type: string
The time, in milliseconds since the epoch, when the group was created. - Id
-
- Type: string
The ID of the group. - LastUpdatedTimestamp
-
- Type: string
The time, in milliseconds since the epoch, when the group was last updated. - LatestVersion
-
- Type: string
The ID of the latest version associated with the group. - LatestVersionArn
-
- Type: string
The ARN of the latest version associated with the group. - Name
-
- Type: string
The name of the group.
GroupOwnerSetting
Description
Group owner related settings for local resources.
Members
- AutoAddGroupOwner
-
- Type: boolean
If true, AWS IoT Greengrass automatically adds the specified Linux OS group owner of the resource to the Lambda process privileges. Thus the Lambda process will have the file access permissions of the added Linux group. - GroupOwner
-
- Type: string
The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.
GroupVersion
Description
Information about a group version.
Members
- ConnectorDefinitionVersionArn
-
- Type: string
The ARN of the connector definition version for this group. - CoreDefinitionVersionArn
-
- Type: string
The ARN of the core definition version for this group. - DeviceDefinitionVersionArn
-
- Type: string
The ARN of the device definition version for this group. - FunctionDefinitionVersionArn
-
- Type: string
The ARN of the function definition version for this group. - LoggerDefinitionVersionArn
-
- Type: string
The ARN of the logger definition version for this group. - ResourceDefinitionVersionArn
-
- Type: string
The ARN of the resource definition version for this group. - SubscriptionDefinitionVersionArn
-
- Type: string
The ARN of the subscription definition version for this group.
InternalServerErrorException
Description
General error information.
Members
- ErrorDetails
-
- Type: Array of ErrorDetail structures
A list of error details. - Message
-
- Type: string
ListDefinitionsResponse
Description
A list of definitions.
Members
- Definitions
-
- Type: Array of DefinitionInformation structures
Information about a definition. - NextToken
-
- Type: string
The token for the next set of results, or ''null'' if there are no additional results.
ListVersionsResponse
Description
A list of versions.
Members
- NextToken
-
- Type: string
The token for the next set of results, or ''null'' if there are no additional results. - Versions
-
- Type: Array of VersionInformation structures
Information about a version.
LocalDeviceResourceData
Description
Attributes that define a local device resource.
Members
- GroupOwnerSetting
-
- Type: GroupOwnerSetting structure
Group/owner related settings for local resources. - SourcePath
-
- Type: string
The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under ''/dev''.
LocalVolumeResourceData
Description
Attributes that define a local volume resource.
Members
- DestinationPath
-
- Type: string
The absolute local path of the resource inside the Lambda environment. - GroupOwnerSetting
-
- Type: GroupOwnerSetting structure
Allows you to configure additional group privileges for the Lambda process. This field is optional. - SourcePath
-
- Type: string
The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with ''/sys''.
Logger
Description
Information about a logger
Members
- Component
-
- Required: Yes
- Type: string
The component that will be subject to logging. - Id
-
- Required: Yes
- Type: string
A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. - Level
-
- Required: Yes
- Type: string
The level of the logs. - Space
-
- Type: int
The amount of file space, in KB, to use if the local file system is used for logging purposes. - Type
-
- Required: Yes
- Type: string
The type of log output which will be used.
LoggerDefinitionVersion
Description
Information about a logger definition version.
Members
- Loggers
-
- Type: Array of Logger structures
A list of loggers.
Resource
Description
Information about a resource.
Members
- Id
-
- Required: Yes
- Type: string
The resource ID, used to refer to a resource in the Lambda function configuration. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group. - Name
-
- Required: Yes
- Type: string
The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Max length 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group. - ResourceDataContainer
-
- Required: Yes
- Type: ResourceDataContainer structure
A container of data for all resource types.
ResourceAccessPolicy
Description
A policy used by the function to access a resource.
Members
ResourceDataContainer
Description
A container for resource data. The container takes only one of the following supported resource data types: ''LocalDeviceResourceData'', ''LocalVolumeResourceData'', ''SageMakerMachineLearningModelResourceData'', ''S3MachineLearningModelResourceData'', ''SecretsManagerSecretResourceData''.
Members
- LocalDeviceResourceData
-
- Type: LocalDeviceResourceData structure
Attributes that define the local device resource. - LocalVolumeResourceData
-
- Type: LocalVolumeResourceData structure
Attributes that define the local volume resource. - S3MachineLearningModelResourceData
-
- Type: S3MachineLearningModelResourceData structure
Attributes that define an Amazon S3 machine learning resource. - SageMakerMachineLearningModelResourceData
-
- Type: SageMakerMachineLearningModelResourceData structure
Attributes that define an Amazon SageMaker machine learning resource. - SecretsManagerSecretResourceData
-
- Type: SecretsManagerSecretResourceData structure
Attributes that define a secret resource, which references a secret from AWS Secrets Manager.
ResourceDefinitionVersion
Description
Information about a resource definition version.
Members
- Resources
-
- Type: Array of Resource structures
A list of resources.
ResourceDownloadOwnerSetting
Description
The owner setting for downloaded machine learning resources.
Members
- GroupOwner
-
- Required: Yes
- Type: string
The group owner of the resource. This is the name of an existing Linux OS group on the system or a GID. The group's permissions are added to the Lambda process. - GroupPermission
-
- Required: Yes
- Type: string
The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).
S3MachineLearningModelResourceData
Description
Attributes that define an Amazon S3 machine learning resource.
Members
- DestinationPath
-
- Type: string
The absolute local path of the resource inside the Lambda environment. - OwnerSetting
-
- Type: ResourceDownloadOwnerSetting structure
The owner setting for downloaded machine learning resources. - S3Uri
-
- Type: string
The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.
SageMakerMachineLearningModelResourceData
Description
Attributes that define an Amazon SageMaker machine learning resource.
Members
- DestinationPath
-
- Type: string
The absolute local path of the resource inside the Lambda environment. - OwnerSetting
-
- Type: ResourceDownloadOwnerSetting structure
The owner setting for downloaded machine learning resources. - SageMakerJobArn
-
- Type: string
The ARN of the Amazon SageMaker training job that represents the source model.
SecretsManagerSecretResourceData
Description
Attributes that define a secret resource, which references a secret from AWS Secrets Manager. AWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core, where it can be securely accessed by connectors and Lambda functions.
Members
- ARN
-
- Type: string
The ARN of the Secrets Manager secret to make available on the core. The value of the secret's latest version (represented by the ''AWSCURRENT'' staging label) is included by default. - AdditionalStagingLabelsToDownload
-
- Type: Array of strings
Optional. The staging labels whose values you want to make available on the core, in addition to ''AWSCURRENT''.
Subscription
Description
Information about a subscription.
Members
- Id
-
- Required: Yes
- Type: string
A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. - Source
-
- Required: Yes
- Type: string
The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'. - Subject
-
- Required: Yes
- Type: string
The MQTT topic used to route the message. - Target
-
- Required: Yes
- Type: string
Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.
SubscriptionDefinitionVersion
Description
Information about a subscription definition version.
Members
- Subscriptions
-
- Type: Array of Subscription structures
A list of subscriptions.
VersionInformation
Description
Information about a version.
