diff --git a/apis/iot/2015-05-28/api-2.json b/apis/iot/2015-05-28/api-2.json index 08914e15fa0..170549db5e4 100644 --- a/apis/iot/2015-05-28/api-2.json +++ b/apis/iot/2015-05-28/api-2.json @@ -2503,6 +2503,21 @@ {"shape":"InternalServerException"} ] }, + "ListMetricValues":{ + "name":"ListMetricValues", + "http":{ + "method":"GET", + "requestUri":"/metric-values" + }, + "input":{"shape":"ListMetricValuesRequest"}, + "output":{"shape":"ListMetricValuesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "ListMitigationActions":{ "name":"ListMitigationActions", "http":{ @@ -3953,7 +3968,7 @@ "required":["thingGroupNames"], "members":{ "thingGroupNames":{"shape":"ThingGroupNames"}, - "overrideDynamicGroups":{"shape":"OverrideDynamicGroups"} + "overrideDynamicGroups":{"shape":"NullableBoolean"} } }, "AdditionalMetricsToRetainList":{ @@ -9514,6 +9529,64 @@ "nextToken":{"shape":"NextToken"} } }, + "ListMetricValuesRequest":{ + "type":"structure", + "required":[ + "thingName", + "metricName", + "startTime", + "endTime" + ], + "members":{ + "thingName":{ + "shape":"DeviceDefenderThingName", + "location":"querystring", + "locationName":"thingName" + }, + "metricName":{ + "shape":"BehaviorMetric", + "location":"querystring", + "locationName":"metricName" + }, + "dimensionName":{ + "shape":"DimensionName", + "location":"querystring", + "locationName":"dimensionName" + }, + "dimensionValueOperator":{ + "shape":"DimensionValueOperator", + "location":"querystring", + "locationName":"dimensionValueOperator" + }, + "startTime":{ + "shape":"Timestamp", + "location":"querystring", + "locationName":"startTime" + }, + "endTime":{ + "shape":"Timestamp", + "location":"querystring", + "locationName":"endTime" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListMetricValuesResponse":{ + "type":"structure", + "members":{ + "metricDatumList":{"shape":"MetricDatumList"}, + "nextToken":{"shape":"NextToken"} + } + }, "ListMitigationActionsRequest":{ "type":"structure", "members":{ @@ -10562,6 +10635,17 @@ "type":"string", "max":128 }, + "MetricDatum":{ + "type":"structure", + "members":{ + "timestamp":{"shape":"Timestamp"}, + "value":{"shape":"MetricValue"} + } + }, + "MetricDatumList":{ + "type":"list", + "member":{"shape":"MetricDatum"} + }, "MetricDimension":{ "type":"structure", "required":["dimensionName"], @@ -13400,7 +13484,7 @@ "VerificationStateDescription":{ "type":"string", "max":1000, - "pattern":"[\\p{Graph}\\x20]*" + "pattern":"[^\\p{Cntrl}]*" }, "Version":{"type":"long"}, "VersionConflictException":{ diff --git a/apis/iot/2015-05-28/docs-2.json b/apis/iot/2015-05-28/docs-2.json index 71937210fac..ed77e5753d6 100644 --- a/apis/iot/2015-05-28/docs-2.json +++ b/apis/iot/2015-05-28/docs-2.json @@ -157,6 +157,7 @@ "ListJobTemplates": "
Returns a list of job templates.
Requires permission to access the ListJobTemplates action.
", "ListJobs": "Lists jobs.
Requires permission to access the ListJobs action.
", "ListManagedJobTemplates": "Returns a list of managed job templates.
", + "ListMetricValues": "Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.
", "ListMitigationActions": "Gets a list of all mitigation actions that match the specified filter criteria.
Requires permission to access the ListMitigationActions action.
", "ListOTAUpdates": "Lists OTA updates.
Requires permission to access the ListOTAUpdates action.
", "ListOutgoingCertificates": "Lists certificates that are being transferred but not yet accepted.
Requires permission to access the ListOutgoingCertificates action.
", @@ -1203,6 +1204,7 @@ "refs": { "AdditionalMetricsToRetainList$member": null, "Behavior$metric": "What is measured by the behavior.
", + "ListMetricValuesRequest$metricName": "The name of the security profile metric for which values are returned.
", "MetricToRetain$metric": "What is measured by the behavior.
" } }, @@ -3000,6 +3002,7 @@ "DetectMitigationActionExecution$thingName": "The name of the thing.
", "ListActiveViolationsRequest$thingName": "The name of the thing whose active violations are listed.
", "ListDetectMitigationActionsExecutionsRequest$thingName": "The name of the thing whose mitigation actions are listed.
", + "ListMetricValuesRequest$thingName": "The name of the thing for which security profile metric values are returned.
", "ListViolationEventsRequest$thingName": "A filter to limit results to those alerts caused by the specified thing.
", "ViolationEvent$thingName": "The name of the thing responsible for the violation event.
" } @@ -3021,6 +3024,7 @@ "DescribeDimensionRequest$name": "The unique identifier for the dimension.
", "DescribeDimensionResponse$name": "The unique identifier for the dimension.
", "DimensionNames$member": null, + "ListMetricValuesRequest$dimensionName": "The dimension name.
", "ListSecurityProfilesRequest$dimensionName": "A filter to limit results to the security profiles that use the defined dimension. Cannot be used with metricName
A unique identifier for the dimension.
", "UpdateDimensionRequest$name": "A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.
", @@ -3059,6 +3063,7 @@ "DimensionValueOperator": { "base": null, "refs": { + "ListMetricValuesRequest$dimensionValueOperator": "The dimension value operator.
", "MetricDimension$operator": "Defines how the dimensionValues
of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the IN
operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN
operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null
), it will be interpreted as IN
.
The hash algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses SHA256
or SHA1
, so you can pass either of them based on which was used for generating the signature.
The hash algorithm used to code sign the file.
" } }, "HashKeyField": { @@ -4573,6 +4578,16 @@ "refs": { } }, + "ListMetricValuesRequest": { + "base": null, + "refs": { + } + }, + "ListMetricValuesResponse": { + "base": null, + "refs": { + } + }, "ListMitigationActionsRequest": { "base": null, "refs": { @@ -5049,6 +5064,7 @@ "ListDetectMitigationActionsTasksRequest$maxResults": "The maximum number of results to return at one time. The default is 25.
", "ListDimensionsRequest$maxResults": "The maximum number of results to retrieve at one time.
", "ListFleetMetricsRequest$maxResults": "The maximum number of results to return in this operation.
", + "ListMetricValuesRequest$maxResults": "The maximum number of results to return at one time.
", "ListMitigationActionsRequest$maxResults": "The maximum number of results to return at one time. The default is 25.
", "ListOTAUpdatesRequest$maxResults": "The maximum number of results to return at one time.
", "ListProvisioningTemplateVersionsRequest$maxResults": "The maximum number of results to return at one time.
", @@ -5095,6 +5111,18 @@ "IotEventsAction$messageId": "The ID of the message. The default messageId
is a new UUID value.
When batchMode
is true
, you can't specify a messageId
--a new UUID value will be assigned.
Assign a value to this property to ensure that only one input (message) with a given messageId
will be processed by an IoT Events detector.
A metric.
", + "refs": { + "MetricDatumList$member": null + } + }, + "MetricDatumList": { + "base": null, + "refs": { + "ListMetricValuesResponse$metricDatumList": "The data the thing reports for the metric during the specified time period.
" + } + }, "MetricDimension": { "base": "The dimension of a metric.
", "refs": { @@ -5133,6 +5161,7 @@ "refs": { "ActiveViolation$lastViolationValue": "The value of the metric (the measurement) that caused the most recent violation.
", "BehaviorCriteria$value": "The value to be compared with the metric
.
The value reported for the metric.
", "ViolationEvent$metricValue": "The value of the metric (the measurement).
" } }, @@ -5351,6 +5380,8 @@ "ListJobsResponse$nextToken": "The token for the next set of results, or null if there are no additional results.
", "ListManagedJobTemplatesRequest$nextToken": "The token to retrieve the next set of results.
", "ListManagedJobTemplatesResponse$nextToken": "The token to retrieve the next set of results.
", + "ListMetricValuesRequest$nextToken": "The token for the next set of results.
", + "ListMetricValuesResponse$nextToken": "A token that can be used to retrieve the next set of results, or null
if there are no additional results.
The token for the next set of results.
", "ListMitigationActionsResponse$nextToken": "The token for the next set of results.
", "ListOTAUpdatesRequest$nextToken": "A token used to retrieve the next set of results.
", @@ -5429,6 +5460,7 @@ "NullableBoolean": { "base": null, "refs": { + "AddThingsToThingGroupParams$overrideDynamicGroups": "Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic thing groups.
", "StartDetectMitigationActionsTaskRequest$includeOnlyActiveViolations": "Specifies to list only active violations.
", "StartDetectMitigationActionsTaskRequest$includeSuppressedAlerts": "Specifies to include suppressed alerts.
" } @@ -5581,7 +5613,6 @@ "base": null, "refs": { "AddThingToThingGroupRequest$overrideDynamicGroups": "Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.
", - "AddThingsToThingGroupParams$overrideDynamicGroups": "Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic thing groups.
", "UpdateThingGroupsForThingRequest$overrideDynamicGroups": "Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.
" } }, @@ -6864,7 +6895,7 @@ "SignatureAlgorithm": { "base": null, "refs": { - "CustomCodeSigning$signatureAlgorithm": "The signature algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses ECDSA
or RSA
, so you can pass either of them based on which was used for generating the signature.
The signature algorithm used to code sign the file.
" } }, "SigningJobId": { @@ -7809,8 +7840,11 @@ "ListDetectMitigationActionsExecutionsRequest$endTime": "The end of the time period for which ML Detect mitigation actions executions are returned.
", "ListDetectMitigationActionsTasksRequest$startTime": "A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.
", "ListDetectMitigationActionsTasksRequest$endTime": "The end of the time period for which ML Detect mitigation actions tasks are returned.
", + "ListMetricValuesRequest$startTime": "The start of the time period for which metric values are returned.
", + "ListMetricValuesRequest$endTime": "The end of the time period for which metric values are returned.
", "ListViolationEventsRequest$startTime": "The start time for the alerts to be listed.
", "ListViolationEventsRequest$endTime": "The end time for the alerts to be listed.
", + "MetricDatum$timestamp": "The time the metric value was reported.
", "MitigationActionIdentifier$creationDate": "The date when this mitigation action was created.
", "UpdateAuditSuppressionRequest$expirationDate": "The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.
", "UpdateCustomMetricResponse$creationDate": "The creation date of the custom metric in milliseconds since epoch.
", diff --git a/apis/iot/2015-05-28/paginators-1.json b/apis/iot/2015-05-28/paginators-1.json index ee534f696c7..61293e3d27a 100644 --- a/apis/iot/2015-05-28/paginators-1.json +++ b/apis/iot/2015-05-28/paginators-1.json @@ -144,6 +144,12 @@ "output_token": "nextToken", "result_key": "jobs" }, + "ListMetricValues": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "metricDatumList" + }, "ListMitigationActions": { "input_token": "nextToken", "limit_key": "maxResults", diff --git a/apis/proton/2020-07-20/api-2.json b/apis/proton/2020-07-20/api-2.json index 09d8f67643e..62659abe27e 100644 --- a/apis/proton/2020-07-20/api-2.json +++ b/apis/proton/2020-07-20/api-2.json @@ -1385,7 +1385,8 @@ "connectionArn":{"shape":"Arn"}, "encryptionKey":{"shape":"Arn"}, "name":{"shape":"RepositoryName"}, - "provider":{"shape":"RepositoryProvider"} + "provider":{"shape":"RepositoryProvider"}, + "tags":{"shape":"TagList"} } }, "CreateRepositoryOutput":{ diff --git a/apis/proton/2020-07-20/docs-2.json b/apis/proton/2020-07-20/docs-2.json index 2b20ab79205..4a56e7f5940 100644 --- a/apis/proton/2020-07-20/docs-2.json +++ b/apis/proton/2020-07-20/docs-2.json @@ -6,15 +6,15 @@ "CancelEnvironmentDeployment": "Attempts to cancel an environment deployment on an UpdateEnvironment action, if the deployment is IN_PROGRESS
. For more information, see Update an environment in the Proton Administrator guide.
The following list includes potential cancellation scenarios.
If the cancellation attempt succeeds, the resulting deployment state is CANCELLED
.
If the cancellation attempt fails, the resulting deployment state is FAILED
.
If the current UpdateEnvironment action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED
and the cancellation attempt has no effect.
Attempts to cancel a service instance deployment on an UpdateServiceInstance action, if the deployment is IN_PROGRESS
. For more information, see Update a service instance in the Proton Administrator guide or the Proton User guide.
The following list includes potential cancellation scenarios.
If the cancellation attempt succeeds, the resulting deployment state is CANCELLED
.
If the cancellation attempt fails, the resulting deployment state is FAILED
.
If the current UpdateServiceInstance action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED
and the cancellation attempt has no effect.
Attempts to cancel a service pipeline deployment on an UpdateServicePipeline action, if the deployment is IN_PROGRESS
. For more information, see Update a service pipeline in the Proton Administrator guide or the Proton User guide.
The following list includes potential cancellation scenarios.
If the cancellation attempt succeeds, the resulting deployment state is CANCELLED
.
If the cancellation attempt fails, the resulting deployment state is FAILED
.
If the current UpdateServicePipeline action succeeds before the cancellation attempt starts, the resulting deployment state is SUCCEEDED
and the cancellation attempt has no effect.
Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services.
You can provision environments using the following methods:
Standard provisioning: Proton makes direct calls to provision your resources.
Pull request provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC engine uses to provision resources.
For more information, see the Environments in the Proton Administrator Guide.
", + "CreateEnvironment": "Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be shared across services.
You can provision environments using the following methods:
Amazon Web Services-managed provisioning: Proton makes direct calls to provision your resources.
Self-managed provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC engine uses to provision resources.
For more information, see Environments and Provisioning methods in the Proton Administrator Guide.
", "CreateEnvironmentAccountConnection": "Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment account from a management account.
An environment account connection is a secure bi-directional connection between a management account and an environment account that maintains authorization and permissions. For more information, see Environment account connections in the Proton Administrator guide.
", "CreateEnvironmentTemplate": "Create an environment template for Proton. For more information, see Environment Templates in the Proton Administrator Guide.
You can create an environment template in one of the two following ways:
Register and publish a standard environment template that instructs Proton to deploy and manage environment infrastructure.
Register and publish a customer managed environment template that connects Proton to your existing provisioned infrastructure that you manage. Proton doesn't manage your existing provisioned infrastructure. To create an environment template for customer provisioned and managed infrastructure, include the provisioning
parameter and set the value to CUSTOMER_MANAGED
. For more information, see Register and publish an environment template in the Proton Administrator Guide.
Create a new major or minor version of an environment template. A major version of an environment template is a version that isn't backwards compatible. A minor version of an environment template is a version that's backwards compatible within its major version.
", - "CreateRepository": "Create and register a link to a repository that can be used with pull request provisioning or template sync configurations. For more information, see Template bundles and Template sync configurations in the Proton Administrator Guide.
", + "CreateRepository": "Create and register a link to a repository that can be used with self-managed provisioning (infrastructure or pipelines) or for template sync configurations. When you create a repository link, Proton creates a service-linked role for you.
For more information, see Self-managed provisioning, Template bundles, and Template sync configurations in the Proton Administrator Guide.
", "CreateService": "Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline. For more information, see Services in the Proton Administrator Guide and Services in the Proton User Guide.
", - "CreateServiceTemplate": "Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CICD service pipeline. Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Service Templates in the Proton Administrator Guide.
", + "CreateServiceTemplate": "Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service pipeline. Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more information, see Service Templates in the Proton Administrator Guide.
", "CreateServiceTemplateVersion": "Create a new major or minor version of a service template. A major version of a service template is a version that isn't backward compatible. A minor version of a service template is a version that's backward compatible within its major version.
", - "CreateTemplateSyncConfig": "Set up a template for automated template version creation. When a commit is pushed to your registered repository, Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new minor or major version of its template is created, if the version doesn’t already exist. For more information, see Template sync configurations in the Proton Administrator Guide.
", + "CreateTemplateSyncConfig": "Set up a template to create new template versions automatically. When a commit is pushed to your registered repository, Proton checks for changes to your repository template bundles. If it detects a template bundle change, a new major or minor version of its template is created, if the version doesn’t already exist. For more information, see Template sync configurations in the Proton Administrator Guide.
", "DeleteEnvironment": "Delete an environment.
", "DeleteEnvironmentAccountConnection": "In an environment account, delete an environment account connection.
After you delete an environment account connection that’s in use by an Proton environment, Proton can’t manage the environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're responsible for cleaning up provisioned resources that remain without an environment connection.
For more information, see Environment account connections in the Proton Administrator guide.
", "DeleteEnvironmentTemplate": "If no other major or minor versions of an environment template exist, delete the environment template.
", @@ -30,9 +30,9 @@ "GetEnvironmentTemplate": "Get detail data for an environment template.
", "GetEnvironmentTemplateVersion": "View detail data for a major or minor version of an environment template.
", "GetRepository": "Get detail data for a repository.
", - "GetRepositorySyncStatus": "Get the repository sync status.
", + "GetRepositorySyncStatus": "Get the sync status of a repository used for Proton template sync. For more information about template sync, see .
A repository sync status isn't tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control (ABAC).
For more information about ABAC, see ABAC in the Proton Administrator Guide.
Get detail data for a service.
", - "GetServiceInstance": "Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific environment.
", + "GetServiceInstance": "Get detail data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.
", "GetServiceTemplate": "Get detail data for a service template.
", "GetServiceTemplateVersion": "View detail data for a major or minor version of a service template.
", "GetTemplateSyncConfig": "Get detail data for a template sync configuration.
", @@ -54,18 +54,18 @@ "ListServiceTemplates": "List service templates with detail data.
", "ListServices": "List services with summaries of detail data.
", "ListTagsForResource": "List tags for a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", - "NotifyResourceDeploymentStatusChange": "Notify Proton of status changes to a provisioned resource when you use pull request provisioning. For more information, see Template bundles.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
In a management account, reject an environment account connection from another environment account.
After you reject an environment account connection request, you won’t be able to accept or use the rejected environment account connection.
You can’t reject an environment account connection that is connected to an environment.
For more information, see Environment account connections in the Proton Administrator guide.
", - "TagResource": "Tag a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", - "UntagResource": "Remove a tag from a resource. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", + "NotifyResourceDeploymentStatusChange": "Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.
For more information, see Self-managed provisioning in the Proton Administrator Guide.
", + "RejectEnvironmentAccountConnection": "In a management account, reject an environment account connection from another environment account.
After you reject an environment account connection request, you can't accept or use the rejected environment account connection.
You can’t reject an environment account connection that's connected to an environment.
For more information, see Environment account connections in the Proton Administrator guide.
", + "TagResource": "Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.
For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", + "UntagResource": "Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource.
For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", "UpdateAccountSettings": "Update the Proton service pipeline role or repository settings.
", - "UpdateEnvironment": "Update an environment.
If the environment is associated with an environment account connection, don't update or include the protonServiceRoleArn
and provisioningRepository
parameter to update or connect to an environment account connection.
You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.
If the environment isn't associated with an environment account connection, don't update or include the environmentAccountConnectionId
parameter to update or connect to an environment account connection.
You can update either the environmentAccountConnectionId
or protonServiceRoleArn
parameter and value. You can’t update both.
If the environment was provisioned with pull request provisioning, include the provisioningRepository
parameter and omit the protonServiceRoleArn
and environmentAccountConnectionId
parameters.
If the environment wasn't provisioned with pull request provisioning, omit the provisioningRepository
parameter.
There are four modes for updating an environment as described in the following. The deploymentType
field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type
.
MINOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version (optional).
Update an environment.
If the environment is associated with an environment account connection, don't update or include the protonServiceRoleArn
and provisioningRepository
parameter to update or connect to an environment account connection.
You can only update to a new environment account connection if that connection was created in the same environment account that the current environment account connection was created in. The account connection must also be associated with the current environment.
If the environment isn't associated with an environment account connection, don't update or include the environmentAccountConnectionId
parameter. You can't update or connect the environment to an environment account connection if it isn't already associated with an environment connection.
You can update either the environmentAccountConnectionId
or protonServiceRoleArn
parameter and value. You can’t update both.
If the environment was configured for Amazon Web Services-managed provisioning, omit the provisioningRepository
parameter.
If the environment was configured for self-managed provisioning, specify the provisioningRepository
parameter and omit the protonServiceRoleArn
and environmentAccountConnectionId
parameters.
For more information, see Environments and Provisioning methods in the Proton Administrator Guide.
There are four modes for updating an environment. The deploymentType
field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type
.
MINOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version.
In an environment account, update an environment account connection to use a new IAM role.
For more information, see Environment account connections in the Proton Administrator guide.
", "UpdateEnvironmentTemplate": "Update an environment template.
", "UpdateEnvironmentTemplateVersion": "Update a major or minor version of an environment template.
", "UpdateService": "Edit a service description or use a spec to add and delete service instances.
Existing service instances and the service pipeline can't be edited using this API. They can only be deleted.
Use the description
parameter to modify the description.
Edit the spec
parameter to add or delete instances.
Update a service instance.
There are four modes for updating a service instance as described in the following. The deploymentType
field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type
.
MINOR_VERSION
In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
Update the service pipeline.
There are four modes for updating a service pipeline as described in the following. The deploymentType
field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type
.
MINOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
Update a service instance.
There are four modes for updating a service instance. The deploymentType
field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type
.
MINOR_VERSION
In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version.
Update the service pipeline.
There are four modes for updating a service pipeline. The deploymentType
field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type
.
MINOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template by default. You can specify a different major version that's higher than the major version in use and a minor version.
Update a service template.
", "UpdateServiceTemplateVersion": "Update a major or minor version of a service template.
", "UpdateTemplateSyncConfig": "Update template sync configuration parameters, except for the templateName
and templateType
.
The Proton pipeline service role and repository data.
", + "base": "The Proton pipeline service role and repository data shared across the Amazon Web Services account.
", "refs": { "GetAccountSettingsOutput$accountSettings": "The Proton pipeline service role detail data that's returned by Proton.
", - "UpdateAccountSettingsOutput$accountSettings": "The Proton pipeline service role repository detail data that's returned by Proton.
" + "UpdateAccountSettingsOutput$accountSettings": "The Proton pipeline service role and repository data shared across the Amazon Web Services account.
" } }, "Arn": { "base": null, "refs": { "CreateEnvironmentAccountConnectionInput$roleArn": "The Amazon Resource Name (ARN) of the IAM service role that's created in the environment account. Proton uses this role to provision infrastructure resources in the associated environment account.
", - "CreateEnvironmentInput$protonServiceRoleArn": "The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf. You must include either the environmentAccountConnectionId
or protonServiceRoleArn
parameter and value and omit the provisioningRepository
parameter when you use standard provisioning.
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId
or protonServiceRoleArn
parameter and omit the provisioningRepository
parameter.
A customer provided encryption key that Proton uses to encrypt data.
", - "CreateRepositoryInput$connectionArn": "The Amazon Resource Name (ARN) of your Amazon Web Services CodeStar connection. For more information, see Setting up for Proton in the Proton Administrator Guide.
", + "CreateRepositoryInput$connectionArn": "The Amazon Resource Name (ARN) of your Amazon Web Services CodeStar connection. For more information, see Setting up for Proton in the Proton Administrator Guide.
", "CreateRepositoryInput$encryptionKey": "The ARN of your customer Amazon Web Services Key Management Service (Amazon Web Services KMS) key.
", "CreateServiceInput$repositoryConnectionArn": "The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up repository connection in the Proton Administrator Guide and Setting up with Proton in the Proton User Guide. Don't include this parameter if your service template doesn't include a service pipeline.
", "CreateServiceTemplateInput$encryptionKey": "A customer provided encryption key that's used to encrypt data.
", @@ -115,16 +115,16 @@ "Service$repositoryConnectionArn": "The Amazon Resource Name (ARN) of the repository connection. For more information, see Set up a repository connection in the Proton Administrator Guide and Setting up with Proton in the Proton User Guide.
", "ServicePipeline$arn": "The Amazon Resource Name (ARN) of the service pipeline.
", "ServiceTemplate$encryptionKey": "The customer provided service template encryption key that's used to encrypt data.
", - "TagResourceInput$resourceArn": "The Amazon Resource Name (ARN) of the resource that the resource tag is applied to.
", - "UntagResourceInput$resourceArn": "The Amazon Resource Name (ARN) of the resource that the tag is to be removed from.
", - "UpdateEnvironmentAccountConnectionInput$roleArn": "The Amazon Resource Name (ARN) of the IAM service role that is associated with the environment account connection to update.
", + "TagResourceInput$resourceArn": "The Amazon Resource Name (ARN) of the Proton resource to apply customer tags to.
", + "UntagResourceInput$resourceArn": "The Amazon Resource Name (ARN) of the resource to remove customer tags from.
", + "UpdateEnvironmentAccountConnectionInput$roleArn": "The Amazon Resource Name (ARN) of the IAM service role that's associated with the environment account connection to update.
", "UpdateEnvironmentInput$protonServiceRoleArn": "The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make API calls to other services your behalf.
" } }, "AwsAccountId": { "base": null, "refs": { - "CreateEnvironmentAccountConnectionInput$managementAccountId": "The ID of the management account that accepts or rejects the environment account connection. You create an manage the Proton environment in this account. If the management account accepts the environment account connection, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
", + "CreateEnvironmentAccountConnectionInput$managementAccountId": "The ID of the management account that accepts or rejects the environment account connection. You create and manage the Proton environment in this account. If the management account accepts the environment account connection, Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.
", "Environment$environmentAccountId": "The ID of the environment account that the environment infrastructure resources are provisioned in.
", "EnvironmentAccountConnection$environmentAccountId": "The environment account that's connected to the environment account connection.
", "EnvironmentAccountConnection$managementAccountId": "The ID of the management account that's connected to the environment account connection.
", @@ -400,9 +400,9 @@ "DeploymentUpdateType": { "base": null, "refs": { - "UpdateEnvironmentInput$deploymentType": "There are four modes for updating an environment as described in the following. The deploymentType
field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type
.
MINOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
The deployment type.
There are four modes for updating a service instance as described in the following. The deploymentType
field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type
.
MINOR_VERSION
In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
The deployment type.
There are four modes for updating a service pipeline as described in the following. The deploymentType
field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type
.
MINOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
There are four modes for updating an environment. The deploymentType
field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type
.
MINOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).
The deployment type.
There are four modes for updating a service instance. The deploymentType
field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type
.
MINOR_VERSION
In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.
The deployment type.
There are four modes for updating a service pipeline. The deploymentType
field defines the mode.
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.
CURRENT_VERSION
In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include major or minor version parameters when you use this deployment-type
.
MINOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can specify a different minor version of the current major version in use.
MAJOR_VERSION
In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can specify a different major version that's higher than the major version in use and a minor version.
The service template name as displayed in the developer interface.
", "ServiceTemplateSummary$displayName": "The service template name as displayed in the developer interface.
", "UpdateEnvironmentTemplateInput$displayName": "The name of the environment template to update as displayed in the developer interface.
", - "UpdateServiceTemplateInput$displayName": "The name of the service template to update as displayed in the developer interface.
" + "UpdateServiceTemplateInput$displayName": "The name of the service template to update that's displayed in the developer interface.
" } }, "EmptyNextToken": { "base": null, "refs": { - "ListEnvironmentOutputsInput$nextToken": "A token to indicate the location of the next environment output in the array of environment outputs, after the list of environment outputs that was previously requested.
", - "ListEnvironmentOutputsOutput$nextToken": "A token to indicate the location of the next environment output in the array of environment outputs, after the current requested list of environment outputs.
", - "ListEnvironmentProvisionedResourcesInput$nextToken": "A token to indicate the location of the next environment provisioned resource in the array of environment provisioned resources, after the list of environment provisioned resources that was previously requested.
", - "ListEnvironmentProvisionedResourcesOutput$nextToken": "A token to indicate the location of the next environment provisioned resource in the array of provisioned resources, after the current requested list of environment provisioned resources.
", - "ListRepositorySyncDefinitionsInput$nextToken": "A token to indicate the location of the next repository sync definition in the array of repository sync definitions, after the list of repository sync definitions previously requested.
", - "ListRepositorySyncDefinitionsOutput$nextToken": "A token to indicate the location of the next repository sync definition in the array of repository sync definitions, after the current requested list of repository sync definitions.
", - "ListServiceInstanceOutputsInput$nextToken": "A token to indicate the location of the next output in the array of outputs, after the list of outputs that was previously requested.
", - "ListServiceInstanceOutputsOutput$nextToken": "A token to indicate the location of the next output in the array of outputs, after the current requested list of outputs.
", - "ListServiceInstanceProvisionedResourcesInput$nextToken": "A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.
", - "ListServiceInstanceProvisionedResourcesOutput$nextToken": "A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.
", - "ListServicePipelineOutputsInput$nextToken": "A token to indicate the location of the next output in the array of outputs, after the list of outputs that was previously requested.
", - "ListServicePipelineOutputsOutput$nextToken": "A token to indicate the location of the next output in the array of outputs, after the current requested list of outputs.
", - "ListServicePipelineProvisionedResourcesInput$nextToken": "A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.
", - "ListServicePipelineProvisionedResourcesOutput$nextToken": "A token to indicate the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.
" + "ListEnvironmentOutputsInput$nextToken": "A token that indicates the location of the next environment output in the array of environment outputs, after the list of environment outputs that was previously requested.
", + "ListEnvironmentOutputsOutput$nextToken": "A token that indicates the location of the next environment output in the array of environment outputs, after the current requested list of environment outputs.
", + "ListEnvironmentProvisionedResourcesInput$nextToken": "A token that indicates the location of the next environment provisioned resource in the array of environment provisioned resources, after the list of environment provisioned resources that was previously requested.
", + "ListEnvironmentProvisionedResourcesOutput$nextToken": "A token that indicates the location of the next environment provisioned resource in the array of provisioned resources, after the current requested list of environment provisioned resources.
", + "ListRepositorySyncDefinitionsInput$nextToken": "A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the list of repository sync definitions previously requested.
", + "ListRepositorySyncDefinitionsOutput$nextToken": "A token that indicates the location of the next repository sync definition in the array of repository sync definitions, after the current requested list of repository sync definitions.
", + "ListServiceInstanceOutputsInput$nextToken": "A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.
", + "ListServiceInstanceOutputsOutput$nextToken": "A token that indicates the location of the next output in the array of outputs, after the current requested list of outputs.
", + "ListServiceInstanceProvisionedResourcesInput$nextToken": "A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.
", + "ListServiceInstanceProvisionedResourcesOutput$nextToken": "A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.
", + "ListServicePipelineOutputsInput$nextToken": "A token that indicates the location of the next output in the array of outputs, after the list of outputs that was previously requested.
", + "ListServicePipelineOutputsOutput$nextToken": "A token that indicates the location of the next output in the array of outputs, after the current requested list of outputs.
", + "ListServicePipelineProvisionedResourcesInput$nextToken": "A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.
", + "ListServicePipelineProvisionedResourcesOutput$nextToken": "A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.
" } }, "Environment": { @@ -498,7 +498,7 @@ "base": null, "refs": { "AcceptEnvironmentAccountConnectionInput$id": "The ID of the environment account connection.
", - "CreateEnvironmentInput$environmentAccountConnectionId": "The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. You must include either the environmentAccountConnectionId
or protonServiceRoleArn
parameter and value and omit the provisioningRepository
parameter and values. For more information, see Environment account connections in the Proton Administrator guide.
The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see Environment account connections in the Proton Administrator guide.
To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId
or protonServiceRoleArn
parameter and omit the provisioningRepository
parameter.
The ID of the environment account connection to delete.
", "Environment$environmentAccountConnectionId": "The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
", "EnvironmentAccountConnection$id": "The ID of the environment account connection.
", @@ -988,24 +988,24 @@ "NextToken": { "base": null, "refs": { - "ListEnvironmentAccountConnectionsInput$nextToken": "A token to indicate the location of the next environment account connection in the array of environment account connections, after the list of environment account connections that was previously requested.
", - "ListEnvironmentAccountConnectionsOutput$nextToken": "A token to indicate the location of the next environment account connection in the array of environment account connections, after the current requested list of environment account connections.
", - "ListEnvironmentTemplateVersionsInput$nextToken": "A token to indicate the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.
", - "ListEnvironmentTemplateVersionsOutput$nextToken": "A token to indicate the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.
", - "ListEnvironmentTemplatesInput$nextToken": "A token to indicate the location of the next environment template in the array of environment templates, after the list of environment templates that was previously requested.
", - "ListEnvironmentTemplatesOutput$nextToken": "A token to indicate the location of the next environment template in the array of environment templates, after the current requested list of environment templates.
", - "ListEnvironmentsInput$nextToken": "A token to indicate the location of the next environment in the array of environments, after the list of environments that was previously requested.
", - "ListEnvironmentsOutput$nextToken": "A token to indicate the location of the next environment in the array of environments, after the current requested list of environments.
", - "ListRepositoriesInput$nextToken": "A token to indicate the location of the next repository in the array of repositories, after the list of repositories previously requested.
", - "ListRepositoriesOutput$nextToken": "A token to indicate the location of the next repository in the array of repositories, after the current requested list of repositories.
", - "ListServiceInstancesInput$nextToken": "A token to indicate the location of the next service in the array of service instances, after the list of service instances that was previously requested.
", - "ListServiceInstancesOutput$nextToken": "A token to indicate the location of the next service instance in the array of service instances, after the current requested list of service instances.
", - "ListServiceTemplateVersionsInput$nextToken": "A token to indicate the location of the next major or minor version in the array of major or minor versions of a service template, after the list of major or minor versions that was previously requested.
", - "ListServiceTemplateVersionsOutput$nextToken": "A token to indicate the location of the next major or minor version in the array of major or minor versions of a service template, after the current requested list of service major or minor versions.
", - "ListServiceTemplatesInput$nextToken": "A token to indicate the location of the next service template in the array of service templates, after the list of service templates previously requested.
", - "ListServiceTemplatesOutput$nextToken": "A token to indicate the location of the next service template in the array of service templates, after the current requested list of service templates.
", - "ListServicesInput$nextToken": "A token to indicate the location of the next service in the array of services, after the list of services that was previously requested.
", - "ListServicesOutput$nextToken": "A token to indicate the location of the next service in the array of services, after the current requested list of services.
" + "ListEnvironmentAccountConnectionsInput$nextToken": "A token that indicates the location of the next environment account connection in the array of environment account connections, after the list of environment account connections that was previously requested.
", + "ListEnvironmentAccountConnectionsOutput$nextToken": "A token that indicates the location of the next environment account connection in the array of environment account connections, after the current requested list of environment account connections.
", + "ListEnvironmentTemplateVersionsInput$nextToken": "A token that indicates the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.
", + "ListEnvironmentTemplateVersionsOutput$nextToken": "A token that indicates the location of the next major or minor version in the array of major or minor versions of an environment template, after the list of major or minor versions that was previously requested.
", + "ListEnvironmentTemplatesInput$nextToken": "A token that indicates the location of the next environment template in the array of environment templates, after the list of environment templates that was previously requested.
", + "ListEnvironmentTemplatesOutput$nextToken": "A token that indicates the location of the next environment template in the array of environment templates, after the current requested list of environment templates.
", + "ListEnvironmentsInput$nextToken": "A token that indicates the location of the next environment in the array of environments, after the list of environments that was previously requested.
", + "ListEnvironmentsOutput$nextToken": "A token that indicates the location of the next environment in the array of environments, after the current requested list of environments.
", + "ListRepositoriesInput$nextToken": "A token that indicates the location of the next repository in the array of repositories, after the list of repositories previously requested.
", + "ListRepositoriesOutput$nextToken": "A token that indicates the location of the next repository in the array of repositories, after the current requested list of repositories.
", + "ListServiceInstancesInput$nextToken": "A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.
", + "ListServiceInstancesOutput$nextToken": "A token that indicates the location of the next service instance in the array of service instances, after the current requested list of service instances.
", + "ListServiceTemplateVersionsInput$nextToken": "A token that indicates the location of the next major or minor version in the array of major or minor versions of a service template, after the list of major or minor versions that was previously requested.
", + "ListServiceTemplateVersionsOutput$nextToken": "A token that indicates the location of the next major or minor version in the array of major or minor versions of a service template, after the current requested list of service major or minor versions.
", + "ListServiceTemplatesInput$nextToken": "A token that indicates the location of the next service template in the array of service templates, after the list of service templates previously requested.
", + "ListServiceTemplatesOutput$nextToken": "A token that indicates the location of the next service template in the array of service templates, after the current requested list of service templates.
", + "ListServicesInput$nextToken": "A token that indicates the location of the next service in the array of services, after the list of services that was previously requested.
", + "ListServicesOutput$nextToken": "A token that indicates the location of the next service in the array of services, after the current requested list of services.
" } }, "NotifyResourceDeploymentStatusChangeInput": { @@ -1054,8 +1054,8 @@ "PipelineRoleArn": { "base": null, "refs": { - "AccountSettings$pipelineServiceRoleArn": "The Amazon Resource Name (ARN) of the Proton pipeline service role.
", - "UpdateAccountSettingsInput$pipelineServiceRoleArn": "The Amazon Resource Name (ARN) of the Proton pipeline service role.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed provisioning, and by customer-owned automation for self-managed provisioning.
", + "UpdateAccountSettingsInput$pipelineServiceRoleArn": "The Amazon Resource Name (ARN) of the service role you want to use for provisioning pipelines. Assumed by Proton for Amazon Web Services-managed provisioning, and by customer-owned automation for self-managed provisioning.
" } }, "ProvisionedResource": { @@ -1067,7 +1067,7 @@ "ProvisionedResourceEngine": { "base": "List of provisioning engines
", "refs": { - "ProvisionedResource$provisioningEngine": "The resource provisioning engine.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
The resource provisioning engine. At this time, CLOUDFORMATION
can be used for Amazon Web Services-managed provisioning, and TERRAFORM
can be used for self-managed provisioning.
For more information, see Self-managed provisioning in the Proton Administrator Guide.
" } }, "ProvisionedResourceIdentifier": { @@ -1094,7 +1094,7 @@ "base": null, "refs": { "CreateEnvironmentTemplateInput$provisioning": "When included, indicates that the environment template is for customer provisioned and managed infrastructure.
", - "CreateServiceTemplateInput$pipelineProvisioning": "Proton includes a service pipeline for your service by default. When included, this parameter indicates that an Proton service pipeline won't be included for your service. Once specified, this parameter can't be changed. For more information, see Service template bundles in the Proton Administrator Guide.
", + "CreateServiceTemplateInput$pipelineProvisioning": "By default, Proton provides a service pipeline for your service. When this parameter is included, it indicates that an Proton service pipeline isn't provided for your service. After it's included, it can't be changed. For more information, see Service template bundles in the Proton Administrator Guide.
", "Environment$provisioning": "When included, indicates that the environment template is for customer provisioned and managed infrastructure.
", "EnvironmentSummary$provisioning": "When included, indicates that the environment template is for customer provisioned and managed infrastructure.
", "EnvironmentTemplate$provisioning": "When included, indicates that the environment template is for customer provisioned and managed infrastructure.
", @@ -1130,18 +1130,18 @@ } }, "RepositoryBranch": { - "base": "Detail data for a repository branch.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
Detail data for a repository branch.
", "refs": { - "AccountSettings$pipelineProvisioningRepository": "The repository that you provide with pull request provisioning.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
The repository that you provide with pull request provisioning.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
The repository configured in the Amazon Web Services account for pipeline provisioning. Required it if you have environments configured for self-managed provisioning with services that include pipelines.
", + "Environment$provisioningRepository": "The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
" } }, "RepositoryBranchInput": { - "base": "Detail input data for a repository branch.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
Detail input data for a repository branch.
", "refs": { - "CreateEnvironmentInput$provisioningRepository": "The repository that you provide with pull request provisioning. If you provide this parameter, you must omit the environmentAccountConnectionId
and protonServiceRoleArn
parameters.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
The repository that you provide with pull request provisioning.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
The repository that you provide with pull request provisioning.
Provisioning by pull request is currently in feature preview and is only usable with Terraform based Proton Templates. To learn more about Amazon Web Services Feature Preview terms, see section 2 on Beta and Previews.
The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId
and protonServiceRoleArn
parameters.
A repository for pipeline provisioning. Specify it if you have environments configured for self-managed provisioning with services that include pipelines.
", + "UpdateEnvironmentInput$provisioningRepository": "The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
" } }, "RepositoryId": { @@ -1154,8 +1154,8 @@ "RepositoryName": { "base": null, "refs": { - "CreateRepositoryInput$name": "The repository name, for example myrepos/myrepo
.
The name of your repository, for example myrepos/myrepo
.
The repository name (for example, myrepos/myrepo
).
The name of your repository (for example, myrepos/myrepo
).
The name of the repository.
", "GetRepositoryInput$name": "The repository name, for example myrepos/myrepo
.
The repository name.
", @@ -1166,7 +1166,7 @@ "RepositorySummary$name": "The repository name.
", "Revision$repositoryName": "The repository name.
", "TemplateSyncConfig$repositoryName": "The name of the repository, for example myrepos/myrepo
.
The name of the repository, for example myrepos/myrepo
.
The name of the repository (for example, myrepos/myrepo
).
Include templateName
to filter search for a template name.
The name of the environment template.
", "EnvironmentTemplateVersion$templateName": "The name of the version of an environment template.
", - "EnvironmentTemplateVersionSummary$templateName": "The name of the version of an environment template.
", + "EnvironmentTemplateVersionSummary$templateName": "The name of the environment template.
", "GetEnvironmentInput$name": "The name of the environment that you want to get the detail data for.
", "GetEnvironmentTemplateInput$name": "The name of the environment template that you want to get the detail data for.
", "GetEnvironmentTemplateVersionInput$templateName": "The name of the environment template.
", @@ -1413,7 +1413,7 @@ "refs": { "CancelServiceInstanceDeploymentOutput$serviceInstance": "The service instance summary data that's returned by Proton.
", "GetServiceInstanceOutput$serviceInstance": "The service instance detail data that's returned by Proton.
", - "UpdateServiceInstanceOutput$serviceInstance": "The service instance summary data returned by Proton.
" + "UpdateServiceInstanceOutput$serviceInstance": "The service instance summary data that's returned by Proton.
" } }, "ServiceInstanceArn": { @@ -1440,7 +1440,7 @@ "refs": { "CancelServicePipelineDeploymentOutput$pipeline": "The service pipeline detail data that's returned by Proton.
", "Service$pipeline": "The service pipeline detail data.
", - "UpdateServicePipelineOutput$pipeline": "The pipeline details returned by Proton.
" + "UpdateServicePipelineOutput$pipeline": "The pipeline details that are returned by Proton.
" } }, "ServiceQuotaExceededException": { @@ -1526,8 +1526,8 @@ "SpecContents": { "base": null, "refs": { - "CreateEnvironmentInput$spec": "A link to a YAML formatted spec file that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton Administrator Guide.
", - "CreateServiceInput$spec": "A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the Proton Administrator Guide and Create a service in the Proton User Guide.
", + "CreateEnvironmentInput$spec": "A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton Administrator Guide.
", + "CreateServiceInput$spec": "A link to a spec file that provides inputs as defined in the service template bundle schema file. The spec file is in YAML format. Don’t include pipeline inputs in the spec if your service template doesn’t include a service pipeline. For more information, see Create a service in the Proton Administrator Guide and Create a service in the Proton User Guide.
", "Environment$spec": "The environment spec.
", "Service$spec": "The formatted specification that defines the service.
", "ServiceInstance$spec": "The service spec that was used to create the service instance.
", @@ -1557,8 +1557,8 @@ "String": { "base": null, "refs": { - "ListTagsForResourceInput$nextToken": "A token to indicate the location of the next resource tag in the array of resource tags, after the list of resource tags that was previously requested.
", - "ListTagsForResourceOutput$nextToken": "A token to indicate the location of the next resource tag in the array of resource tags, after the current requested list of resource tags.
", + "ListTagsForResourceInput$nextToken": "A token that indicates the location of the next resource tag in the array of resource tags, after the list of resource tags that was previously requested.
", + "ListTagsForResourceOutput$nextToken": "A token that indicates the location of the next resource tag in the array of resource tags, after the current requested list of resource tags.
", "RepositorySyncDefinition$directory": "The directory in the repository.
", "RepositorySyncDefinition$parent": "The resource that is synced from.
", "RepositorySyncDefinition$target": "The resource that is synced to.
", @@ -1609,21 +1609,22 @@ "TagKeyList": { "base": null, "refs": { - "UntagResourceInput$tagKeys": "An array of tag keys indicating the resource tags to be removed from the resource.
" + "UntagResourceInput$tagKeys": "A list of customer tag keys that indicate the customer tags to be removed from the resource.
" } }, "TagList": { "base": null, "refs": { - "CreateEnvironmentAccountConnectionInput$tags": "Tags for your environment account connection. For more information, see Proton resources and tagging in the Proton Administrator Guide.
", - "CreateEnvironmentInput$tags": "Create tags for your environment. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", - "CreateEnvironmentTemplateInput$tags": "Create tags for your environment template. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", - "CreateEnvironmentTemplateVersionInput$tags": "Create tags for a new version of an environment template.
", - "CreateServiceInput$tags": "Create tags for your service. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", - "CreateServiceTemplateInput$tags": "Create tags for your service template. For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", - "CreateServiceTemplateVersionInput$tags": "Create tags for a new version of a service template.
", - "ListTagsForResourceOutput$tags": "An array of resource tags with detail data.
", - "TagResourceInput$tags": "An array of resource tags to apply to a resource.
" + "CreateEnvironmentAccountConnectionInput$tags": "An optional list of metadata items that you can associate with the Proton environment account connection. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton Administrator Guide.
", + "CreateEnvironmentInput$tags": "An optional list of metadata items that you can associate with the Proton environment. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", + "CreateEnvironmentTemplateInput$tags": "An optional list of metadata items that you can associate with the Proton environment template. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", + "CreateEnvironmentTemplateVersionInput$tags": "An optional list of metadata items that you can associate with the Proton environment template version. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", + "CreateRepositoryInput$tags": "An optional list of metadata items that you can associate with the Proton repository. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", + "CreateServiceInput$tags": "An optional list of metadata items that you can associate with the Proton service. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", + "CreateServiceTemplateInput$tags": "An optional list of metadata items that you can associate with the Proton service template. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", + "CreateServiceTemplateVersionInput$tags": "An optional list of metadata items that you can associate with the Proton service template version. A tag is a key-value pair.
For more information, see Proton resources and tagging in the Proton Administrator Guide or Proton User Guide.
", + "ListTagsForResourceOutput$tags": "A list of resource tags with detail data.
", + "TagResourceInput$tags": "A list of customer tags to apply to the Proton resource.
" } }, "TagResourceInput": { @@ -1676,7 +1677,7 @@ "CompatibleEnvironmentTemplateInput$majorVersion": "The major version of the compatible environment template.
", "CreateEnvironmentInput$templateMajorVersion": "The major version of the environment template.
", "CreateEnvironmentInput$templateMinorVersion": "The minor version of the environment template.
", - "CreateEnvironmentTemplateVersionInput$majorVersion": "To create a new minor version of the environment template, include a major Version
.
To create a new major and minor version of the environment template, exclude major Version
.
To create a new minor version of the environment template, include major Version
.
To create a new major and minor version of the environment template, exclude major Version
.
The major version of the service template that was used to create the service.
", "CreateServiceInput$templateMinorVersion": "The minor version of the service template that was used to create the service.
", "CreateServiceTemplateVersionInput$majorVersion": "To create a new minor version of the service template, include a major Version
.
To create a new major and minor version of the service template, exclude major Version
.
The environment template minor version to delete.
", "DeleteServiceTemplateVersionInput$majorVersion": "The service template major version to delete.
", "DeleteServiceTemplateVersionInput$minorVersion": "The service template minor version to delete.
", - "Environment$templateMajorVersion": "The ID of the major version of the environment template.
", - "Environment$templateMinorVersion": "The ID of the minor version of the environment template.
", + "Environment$templateMajorVersion": "The major version of the environment template.
", + "Environment$templateMinorVersion": "The minor version of the environment template.
", "EnvironmentSummary$templateMajorVersion": "The major version of the environment template.
", "EnvironmentSummary$templateMinorVersion": "The minor version of the environment template.
", "EnvironmentTemplateFilter$majorVersion": "Include majorVersion
to filter search for a major version.
To view environment template minor version detail data, include minorVersion
.
To view service template major version detail data, include major Version
.
To view service template minor version detail data, include minorVersion
.
The template version.
", + "GetTemplateSyncStatusInput$templateVersion": "The template major version.
", "ListEnvironmentTemplateVersionsInput$majorVersion": "To view a list of minor of versions under a major version of an environment template, include major Version
.
To view a list of major versions of an environment template, exclude major Version
.
To view a list of minor of versions under a major version of a service template, include major Version
.
To view a list of major versions of a service template, exclude major Version
.
The major version of the service template that was used to create the service instance.
", diff --git a/apis/servicecatalog/2015-12-10/api-2.json b/apis/servicecatalog/2015-12-10/api-2.json index 14bb3eadb8e..6c1c0e975d7 100644 --- a/apis/servicecatalog/2015-12-10/api-2.json +++ b/apis/servicecatalog/2015-12-10/api-2.json @@ -2010,7 +2010,12 @@ "UsageInstructions":{"shape":"UsageInstructions"}, "TagOptions":{"shape":"TagOptionSummaries"}, "ProvisioningArtifactPreferences":{"shape":"ProvisioningArtifactPreferences"}, - "ProvisioningArtifactOutputs":{"shape":"ProvisioningArtifactOutputs"} + "ProvisioningArtifactOutputs":{ + "shape":"ProvisioningArtifactOutputs", + "deprecated":true, + "deprecatedMessage":"This property is deprecated and returns the Id and Description of the Provisioning Artifact. Use ProvisioningArtifactOutputKeys instead to get the Keys and Descriptions of the outputs." + }, + "ProvisioningArtifactOutputKeys":{"shape":"ProvisioningArtifactOutputs"} } }, "DescribeRecordInput":{ diff --git a/apis/servicecatalog/2015-12-10/docs-2.json b/apis/servicecatalog/2015-12-10/docs-2.json index 4981a0d6d0f..a5c1fba8030 100644 --- a/apis/servicecatalog/2015-12-10/docs-2.json +++ b/apis/servicecatalog/2015-12-10/docs-2.json @@ -2242,7 +2242,8 @@ "ProvisioningArtifactOutputs": { "base": null, "refs": { - "DescribeProvisioningParametersOutput$ProvisioningArtifactOutputs": "The output of the provisioning artifact.
" + "DescribeProvisioningParametersOutput$ProvisioningArtifactOutputs": "The output of the provisioning artifact.
", + "DescribeProvisioningParametersOutput$ProvisioningArtifactOutputKeys": "A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.
" } }, "ProvisioningArtifactParameter": { diff --git a/apis/sms/2016-10-24/docs-2.json b/apis/sms/2016-10-24/docs-2.json index a059f1ca9d1..7c45a5041da 100644 --- a/apis/sms/2016-10-24/docs-2.json +++ b/apis/sms/2016-10-24/docs-2.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "Product update
As of March 31, 2022, Amazon Web Services will discontinue Server Migration Service (Amazon Web Services SMS). Going forward, we recommend Amazon Web Services Application Migration Service (Amazon Web Services MGN) as the primary migration service for lift-and-shift migrations.
You can initiate new migration jobs in Server Migration Service until January 1, 2022. Complete these active migration projects by March 31, 2022. For more information, see When to Choose AWS Application Migration Service.
Server Migration Service (Server Migration Service) makes it easier and faster for you to migrate your on-premises workloads to Amazon Web Services. To learn more about Server Migration Service, see the following resources:
", + "service": "Product update
We recommend Amazon Web Services Application Migration Service (Amazon Web Services MGN) as the primary migration service for lift-and-shift migrations. If Amazon Web Services MGN is unavailable in a specific Amazon Web Services Region, you can use the Server Migration Service APIs through March 2023.
Server Migration Service (Server Migration Service) makes it easier and faster for you to migrate your on-premises workloads to Amazon Web Services. To learn more about Server Migration Service, see the following resources:
", "operations": { "CreateApp": "Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.
", "CreateReplicationJob": "Creates a replication job. The replication job schedules periodic replication runs to replicate your server to Amazon Web Services. Each replication run creates an Amazon Machine Image (AMI).
", diff --git a/gems/aws-sdk-iot/CHANGELOG.md b/gems/aws-sdk-iot/CHANGELOG.md index 1864931547f..d5eca13d732 100644 --- a/gems/aws-sdk-iot/CHANGELOG.md +++ b/gems/aws-sdk-iot/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.88.0 (2022-04-04) +------------------ + +* Feature - AWS IoT - AWS IoT Device Defender adds support to list metric datapoints collected for IoT devices through the ListMetricValues API + 1.87.0 (2022-03-30) ------------------ diff --git a/gems/aws-sdk-iot/VERSION b/gems/aws-sdk-iot/VERSION index f6342716723..59be592144c 100644 --- a/gems/aws-sdk-iot/VERSION +++ b/gems/aws-sdk-iot/VERSION @@ -1 +1 @@ -1.87.0 +1.88.0 diff --git a/gems/aws-sdk-iot/lib/aws-sdk-iot.rb b/gems/aws-sdk-iot/lib/aws-sdk-iot.rb index 1e19f40ad59..64fedd2d780 100644 --- a/gems/aws-sdk-iot/lib/aws-sdk-iot.rb +++ b/gems/aws-sdk-iot/lib/aws-sdk-iot.rb @@ -48,6 +48,6 @@ # @!group service module Aws::IoT - GEM_VERSION = '1.87.0' + GEM_VERSION = '1.88.0' end diff --git a/gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb b/gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb index 06cb14aaf27..a6b10f32b61 100644 --- a/gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb +++ b/gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb @@ -8879,6 +8879,78 @@ def list_managed_job_templates(params = {}, options = {}) req.send_request(options) end + # Lists the values reported for an IoT Device Defender metric + # (device-side metric, cloud-side metric, or custom metric) by the given + # thing during the specified time period. + # + # @option params [required, String] :thing_name + # The name of the thing for which security profile metric values are + # returned. + # + # @option params [required, String] :metric_name + # The name of the security profile metric for which values are returned. + # + # @option params [String] :dimension_name + # The dimension name. + # + # @option params [String] :dimension_value_operator + # The dimension value operator. + # + # @option params [required, Time,DateTime,Date,Integer,String] :start_time + # The start of the time period for which metric values are returned. + # + # @option params [required, Time,DateTime,Date,Integer,String] :end_time + # The end of the time period for which metric values are returned. + # + # @option params [Integer] :max_results + # The maximum number of results to return at one time. + # + # @option params [String] :next_token + # The token for the next set of results. + # + # @return [Types::ListMetricValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListMetricValuesResponse#metric_datum_list #metric_datum_list} => Array<Types::MetricDatum> + # * {Types::ListMetricValuesResponse#next_token #next_token} => String + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.list_metric_values({ + # thing_name: "DeviceDefenderThingName", # required + # metric_name: "BehaviorMetric", # required + # dimension_name: "DimensionName", + # dimension_value_operator: "IN", # accepts IN, NOT_IN + # start_time: Time.now, # required + # end_time: Time.now, # required + # max_results: 1, + # next_token: "NextToken", + # }) + # + # @example Response structure + # + # resp.metric_datum_list #=> Array + # resp.metric_datum_list[0].timestamp #=> Time + # resp.metric_datum_list[0].value.count #=> Integer + # resp.metric_datum_list[0].value.cidrs #=> Array + # resp.metric_datum_list[0].value.cidrs[0] #=> String + # resp.metric_datum_list[0].value.ports #=> Array + # resp.metric_datum_list[0].value.ports[0] #=> Integer + # resp.metric_datum_list[0].value.number #=> Float + # resp.metric_datum_list[0].value.numbers #=> Array + # resp.metric_datum_list[0].value.numbers[0] #=> Float + # resp.metric_datum_list[0].value.strings #=> Array + # resp.metric_datum_list[0].value.strings[0] #=> String + # resp.next_token #=> String + # + # @overload list_metric_values(params = {}) + # @param [Hash] params ({}) + def list_metric_values(params = {}, options = {}) + req = build_request(:list_metric_values, params) + req.send_request(options) + end + # Gets a list of all mitigation actions that match the specified filter # criteria. # @@ -13600,7 +13672,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-iot' - context[:gem_version] = '1.87.0' + context[:gem_version] = '1.88.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-iot/lib/aws-sdk-iot/client_api.rb b/gems/aws-sdk-iot/lib/aws-sdk-iot/client_api.rb index c85067fbd26..82db6fdfb6d 100644 --- a/gems/aws-sdk-iot/lib/aws-sdk-iot/client_api.rb +++ b/gems/aws-sdk-iot/lib/aws-sdk-iot/client_api.rb @@ -700,6 +700,8 @@ module ClientApi ListJobsResponse = Shapes::StructureShape.new(name: 'ListJobsResponse') ListManagedJobTemplatesRequest = Shapes::StructureShape.new(name: 'ListManagedJobTemplatesRequest') ListManagedJobTemplatesResponse = Shapes::StructureShape.new(name: 'ListManagedJobTemplatesResponse') + ListMetricValuesRequest = Shapes::StructureShape.new(name: 'ListMetricValuesRequest') + ListMetricValuesResponse = Shapes::StructureShape.new(name: 'ListMetricValuesResponse') ListMitigationActionsRequest = Shapes::StructureShape.new(name: 'ListMitigationActionsRequest') ListMitigationActionsResponse = Shapes::StructureShape.new(name: 'ListMitigationActionsResponse') ListOTAUpdatesRequest = Shapes::StructureShape.new(name: 'ListOTAUpdatesRequest') @@ -787,6 +789,8 @@ module ClientApi Message = Shapes::StringShape.new(name: 'Message') MessageFormat = Shapes::StringShape.new(name: 'MessageFormat') MessageId = Shapes::StringShape.new(name: 'MessageId') + MetricDatum = Shapes::StructureShape.new(name: 'MetricDatum') + MetricDatumList = Shapes::ListShape.new(name: 'MetricDatumList') MetricDimension = Shapes::StructureShape.new(name: 'MetricDimension') MetricName = Shapes::StringShape.new(name: 'MetricName') MetricNames = Shapes::ListShape.new(name: 'MetricNames') @@ -1332,7 +1336,7 @@ module ClientApi AddThingToThingGroupResponse.struct_class = Types::AddThingToThingGroupResponse AddThingsToThingGroupParams.add_member(:thing_group_names, Shapes::ShapeRef.new(shape: ThingGroupNames, required: true, location_name: "thingGroupNames")) - AddThingsToThingGroupParams.add_member(:override_dynamic_groups, Shapes::ShapeRef.new(shape: OverrideDynamicGroups, location_name: "overrideDynamicGroups")) + AddThingsToThingGroupParams.add_member(:override_dynamic_groups, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "overrideDynamicGroups")) AddThingsToThingGroupParams.struct_class = Types::AddThingsToThingGroupParams AdditionalMetricsToRetainList.member = Shapes::ShapeRef.new(shape: BehaviorMetric) @@ -3365,6 +3369,20 @@ module ClientApi ListManagedJobTemplatesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken")) ListManagedJobTemplatesResponse.struct_class = Types::ListManagedJobTemplatesResponse + ListMetricValuesRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: DeviceDefenderThingName, required: true, location: "querystring", location_name: "thingName")) + ListMetricValuesRequest.add_member(:metric_name, Shapes::ShapeRef.new(shape: BehaviorMetric, required: true, location: "querystring", location_name: "metricName")) + ListMetricValuesRequest.add_member(:dimension_name, Shapes::ShapeRef.new(shape: DimensionName, location: "querystring", location_name: "dimensionName")) + ListMetricValuesRequest.add_member(:dimension_value_operator, Shapes::ShapeRef.new(shape: DimensionValueOperator, location: "querystring", location_name: "dimensionValueOperator")) + ListMetricValuesRequest.add_member(:start_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location: "querystring", location_name: "startTime")) + ListMetricValuesRequest.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location: "querystring", location_name: "endTime")) + ListMetricValuesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults")) + ListMetricValuesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken")) + ListMetricValuesRequest.struct_class = Types::ListMetricValuesRequest + + ListMetricValuesResponse.add_member(:metric_datum_list, Shapes::ShapeRef.new(shape: MetricDatumList, location_name: "metricDatumList")) + ListMetricValuesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken")) + ListMetricValuesResponse.struct_class = Types::ListMetricValuesResponse + ListMitigationActionsRequest.add_member(:action_type, Shapes::ShapeRef.new(shape: MitigationActionType, location: "querystring", location_name: "actionType")) ListMitigationActionsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults")) ListMitigationActionsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken")) @@ -3685,6 +3703,12 @@ module ClientApi ManagedJobTemplatesSummaryList.member = Shapes::ShapeRef.new(shape: ManagedJobTemplateSummary) + MetricDatum.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "timestamp")) + MetricDatum.add_member(:value, Shapes::ShapeRef.new(shape: MetricValue, location_name: "value")) + MetricDatum.struct_class = Types::MetricDatum + + MetricDatumList.member = Shapes::ShapeRef.new(shape: MetricDatum) + MetricDimension.add_member(:dimension_name, Shapes::ShapeRef.new(shape: DimensionName, required: true, location_name: "dimensionName")) MetricDimension.add_member(:operator, Shapes::ShapeRef.new(shape: DimensionValueOperator, location_name: "operator")) MetricDimension.struct_class = Types::MetricDimension @@ -7011,6 +7035,24 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InternalServerException) end) + api.add_operation(:list_metric_values, Seahorse::Model::Operation.new.tap do |o| + o.name = "ListMetricValues" + o.http_method = "GET" + o.http_request_uri = "/metric-values" + o.input = Shapes::ShapeRef.new(shape: ListMetricValuesRequest) + o.output = Shapes::ShapeRef.new(shape: ListMetricValuesResponse) + o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: InternalFailureException) + o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException) + o[:pager] = Aws::Pager.new( + limit_key: "max_results", + tokens: { + "next_token" => "next_token" + } + ) + end) + api.add_operation(:list_mitigation_actions, Seahorse::Model::Operation.new.tap do |o| o.name = "ListMitigationActions" o.http_method = "GET" diff --git a/gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb b/gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb index d7ae41fcb28..39841e87aec 100644 --- a/gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb +++ b/gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb @@ -5517,21 +5517,11 @@ class CreateTopicRuleRequest < Struct.new( # @return [Types::CodeSigningCertificateChain] # # @!attribute [rw] hash_algorithm - # The hash algorithm used to code sign the file. You can use a string - # as the algorithm name if the target over-the-air (OTA) update - # devices are able to verify the signature that was generated using - # the same signature algorithm. For example, FreeRTOS uses `SHA256` or - # `SHA1`, so you can pass either of them based on which was used for - # generating the signature. + # The hash algorithm used to code sign the file. # @return [String] # # @!attribute [rw] signature_algorithm - # The signature algorithm used to code sign the file. You can use a - # string as the algorithm name if the target over-the-air (OTA) update - # devices are able to verify the signature that was generated using - # the same signature algorithm. For example, FreeRTOS uses `ECDSA` or - # `RSA`, so you can pass either of them based on which was used for - # generating the signature. + # The signature algorithm used to code sign the file. # @return [String] # class CustomCodeSigning < Struct.new( @@ -12108,6 +12098,84 @@ class ListManagedJobTemplatesResponse < Struct.new( include Aws::Structure end + # @note When making an API call, you may pass ListMetricValuesRequest + # data as a hash: + # + # { + # thing_name: "DeviceDefenderThingName", # required + # metric_name: "BehaviorMetric", # required + # dimension_name: "DimensionName", + # dimension_value_operator: "IN", # accepts IN, NOT_IN + # start_time: Time.now, # required + # end_time: Time.now, # required + # max_results: 1, + # next_token: "NextToken", + # } + # + # @!attribute [rw] thing_name + # The name of the thing for which security profile metric values are + # returned. + # @return [String] + # + # @!attribute [rw] metric_name + # The name of the security profile metric for which values are + # returned. + # @return [String] + # + # @!attribute [rw] dimension_name + # The dimension name. + # @return [String] + # + # @!attribute [rw] dimension_value_operator + # The dimension value operator. + # @return [String] + # + # @!attribute [rw] start_time + # The start of the time period for which metric values are returned. + # @return [Time] + # + # @!attribute [rw] end_time + # The end of the time period for which metric values are returned. + # @return [Time] + # + # @!attribute [rw] max_results + # The maximum number of results to return at one time. + # @return [Integer] + # + # @!attribute [rw] next_token + # The token for the next set of results. + # @return [String] + # + class ListMetricValuesRequest < Struct.new( + :thing_name, + :metric_name, + :dimension_name, + :dimension_value_operator, + :start_time, + :end_time, + :max_results, + :next_token) + SENSITIVE = [] + include Aws::Structure + end + + # @!attribute [rw] metric_datum_list + # The data the thing reports for the metric during the specified time + # period. + # @return [Array