openapi-directory/api/amazonaws.com/greengrass.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"version":"2017-06-07","x-release":"v4","title":"AWS Greengrass","description":"AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. AWS IoT Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS IoT Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"greengrass","x-aws-signingName":"greengrass","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/greengrass-2017-06-07.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/greengrass/"},"servers":[{"url":"http://greengrass.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWS Greengrass multi-region endpoint"},{"url":"https://greengrass.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWS Greengrass multi-region endpoint"},{"url":"http://greengrass.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWS Greengrass endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://greengrass.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWS Greengrass endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/greengrass/groups/{GroupId}/role":{"put":{"operationId":"AssociateRoleToGroup","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssociateRoleToGroupResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}}},"parameters":[{"name":"GroupId","in":"path","required":true,"description":"The ID of the Greengrass group.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RoleArn"],"properties":{"RoleArn":{"description":"The ARN of the role you wish to associate with this group. The existence of the role is not validated.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DisassociateRoleFromGroup","description":"Disassociates the role from a group.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisassociateRoleFromGroupResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}}},"parameters":[{"name":"GroupId","in":"path","required":true,"description":"The ID of the Greengrass group.","schema":{"type":"string"}}]},"get":{"operationId":"GetAssociatedRole","description":"Retrieves the role associated with a particular group.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAssociatedRoleResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}}},"parameters":[{"name":"GroupId","in":"path","required":true,"description":"The ID of the Greengrass group.","schema":{"type":"string"}}]}},"/greengrass/servicerole":{"put":{"operationId":"AssociateServiceRoleToAccount","description":"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''.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssociateServiceRoleToAccountResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RoleArn"],"properties":{"RoleArn":{"description":"The ARN of the service role you wish to associate with your account.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DisassociateServiceRoleFromAccount","description":"Disassociates the service role from your account. Without a service role, deployments will not work.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisassociateServiceRoleFromAccountResponse"}}}},"480":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}}},"parameters":[]},"get":{"operationId":"GetServiceRoleForAccount","description":"Retrieves the service role that is attached to your account.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetServiceRoleForAccountResponse"}}}},"480":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}}},"parameters":[]}},"/greengrass/definition/connectors":{"post":{"operationId":"CreateConnectorDefinition","description":"Creates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectorDefinitionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InitialVersion":{"description":"Information about the connector definition version, which is a container for connectors.","type":"object","properties":{"Connectors":{"allOf":[{"$ref":"#/components/schemas/__listOfConnector"},{"description":"A list of references to connectors in this version, with their corresponding configuration settings."}]}}},"Name":{"description":"The name of the connector definition.","type":"string"},"tags":{"description":"The key-value pair for the resource tag.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListConnectorDefinitions","description":"Retrieves a list of connector definitions.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectorDefinitionsResponse"}}}}},"parameters":[{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to be returned per request.","schema":{"type":"string"}},{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results, or ''null'' if there are no additional results.","schema":{"type":"string"}}]}},"/greengrass/definition/connectors/{ConnectorDefinitionId}/versions":{"post":{"operationId":"CreateConnectorDefinitionVersion","description":"Creates a version of a connector definition which has already been defined.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConnectorDefinitionVersionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}},{"name":"ConnectorDefinitionId","in":"path","required":true,"description":"The ID of the connector definition.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Connectors":{"description":"A list of references to connectors in this version, with their corresponding configuration settings.","type":"array","items":{"$ref":"#/components/schemas/Connector"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListConnectorDefinitionVersions","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectorDefinitionVersionsResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"ConnectorDefinitionId","in":"path","required":true,"description":"The ID of the connector definition.","schema":{"type":"string"}},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to be returned per request.","schema":{"type":"string"}},{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results, or ''null'' if there are no additional results.","schema":{"type":"string"}}]}},"/greengrass/definition/cores":{"post":{"operationId":"CreateCoreDefinition","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCoreDefinitionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InitialVersion":{"description":"Information about a core definition version.","type":"object","properties":{"Cores":{"allOf":[{"$ref":"#/components/schemas/__listOfCore"},{"description":"A list of cores in the core definition version."}]}}},"Name":{"description":"The name of the core definition.","type":"string"},"tags":{"description":"The key-value pair for the resource tag.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListCoreDefinitions","description":"Retrieves a list of core definitions.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCoreDefinitionsResponse"}}}}},"parameters":[{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to be returned per request.","schema":{"type":"string"}},{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results, or ''null'' if there are no additional results.","schema":{"type":"string"}}]}},"/greengrass/definition/cores/{CoreDefinitionId}/versions":{"post":{"operationId":"CreateCoreDefinitionVersion","description":"Creates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCoreDefinitionVersionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}},{"name":"CoreDefinitionId","in":"path","required":true,"description":"The ID of the core definition.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Cores":{"description":"A list of cores in the core definition version.","type":"array","items":{"$ref":"#/components/schemas/Core"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListCoreDefinitionVersions","description":"Lists the versions of a core definition.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCoreDefinitionVersionsResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"CoreDefinitionId","in":"path","required":true,"description":"The ID of the core definition.","schema":{"type":"string"}},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to be returned per request.","schema":{"type":"string"}},{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results, or ''null'' if there are no additional results.","schema":{"type":"string"}}]}},"/greengrass/groups/{GroupId}/deployments":{"post":{"operationId":"CreateDeployment","description":"Creates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeploymentResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}},{"name":"GroupId","in":"path","required":true,"description":"The ID of the Greengrass group.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DeploymentType"],"properties":{"DeploymentId":{"description":"The ID of the deployment if you wish to redeploy a previous deployment.","type":"string"},"DeploymentType":{"description":"The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.","type":"string","enum":["NewDeployment","Redeployment","ResetDeployment","ForceResetDeployment"]},"GroupVersionId":{"description":"The ID of the group version to be deployed.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListDeployments","description":"Returns a history of deployments for the group.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDeploymentsResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"GroupId","in":"path","required":true,"description":"The ID of the Greengrass group.","schema":{"type":"string"}},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to be returned per request.","schema":{"type":"string"}},{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results, or ''null'' if there are no additional results.","schema":{"type":"string"}}]}},"/greengrass/definition/devices":{"post":{"operationId":"CreateDeviceDefinition","description":"Creates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceDefinitionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InitialVersion":{"description":"Information about a device definition version.","type":"object","properties":{"Devices":{"allOf":[{"$ref":"#/components/schemas/__listOfDevice"},{"description":"A list of devices in the definition version."}]}}},"Name":{"description":"The name of the device definition.","type":"string"},"tags":{"description":"The key-value pair for the resource tag.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListDeviceDefinitions","description":"Retrieves a list of device definitions.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDeviceDefinitionsResponse"}}}}},"parameters":[{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to be returned per request.","schema":{"type":"string"}},{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results, or ''null'' if there are no additional results.","schema":{"type":"string"}}]}},"/greengrass/definition/devices/{DeviceDefinitionId}/versions":{"post":{"operationId":"CreateDeviceDefinitionVersion","description":"Creates a version of a device definition that has already been defined.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDeviceDefinitionVersionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}},{"name":"DeviceDefinitionId","in":"path","required":true,"description":"The ID of the device definition.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Devices":{"description":"A list of devices in the definition version.","type":"array","items":{"$ref":"#/components/schemas/Device"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListDeviceDefinitionVersions","description":"Lists the versions of a device definition.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDeviceDefinitionVersionsResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"DeviceDefinitionId","in":"path","required":true,"description":"The ID of the device definition.","schema":{"type":"string"}},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to be returned per request.","schema":{"type":"string"}},{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results, or ''null'' if there are no additional results.","schema":{"type":"string"}}]}},"/greengrass/definition/functions":{"post":{"operationId":"CreateFunctionDefinition","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFunctionDefinitionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InitialVersion":{"description":"Information about a function definition version.","type":"object","properties":{"DefaultConfig":{"allOf":[{"$ref":"#/components/schemas/FunctionDefaultConfig"},{"description":"The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings."}]},"Functions":{"allOf":[{"$ref":"#/components/schemas/__listOfFunction"},{"description":"A list of Lambda functions in this function definition version."}]}}},"Name":{"description":"The name of the function definition.","type":"string"},"tags":{"description":"The key-value pair for the resource tag.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListFunctionDefinitions","description":"Retrieves a list of Lambda function definitions.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFunctionDefinitionsResponse"}}}}},"parameters":[{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to be returned per request.","schema":{"type":"string"}},{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results, or ''null'' if there are no additional results.","schema":{"type":"string"}}]}},"/greengrass/definition/functions/{FunctionDefinitionId}/versions":{"post":{"operationId":"CreateFunctionDefinitionVersion","description":"Creates a version of a Lambda function definition that has already been defined.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFunctionDefinitionVersionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}},{"name":"FunctionDefinitionId","in":"path","required":true,"description":"The ID of the Lambda function definition.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"DefaultConfig":{"description":"The default configuration that applies to all Lambda functions in the group. Individual Lambda functions can override these settings.","type":"object","properties":{"Execution":{"$ref":"#/components/schemas/FunctionDefaultExecutionConfig"}}},"Functions":{"description":"A list of Lambda functions in this function definition version.","type":"array","items":{"$ref":"#/components/schemas/Function"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListFunctionDefinitionVersions","description":"Lists the versions of a Lambda function definition.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFunctionDefinitionVersionsResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"FunctionDefinitionId","in":"path","required":true,"description":"The ID of the Lambda function definition.","schema":{"type":"string"}},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to be returned per request.","schema":{"type":"string"}},{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results, or ''null'' if there are no additional results.","schema":{"type":"string"}}]}},"/greengrass/groups":{"post":{"operationId":"CreateGroup","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"InitialVersion":{"description":"Information about a group version.","type":"object","properties":{"ConnectorDefinitionVersionArn":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The ARN of the connector definition version for this group."}]},"CoreDefinitionVersionArn":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The ARN of the core definition version for this group."}]},"DeviceDefinitionVersionArn":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The ARN of the device definition version for this group."}]},"FunctionDefinitionVersionArn":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The ARN of the function definition version for this group."}]},"LoggerDefinitionVersionArn":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The ARN of the logger definition version for this group."}]},"ResourceDefinitionVersionArn":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The ARN of the resource definition version for this group."}]},"SubscriptionDefinitionVersionArn":{"allOf":[{"$ref":"#/components/schemas/__string"},{"description":"The ARN of the subscription definition version for this group."}]}}},"Name":{"description":"The name of the group.","type":"string"},"tags":{"description":"The key-value pair for the resource tag.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListGroups","description":"Retrieves a list of groups.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGroupsResponse"}}}}},"parameters":[{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to be returned per request.","schema":{"type":"string"}},{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results, or ''null'' if there are no additional results.","schema":{"type":"string"}}]}},"/greengrass/groups/{GroupId}/certificateauthorities":{"post":{"operationId":"CreateGroupCertificateAuthority","description":"Creates a CA for the group. If a CA already exists, it will rotate the existing CA.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupCertificateAuthorityResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}},{"name":"GroupId","in":"path","required":true,"description":"The ID of the Greengrass group.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListGroupCertificateAuthorities","description":"Retrieves the current CAs for a group.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGroupCertificateAuthoritiesResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}}},"parameters":[{"name":"GroupId","in":"path","required":true,"description":"The ID of the Greengrass group.","schema":{"type":"string"}}]}},"/greengrass/groups/{GroupId}/versions":{"post":{"operationId":"CreateGroupVersion","description":"Creates a version of a group which has already been defined.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupVersionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}},{"name":"GroupId","in":"path","required":true,"description":"The ID of the Greengrass group.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ConnectorDefinitionVersionArn":{"description":"The ARN of the connector definition version for this group.","type":"string"},"CoreDefinitionVersionArn":{"description":"The ARN of the core definition version for this group.","type":"string"},"DeviceDefinitionVersionArn":{"description":"The ARN of the device definition version for this group.","type":"string"},"FunctionDefinitionVersionArn":{"description":"The ARN of the function definition version for this group.","type":"string"},"LoggerDefinitionVersionArn":{"description":"The ARN of the logger definition version for this group.","type":"string"},"ResourceDefinitionVersionArn":{"description":"The ARN of the resource definition version for this group.","type":"string"},"SubscriptionDefinitionVersionArn":{"description":"The ARN of the subscription definition version for this group.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListGroupVersions","description":"Lists the versions of a group.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGroupVersionsResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"GroupId","in":"path","required":true,"description":"The ID of the Greengrass group.","schema":{"type":"string"}},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to be returned per request.","schema":{"type":"string"}},{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results, or ''null'' if there are no additional results.","schema":{"type":"string"}}]}},"/greengrass/definition/loggers":{"post":{"operationId":"CreateLoggerDefinition","description":"Creates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLoggerDefinitionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InitialVersion":{"description":"Information about a logger definition version.","type":"object","properties":{"Loggers":{"allOf":[{"$ref":"#/components/schemas/__listOfLogger"},{"description":"A list of loggers."}]}}},"Name":{"description":"The name of the logger definition.","type":"string"},"tags":{"description":"The key-value pair for the resource tag.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListLoggerDefinitions","description":"Retrieves a list of logger definitions.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLoggerDefinitionsResponse"}}}}},"parameters":[{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to be returned per request.","schema":{"type":"string"}},{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results, or ''null'' if there are no additional results.","schema":{"type":"string"}}]}},"/greengrass/definition/loggers/{LoggerDefinitionId}/versions":{"post":{"operationId":"CreateLoggerDefinitionVersion","description":"Creates a version of a logger definition that has already been defined.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLoggerDefinitionVersionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}},{"name":"LoggerDefinitionId","in":"path","required":true,"description":"The ID of the logger definition.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Loggers":{"description":"A list of loggers.","type":"array","items":{"$ref":"#/components/schemas/Logger"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListLoggerDefinitionVersions","description":"Lists the versions of a logger definition.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLoggerDefinitionVersionsResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"LoggerDefinitionId","in":"path","required":true,"description":"The ID of the logger definition.","schema":{"type":"string"}},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to be returned per request.","schema":{"type":"string"}},{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results, or ''null'' if there are no additional results.","schema":{"type":"string"}}]}},"/greengrass/definition/resources":{"post":{"operationId":"CreateResourceDefinition","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResourceDefinitionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"InitialVersion":{"description":"Information about a resource definition version.","type":"object","properties":{"Resources":{"allOf":[{"$ref":"#/components/schemas/__listOfResource"},{"description":"A list of resources."}]}}},"Name":{"description":"The name of the resource definition.","type":"string"},"tags":{"description":"The key-value pair for the resource tag.","type":"object","additionalProperties":{"$ref":"#/components/schemas/__string"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListResourceDefinitions","description":"Retrieves a list of resource definitions.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResourceDefinitionsResponse"}}}}},"parameters":[{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to be returned per request.","schema":{"type":"string"}},{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results, or ''null'' if there are no additional results.","schema":{"type":"string"}}]}},"/greengrass/definition/resources/{ResourceDefinitionId}/versions":{"post":{"operationId":"CreateResourceDefinitionVersion","description":"Creates a version of a resource definition that has already been defined.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResourceDefinitionVersionResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}},{"name":"ResourceDefinitionId","in":"path","required":true,"description":"The ID of the resource definition.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Resources":{"description":"A list of resources.","type":"array","items":{"$ref":"#/components/schemas/Resource"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListResourceDefinitionVersions","description":"Lists the versions of a resource definition.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResourceDefinitionVersionsResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}}},"parameters":[{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to be returned per request.","schema":{"type":"string"}},{"name":"NextToken","in":"query","required":false,"description":"The token for the next set of results, or ''null'' if there are no additional results.","schema":{"type":"string"}},{"name":"ResourceDefinitionId","in":"path","required":true,"description":"The ID of the resource definition.","schema":{"type":"string"}}]}},"/greengrass/updates":{"post":{"operationId":"CreateSoftwareUpdateJob","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSoftwareUpdateJobResponse"}}}},"480":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"481":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}}},"parameters":[{"name":"X-Amzn-Client-Token","in":"header","required":false,"description":"A client token used to correlate requests and responses.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["S3UrlSignerRole","SoftwareToUpdate","UpdateTargets","UpdateTargetsArchitecture","UpdateTargetsOperatingSystem"],"properties":{"S3UrlSignerRole":{"description":"The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the update artifact.","type":"string"},"SoftwareToUpdate":{"description":"The piece of software on the Greengrass core that will be updated.","type":"string","enum":["core","ota_agent"