From 476009e798c611f306a9f0d6fe3e4bc08fbece07 Mon Sep 17 00:00:00 2001 From: aws-sdk-go-automation <43143561+aws-sdk-go-automation@users.noreply.github.com> Date: Wed, 27 Apr 2022 11:22:17 -0700 Subject: [PATCH] Release v1.44.2 (2022-04-27) (#4377) Release v1.44.2 (2022-04-27) === ### Service Client Updates * `service/amplify`: Updates service documentation * `service/chime-sdk-media-pipelines`: Adds new service * `service/cloudtrail`: Updates service API and documentation * Increases the retention period maximum to 2557 days. Deprecates unused fields of the ListEventDataStores API response. Updates documentation. * `service/iotwireless`: Updates service API, documentation, and paginators * `service/lookoutequipment`: Updates service API, documentation, and paginators * `service/rekognition`: Updates service API and documentation * This release adds support to configure stream-processor resources for label detections on streaming-videos. UpateStreamProcessor API is also launched with this release, which could be used to update an existing stream-processor. * `service/sagemaker`: Updates service API and documentation * Amazon SageMaker Autopilot adds support for custom validation dataset and validation ratio through the CreateAutoMLJob and DescribeAutoMLJob APIs. --- CHANGELOG.md | 15 + aws/version.go | 2 +- models/apis/amplify/2017-07-25/docs-2.json | 10 +- .../2021-07-15/api-2.json | 580 ++++ .../2021-07-15/docs-2.json | 362 +++ .../2021-07-15/examples-1.json | 5 + .../2021-07-15/paginators-1.json | 9 + models/apis/cloudtrail/2013-11-01/api-2.json | 50 +- models/apis/cloudtrail/2013-11-01/docs-2.json | 46 +- models/apis/iotwireless/2020-11-22/api-2.json | 385 ++- .../apis/iotwireless/2020-11-22/docs-2.json | 291 +- .../iotwireless/2020-11-22/paginators-1.json | 5 + .../lookoutequipment/2020-12-15/api-2.json | 251 +- .../lookoutequipment/2020-12-15/docs-2.json | 224 +- .../2020-12-15/paginators-1.json | 5 + models/apis/rekognition/2016-06-27/api-2.json | 153 +- .../apis/rekognition/2016-06-27/docs-2.json | 229 +- models/apis/sagemaker/2017-07-24/api-2.json | 24 +- models/apis/sagemaker/2017-07-24/docs-2.json | 350 ++- service/amplify/api.go | 78 +- service/chimesdkmediapipelines/api.go | 2798 +++++++++++++++++ .../chimesdkmediapipelinesiface/interface.go | 95 + service/chimesdkmediapipelines/doc.go | 31 + service/chimesdkmediapipelines/errors.go | 69 + service/chimesdkmediapipelines/service.go | 105 + service/cloudtrail/api.go | 335 +- service/cloudtrail/errors.go | 26 +- service/iotwireless/api.go | 2381 ++++++++++++-- .../iotwireless/iotwirelessiface/interface.go | 27 + service/lookoutequipment/api.go | 1321 +++++++- .../lookoutequipmentiface/interface.go | 7 + service/rekognition/api.go | 1277 +++++++- service/rekognition/doc.go | 125 +- service/rekognition/errors.go | 6 +- .../rekognition/rekognitioniface/interface.go | 4 + service/sagemaker/api.go | 1264 ++++---- service/sagemaker/doc.go | 4 +- service/sagemaker/errors.go | 4 +- 38 files changed, 11476 insertions(+), 1477 deletions(-) create mode 100644 models/apis/chime-sdk-media-pipelines/2021-07-15/api-2.json create mode 100644 models/apis/chime-sdk-media-pipelines/2021-07-15/docs-2.json create mode 100644 models/apis/chime-sdk-media-pipelines/2021-07-15/examples-1.json create mode 100644 models/apis/chime-sdk-media-pipelines/2021-07-15/paginators-1.json create mode 100644 service/chimesdkmediapipelines/api.go create mode 100644 service/chimesdkmediapipelines/chimesdkmediapipelinesiface/interface.go create mode 100644 service/chimesdkmediapipelines/doc.go create mode 100644 service/chimesdkmediapipelines/errors.go create mode 100644 service/chimesdkmediapipelines/service.go diff --git a/CHANGELOG.md b/CHANGELOG.md index d853f4ea73f..962ccb44b8e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,18 @@ +Release v1.44.2 (2022-04-27) +=== + +### Service Client Updates +* `service/amplify`: Updates service documentation +* `service/chime-sdk-media-pipelines`: Adds new service +* `service/cloudtrail`: Updates service API and documentation + * Increases the retention period maximum to 2557 days. Deprecates unused fields of the ListEventDataStores API response. Updates documentation. +* `service/iotwireless`: Updates service API, documentation, and paginators +* `service/lookoutequipment`: Updates service API, documentation, and paginators +* `service/rekognition`: Updates service API and documentation + * This release adds support to configure stream-processor resources for label detections on streaming-videos. UpateStreamProcessor API is also launched with this release, which could be used to update an existing stream-processor. +* `service/sagemaker`: Updates service API and documentation + * Amazon SageMaker Autopilot adds support for custom validation dataset and validation ratio through the CreateAutoMLJob and DescribeAutoMLJob APIs. + Release v1.44.1 (2022-04-26) === diff --git a/aws/version.go b/aws/version.go index 314db8dfa6b..ff51c385b19 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.44.1" +const SDKVersion = "1.44.2" diff --git a/models/apis/amplify/2017-07-25/docs-2.json b/models/apis/amplify/2017-07-25/docs-2.json index acecac0f7ec..792097dd087 100644 --- a/models/apis/amplify/2017-07-25/docs-2.json +++ b/models/apis/amplify/2017-07-25/docs-2.json @@ -44,8 +44,8 @@ "AccessToken": { "base": null, "refs": { - "CreateAppRequest$accessToken": "

The personal access token for a third-party source control system for an Amplify app. The personal access token is used to create a webhook and a read-only deploy key. The token is not stored.

", - "UpdateAppRequest$accessToken": "

The personal access token for a third-party source control system for an Amplify app. The token is used to create webhook and a read-only deploy key. The token is not stored.

" + "CreateAppRequest$accessToken": "

The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.

You must specify either accessToken or oauthToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

", + "UpdateAppRequest$accessToken": "

The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.

You must specify either accessToken or oauthToken when you update an app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

" } }, "ActiveJobId": { @@ -1062,8 +1062,8 @@ "OauthToken": { "base": null, "refs": { - "CreateAppRequest$oauthToken": "

The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.

", - "UpdateAppRequest$oauthToken": "

The OAuth token for a third-party source control system for an Amplify app. The token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.

" + "CreateAppRequest$oauthToken": "

The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.

Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use accessToken.

You must specify either oauthToken or accessToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

", + "UpdateAppRequest$oauthToken": "

The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.

Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit.

To authorize access to GitHub as your repository provider, use accessToken.

You must specify either oauthToken or accessToken when you update an app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

" } }, "Platform": { @@ -1100,7 +1100,7 @@ "RepositoryCloneMethod": { "base": null, "refs": { - "App$repositoryCloneMethod": "

The authentication protocol to use to access the Git repository for an Amplify app. For a GitHub repository, specify TOKEN. For an Amazon Web Services CodeCommit repository, specify SIGV4. For GitLab and Bitbucket repositories, specify SSH.

" + "App$repositoryCloneMethod": "

This is for internal use.

The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.

" } }, "ResourceArn": { diff --git a/models/apis/chime-sdk-media-pipelines/2021-07-15/api-2.json b/models/apis/chime-sdk-media-pipelines/2021-07-15/api-2.json new file mode 100644 index 00000000000..a6dd207efea --- /dev/null +++ b/models/apis/chime-sdk-media-pipelines/2021-07-15/api-2.json @@ -0,0 +1,580 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-07-15", + "endpointPrefix":"media-pipelines-chime", + "protocol":"rest-json", + "serviceFullName":"Amazon Chime SDK Media Pipelines", + "serviceId":"Chime SDK Media Pipelines", + "signatureVersion":"v4", + "signingName":"chime", + "uid":"chime-sdk-media-pipelines-2021-07-15" + }, + "operations":{ + "CreateMediaCapturePipeline":{ + "name":"CreateMediaCapturePipeline", + "http":{ + "method":"POST", + "requestUri":"/sdk-media-capture-pipelines", + "responseCode":201 + }, + "input":{"shape":"CreateMediaCapturePipelineRequest"}, + "output":{"shape":"CreateMediaCapturePipelineResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ] + }, + "DeleteMediaCapturePipeline":{ + "name":"DeleteMediaCapturePipeline", + "http":{ + "method":"DELETE", + "requestUri":"/sdk-media-capture-pipelines/{mediaPipelineId}", + "responseCode":204 + }, + "input":{"shape":"DeleteMediaCapturePipelineRequest"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ] + }, + "GetMediaCapturePipeline":{ + "name":"GetMediaCapturePipeline", + "http":{ + "method":"GET", + "requestUri":"/sdk-media-capture-pipelines/{mediaPipelineId}", + "responseCode":200 + }, + "input":{"shape":"GetMediaCapturePipelineRequest"}, + "output":{"shape":"GetMediaCapturePipelineResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ListMediaCapturePipelines":{ + "name":"ListMediaCapturePipelines", + "http":{ + "method":"GET", + "requestUri":"/sdk-media-capture-pipelines", + "responseCode":200 + }, + "input":{"shape":"ListMediaCapturePipelinesRequest"}, + "output":{"shape":"ListMediaCapturePipelinesResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ] + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags?operation=tag-resource", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ] + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/tags?operation=untag-resource", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ] + } + }, + "shapes":{ + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"^arn[\\/\\:\\-\\_\\.a-zA-Z0-9]+$" + }, + "Arn":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^arn[\\/\\:\\-\\_\\.a-zA-Z0-9]+$", + "sensitive":true + }, + "ArtifactsConfiguration":{ + "type":"structure", + "required":[ + "Audio", + "Video", + "Content" + ], + "members":{ + "Audio":{"shape":"AudioArtifactsConfiguration"}, + "Video":{"shape":"VideoArtifactsConfiguration"}, + "Content":{"shape":"ContentArtifactsConfiguration"} + } + }, + "ArtifactsState":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "AttendeeIdList":{ + "type":"list", + "member":{"shape":"GuidString"}, + "min":1 + }, + "AudioArtifactsConfiguration":{ + "type":"structure", + "required":["MuxType"], + "members":{ + "MuxType":{"shape":"AudioMuxType"} + } + }, + "AudioMuxType":{ + "type":"string", + "enum":[ + "AudioOnly", + "AudioWithActiveSpeakerVideo" + ] + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{"shape":"String"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "ChimeSdkMeetingConfiguration":{ + "type":"structure", + "members":{ + "SourceConfiguration":{"shape":"SourceConfiguration"}, + "ArtifactsConfiguration":{"shape":"ArtifactsConfiguration"} + } + }, + "ClientRequestToken":{ + "type":"string", + "max":64, + "min":2, + "pattern":"[-_a-zA-Z0-9]*", + "sensitive":true + }, + "ContentArtifactsConfiguration":{ + "type":"structure", + "required":["State"], + "members":{ + "State":{"shape":"ArtifactsState"}, + "MuxType":{"shape":"ContentMuxType"} + } + }, + "ContentMuxType":{ + "type":"string", + "enum":["ContentOnly"] + }, + "CreateMediaCapturePipelineRequest":{ + "type":"structure", + "required":[ + "SourceType", + "SourceArn", + "SinkType", + "SinkArn" + ], + "members":{ + "SourceType":{"shape":"MediaPipelineSourceType"}, + "SourceArn":{"shape":"Arn"}, + "SinkType":{"shape":"MediaPipelineSinkType"}, + "SinkArn":{"shape":"Arn"}, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + }, + "ChimeSdkMeetingConfiguration":{"shape":"ChimeSdkMeetingConfiguration"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateMediaCapturePipelineResponse":{ + "type":"structure", + "members":{ + "MediaCapturePipeline":{"shape":"MediaCapturePipeline"} + } + }, + "DeleteMediaCapturePipelineRequest":{ + "type":"structure", + "required":["MediaPipelineId"], + "members":{ + "MediaPipelineId":{ + "shape":"GuidString", + "location":"uri", + "locationName":"mediaPipelineId" + } + } + }, + "ErrorCode":{ + "type":"string", + "enum":[ + "BadRequest", + "Forbidden", + "NotFound", + "ResourceLimitExceeded", + "ServiceFailure", + "ServiceUnavailable", + "Throttling" + ] + }, + "ExternalUserIdList":{ + "type":"list", + "member":{"shape":"ExternalUserIdType"}, + "min":1 + }, + "ExternalUserIdType":{ + "type":"string", + "max":64, + "min":2, + "sensitive":true + }, + "ForbiddenException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{"shape":"String"} + }, + "error":{"httpStatusCode":403}, + "exception":true + }, + "GetMediaCapturePipelineRequest":{ + "type":"structure", + "required":["MediaPipelineId"], + "members":{ + "MediaPipelineId":{ + "shape":"GuidString", + "location":"uri", + "locationName":"mediaPipelineId" + } + } + }, + "GetMediaCapturePipelineResponse":{ + "type":"structure", + "members":{ + "MediaCapturePipeline":{"shape":"MediaCapturePipeline"} + } + }, + "GuidString":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}" + }, + "Iso8601Timestamp":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "ListMediaCapturePipelinesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"ResultMax", + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListMediaCapturePipelinesResponse":{ + "type":"structure", + "members":{ + "MediaCapturePipelines":{"shape":"MediaCapturePipelineSummaryList"}, + "NextToken":{"shape":"String"} + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "location":"querystring", + "locationName":"arn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{"shape":"TagList"} + } + }, + "MediaCapturePipeline":{ + "type":"structure", + "members":{ + "MediaPipelineId":{"shape":"GuidString"}, + "MediaPipelineArn":{"shape":"AmazonResourceName"}, + "SourceType":{"shape":"MediaPipelineSourceType"}, + "SourceArn":{"shape":"Arn"}, + "Status":{"shape":"MediaPipelineStatus"}, + "SinkType":{"shape":"MediaPipelineSinkType"}, + "SinkArn":{"shape":"Arn"}, + "CreatedTimestamp":{"shape":"Iso8601Timestamp"}, + "UpdatedTimestamp":{"shape":"Iso8601Timestamp"}, + "ChimeSdkMeetingConfiguration":{"shape":"ChimeSdkMeetingConfiguration"} + } + }, + "MediaCapturePipelineSummary":{ + "type":"structure", + "members":{ + "MediaPipelineId":{"shape":"GuidString"}, + "MediaPipelineArn":{"shape":"AmazonResourceName"} + } + }, + "MediaCapturePipelineSummaryList":{ + "type":"list", + "member":{"shape":"MediaCapturePipelineSummary"} + }, + "MediaPipelineSinkType":{ + "type":"string", + "enum":["S3Bucket"] + }, + "MediaPipelineSourceType":{ + "type":"string", + "enum":["ChimeSdkMeeting"] + }, + "MediaPipelineStatus":{ + "type":"string", + "enum":[ + "Initializing", + "InProgress", + "Failed", + "Stopping", + "Stopped" + ] + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{"shape":"String"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "ResourceLimitExceededException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{"shape":"String"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "ResultMax":{ + "type":"integer", + "max":100, + "min":1 + }, + "SelectedVideoStreams":{ + "type":"structure", + "members":{ + "AttendeeIds":{"shape":"AttendeeIdList"}, + "ExternalUserIds":{"shape":"ExternalUserIdList"} + } + }, + "ServiceFailureException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{"shape":"String"} + }, + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{"shape":"String"} + }, + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "SourceConfiguration":{ + "type":"structure", + "members":{ + "SelectedVideoStreams":{"shape":"SelectedVideoStreams"} + } + }, + "String":{ + "type":"string", + "max":4096, + "pattern":".*" + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{"shape":"TagKey"}, + "Value":{"shape":"TagValue"} + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{"shape":"AmazonResourceName"}, + "Tags":{"shape":"TagList"} + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "ThrottledClientException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{"shape":"String"} + }, + "error":{"httpStatusCode":429}, + "exception":true + }, + "UnauthorizedClientException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"}, + "RequestId":{"shape":"String"} + }, + "error":{"httpStatusCode":401}, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{"shape":"AmazonResourceName"}, + "TagKeys":{"shape":"TagKeyList"} + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "VideoArtifactsConfiguration":{ + "type":"structure", + "required":["State"], + "members":{ + "State":{"shape":"ArtifactsState"}, + "MuxType":{"shape":"VideoMuxType"} + } + }, + "VideoMuxType":{ + "type":"string", + "enum":["VideoOnly"] + } + } +} diff --git a/models/apis/chime-sdk-media-pipelines/2021-07-15/docs-2.json b/models/apis/chime-sdk-media-pipelines/2021-07-15/docs-2.json new file mode 100644 index 00000000000..90332c9f1bb --- /dev/null +++ b/models/apis/chime-sdk-media-pipelines/2021-07-15/docs-2.json @@ -0,0 +1,362 @@ +{ + "version": "2.0", + "service": "

The Amazon Chime SDK media pipeline APIs in this section allow software developers to create Amazon Chime SDK media pipelines and capture audio, video, events, and data messages from Amazon Chime SDK meetings. For more information about media pipleines, see Amzon Chime SDK media pipelines.

", + "operations": { + "CreateMediaCapturePipeline": "

Creates a media capture pipeline.

", + "DeleteMediaCapturePipeline": "

Deletes the media capture pipeline.

", + "GetMediaCapturePipeline": "

Gets an existing media capture pipeline.

", + "ListMediaCapturePipelines": "

Returns a list of media capture pipelines.

", + "ListTagsForResource": "

Lists the tags applied to an Amazon Chime SDK media capture pipeline.

", + "TagResource": "

Applies the specified tags to the specified Amazon Chime SDK media capture pipeline.

", + "UntagResource": "

Removes the specified tags from the specified Amazon Chime SDK media capture pipeline.

" + }, + "shapes": { + "AmazonResourceName": { + "base": null, + "refs": { + "ListTagsForResourceRequest$ResourceARN": "

The resource ARN.

", + "MediaCapturePipeline$MediaPipelineArn": "

The ARN of a media capture pipeline.

", + "MediaCapturePipelineSummary$MediaPipelineArn": "

The ARN of a media capture pipeline.

", + "TagResourceRequest$ResourceARN": "

The resource ARN.

", + "UntagResourceRequest$ResourceARN": "

The resource ARN.

" + } + }, + "Arn": { + "base": null, + "refs": { + "CreateMediaCapturePipelineRequest$SourceArn": "

ARN of the source from which the media artifacts are captured.

", + "CreateMediaCapturePipelineRequest$SinkArn": "

The ARN of the sink type.

", + "MediaCapturePipeline$SourceArn": "

ARN of the source from which the media artifacts are saved.

", + "MediaCapturePipeline$SinkArn": "

ARN of the destination to which the media artifacts are saved.

" + } + }, + "ArtifactsConfiguration": { + "base": "

The configuration for the artifacts.

", + "refs": { + "ChimeSdkMeetingConfiguration$ArtifactsConfiguration": "

The configuration for the artifacts in an Amazon Chime SDK meeting.

" + } + }, + "ArtifactsState": { + "base": null, + "refs": { + "ContentArtifactsConfiguration$State": "

Indicates whether the content artifact is enabled or disabled.

", + "VideoArtifactsConfiguration$State": "

Indicates whether the video artifact is enabled or disabled.

" + } + }, + "AttendeeIdList": { + "base": null, + "refs": { + "SelectedVideoStreams$AttendeeIds": "

The attendee IDs of the streams selected for a media capture pipeline.

" + } + }, + "AudioArtifactsConfiguration": { + "base": "

The audio artifact configuration object.

", + "refs": { + "ArtifactsConfiguration$Audio": "

The configuration for the audio artifacts.

" + } + }, + "AudioMuxType": { + "base": null, + "refs": { + "AudioArtifactsConfiguration$MuxType": "

The MUX type of the audio artifact configuration object.

" + } + }, + "BadRequestException": { + "base": "

The input parameters don't match the service's restrictions.

", + "refs": { + } + }, + "ChimeSdkMeetingConfiguration": { + "base": "

The configuration object of the Amazon Chime SDK meeting for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

", + "refs": { + "CreateMediaCapturePipelineRequest$ChimeSdkMeetingConfiguration": "

The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

", + "MediaCapturePipeline$ChimeSdkMeetingConfiguration": "

The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.

" + } + }, + "ClientRequestToken": { + "base": null, + "refs": { + "CreateMediaCapturePipelineRequest$ClientRequestToken": "

The token assigned to the client making the pipeline request.

" + } + }, + "ContentArtifactsConfiguration": { + "base": "

The content artifact object.

", + "refs": { + "ArtifactsConfiguration$Content": "

The configuration for the content artifacts.

" + } + }, + "ContentMuxType": { + "base": null, + "refs": { + "ContentArtifactsConfiguration$MuxType": "

The MUX type of the artifact configuration.

" + } + }, + "CreateMediaCapturePipelineRequest": { + "base": null, + "refs": { + } + }, + "CreateMediaCapturePipelineResponse": { + "base": null, + "refs": { + } + }, + "DeleteMediaCapturePipelineRequest": { + "base": null, + "refs": { + } + }, + "ErrorCode": { + "base": null, + "refs": { + "BadRequestException$Code": null, + "ForbiddenException$Code": null, + "NotFoundException$Code": null, + "ResourceLimitExceededException$Code": null, + "ServiceFailureException$Code": null, + "ServiceUnavailableException$Code": null, + "ThrottledClientException$Code": null, + "UnauthorizedClientException$Code": null + } + }, + "ExternalUserIdList": { + "base": null, + "refs": { + "SelectedVideoStreams$ExternalUserIds": "

The external user IDs of the streams selected for a media capture pipeline.

" + } + }, + "ExternalUserIdType": { + "base": null, + "refs": { + "ExternalUserIdList$member": null + } + }, + "ForbiddenException": { + "base": "

The client is permanently forbidden from making the request.

", + "refs": { + } + }, + "GetMediaCapturePipelineRequest": { + "base": null, + "refs": { + } + }, + "GetMediaCapturePipelineResponse": { + "base": null, + "refs": { + } + }, + "GuidString": { + "base": null, + "refs": { + "AttendeeIdList$member": null, + "DeleteMediaCapturePipelineRequest$MediaPipelineId": "

The ID of the media capture pipeline being deleted.

", + "GetMediaCapturePipelineRequest$MediaPipelineId": "

The ID of the pipeline that you want to get.

", + "MediaCapturePipeline$MediaPipelineId": "

The ID of a media capture pipeline.

", + "MediaCapturePipelineSummary$MediaPipelineId": "

The ID of a media capture pipeline.

" + } + }, + "Iso8601Timestamp": { + "base": null, + "refs": { + "MediaCapturePipeline$CreatedTimestamp": "

The time at which the capture pipeline was created, in ISO 8601 format.

", + "MediaCapturePipeline$UpdatedTimestamp": "

The time at which the capture pipeline was updated, in ISO 8601 format.

" + } + }, + "ListMediaCapturePipelinesRequest": { + "base": null, + "refs": { + } + }, + "ListMediaCapturePipelinesResponse": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { + } + }, + "MediaCapturePipeline": { + "base": "

A media capture pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.

", + "refs": { + "CreateMediaCapturePipelineResponse$MediaCapturePipeline": "

A media capture pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media capture pipeline object.

", + "GetMediaCapturePipelineResponse$MediaCapturePipeline": "

The media capture pipeline object.

" + } + }, + "MediaCapturePipelineSummary": { + "base": "

A summary of a media capture pipeline.

", + "refs": { + "MediaCapturePipelineSummaryList$member": null + } + }, + "MediaCapturePipelineSummaryList": { + "base": null, + "refs": { + "ListMediaCapturePipelinesResponse$MediaCapturePipelines": "

The media capture pipeline objects in the list.

" + } + }, + "MediaPipelineSinkType": { + "base": null, + "refs": { + "CreateMediaCapturePipelineRequest$SinkType": "

Destination type to which the media artifacts are saved. You must use an S3 bucket.

", + "MediaCapturePipeline$SinkType": "

Destination type to which the media artifacts are saved. You must use an S3 Bucket.

" + } + }, + "MediaPipelineSourceType": { + "base": null, + "refs": { + "CreateMediaCapturePipelineRequest$SourceType": "

Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.

", + "MediaCapturePipeline$SourceType": "

Source type from which media artifacts are saved. You must use ChimeMeeting.

" + } + }, + "MediaPipelineStatus": { + "base": null, + "refs": { + "MediaCapturePipeline$Status": "

The status of the media capture pipeline.

" + } + }, + "NotFoundException": { + "base": "

One or more of the resources in the request does not exist in the system.

", + "refs": { + } + }, + "ResourceLimitExceededException": { + "base": "

The request exceeds the resource limit.

", + "refs": { + } + }, + "ResultMax": { + "base": null, + "refs": { + "ListMediaCapturePipelinesRequest$MaxResults": "

The maximum number of results to return in a single call. Valid Range: 1 - 99.

" + } + }, + "SelectedVideoStreams": { + "base": "

The video streams to capture for a specified media capture pipeline. The total number of video streams can't exceed 25.

", + "refs": { + "SourceConfiguration$SelectedVideoStreams": "

The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.

" + } + }, + "ServiceFailureException": { + "base": "

The service encountered an unexpected error.

", + "refs": { + } + }, + "ServiceUnavailableException": { + "base": "

The service is currently unavailable.

", + "refs": { + } + }, + "SourceConfiguration": { + "base": "

Source configuration for a specified media capture pipeline.

", + "refs": { + "ChimeSdkMeetingConfiguration$SourceConfiguration": "

The source configuration for a specified media capture pipline.

" + } + }, + "String": { + "base": null, + "refs": { + "BadRequestException$Message": null, + "BadRequestException$RequestId": "

The request id associated with the call responsible for the exception.

", + "ForbiddenException$Message": null, + "ForbiddenException$RequestId": "

The request id associated with the call responsible for the exception.

", + "ListMediaCapturePipelinesRequest$NextToken": "

The token used to retrieve the next page of results.

", + "ListMediaCapturePipelinesResponse$NextToken": "

The token used to retrieve the next page of results.

", + "NotFoundException$Message": null, + "NotFoundException$RequestId": "

The request id associated with the call responsible for the exception.

", + "ResourceLimitExceededException$Message": null, + "ResourceLimitExceededException$RequestId": "

The request id associated with the call responsible for the exception.

", + "ServiceFailureException$Message": null, + "ServiceFailureException$RequestId": "

The request id associated with the call responsible for the exception.

", + "ServiceUnavailableException$Message": null, + "ServiceUnavailableException$RequestId": "

The request id associated with the call responsible for the exception.

", + "ThrottledClientException$Message": null, + "ThrottledClientException$RequestId": "

The request id associated with the call responsible for the exception.

", + "UnauthorizedClientException$Message": null, + "UnauthorizedClientException$RequestId": "

The request id associated with the call responsible for the exception.

" + } + }, + "Tag": { + "base": "

Describes a tag applied to a resource.

", + "refs": { + "TagList$member": null + } + }, + "TagKey": { + "base": null, + "refs": { + "Tag$Key": "

The key of the tag.

", + "TagKeyList$member": null + } + }, + "TagKeyList": { + "base": null, + "refs": { + "UntagResourceRequest$TagKeys": "

The tag keys.

" + } + }, + "TagList": { + "base": null, + "refs": { + "CreateMediaCapturePipelineRequest$Tags": "

The list of tags.

", + "ListTagsForResourceResponse$Tags": "

The tag key-value pairs.

", + "TagResourceRequest$Tags": "

The tag key-value pairs.

" + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResponse": { + "base": null, + "refs": { + } + }, + "TagValue": { + "base": null, + "refs": { + "Tag$Value": "

The value of the tag.

" + } + }, + "ThrottledClientException": { + "base": "

The client exceeded its request rate limit.

", + "refs": { + } + }, + "UnauthorizedClientException": { + "base": "

The client is not currently authorized to make the request.

", + "refs": { + } + }, + "UntagResourceRequest": { + "base": null, + "refs": { + } + }, + "UntagResourceResponse": { + "base": null, + "refs": { + } + }, + "VideoArtifactsConfiguration": { + "base": "

The video artifact configuration object.

", + "refs": { + "ArtifactsConfiguration$Video": "

The configuration for the video artifacts.

" + } + }, + "VideoMuxType": { + "base": null, + "refs": { + "VideoArtifactsConfiguration$MuxType": "

The MUX type of the video artifact configuration object.

" + } + } + } +} diff --git a/models/apis/chime-sdk-media-pipelines/2021-07-15/examples-1.json b/models/apis/chime-sdk-media-pipelines/2021-07-15/examples-1.json new file mode 100644 index 00000000000..0ea7e3b0bbe --- /dev/null +++ b/models/apis/chime-sdk-media-pipelines/2021-07-15/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/models/apis/chime-sdk-media-pipelines/2021-07-15/paginators-1.json b/models/apis/chime-sdk-media-pipelines/2021-07-15/paginators-1.json new file mode 100644 index 00000000000..c49071c3fe0 --- /dev/null +++ b/models/apis/chime-sdk-media-pipelines/2021-07-15/paginators-1.json @@ -0,0 +1,9 @@ +{ + "pagination": { + "ListMediaCapturePipelines": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/models/apis/cloudtrail/2013-11-01/api-2.json b/models/apis/cloudtrail/2013-11-01/api-2.json index 2e15a145a20..5e56b1d337c 100644 --- a/models/apis/cloudtrail/2013-11-01/api-2.json +++ b/models/apis/cloudtrail/2013-11-01/api-2.json @@ -890,14 +890,46 @@ "members":{ "EventDataStoreArn":{"shape":"EventDataStoreArn"}, "Name":{"shape":"EventDataStoreName"}, - "TerminationProtectionEnabled":{"shape":"TerminationProtectionEnabled"}, - "Status":{"shape":"EventDataStoreStatus"}, - "AdvancedEventSelectors":{"shape":"AdvancedEventSelectors"}, - "MultiRegionEnabled":{"shape":"Boolean"}, - "OrganizationEnabled":{"shape":"Boolean"}, - "RetentionPeriod":{"shape":"RetentionPeriod"}, - "CreatedTimestamp":{"shape":"Date"}, - "UpdatedTimestamp":{"shape":"Date"} + "TerminationProtectionEnabled":{ + "shape":"TerminationProtectionEnabled", + "deprecated":true, + "deprecatedMessage":"TerminationProtectionEnabled is no longer returned by ListEventDataStores" + }, + "Status":{ + "shape":"EventDataStoreStatus", + "deprecated":true, + "deprecatedMessage":"Status is no longer returned by ListEventDataStores" + }, + "AdvancedEventSelectors":{ + "shape":"AdvancedEventSelectors", + "deprecated":true, + "deprecatedMessage":"AdvancedEventSelectors is no longer returned by ListEventDataStores" + }, + "MultiRegionEnabled":{ + "shape":"Boolean", + "deprecated":true, + "deprecatedMessage":"MultiRegionEnabled is no longer returned by ListEventDataStores" + }, + "OrganizationEnabled":{ + "shape":"Boolean", + "deprecated":true, + "deprecatedMessage":"OrganizationEnabled is no longer returned by ListEventDataStores" + }, + "RetentionPeriod":{ + "shape":"RetentionPeriod", + "deprecated":true, + "deprecatedMessage":"RetentionPeriod is no longer returned by ListEventDataStores" + }, + "CreatedTimestamp":{ + "shape":"Date", + "deprecated":true, + "deprecatedMessage":"CreatedTimestamp is no longer returned by ListEventDataStores" + }, + "UpdatedTimestamp":{ + "shape":"Date", + "deprecated":true, + "deprecatedMessage":"UpdatedTimestamp is no longer returned by ListEventDataStores" + } } }, "EventDataStoreARNInvalidException":{ @@ -1707,7 +1739,7 @@ }, "RetentionPeriod":{ "type":"integer", - "max":2555, + "max":2557, "min":7 }, "S3BucketDoesNotExistException":{ diff --git a/models/apis/cloudtrail/2013-11-01/docs-2.json b/models/apis/cloudtrail/2013-11-01/docs-2.json index 6d232a3b0a0..d55d368447d 100644 --- a/models/apis/cloudtrail/2013-11-01/docs-2.json +++ b/models/apis/cloudtrail/2013-11-01/docs-2.json @@ -2,7 +2,7 @@ "version": "2.0", "service": "CloudTrail

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.

As an alternative to the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.

See the CloudTrail User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.

", "operations": { - "AddTags": "

Adds one or more tags to a trail, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all Amazon Web Services Regions only from the Region in which the trail was created (also known as its home region).

", + "AddTags": "

Adds one or more tags to a trail or event data store, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store was created (also known as its home region).

", "CancelQuery": "

Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED, TIMED_OUT, or FINISHED. You must specify an ARN value for EventDataStore. The ID of the query that you want to cancel is also required. When you run CancelQuery, the query status might show as CANCELLED even if the operation is not yet finished.

", "CreateEventDataStore": "

Creates a new event data store.

", "CreateTrail": "

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

", @@ -19,12 +19,12 @@ "ListEventDataStores": "

Returns information about all event data stores in the account, in the current region.

", "ListPublicKeys": "

Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.

CloudTrail uses different private and public key pairs per region. Each digest file is signed with a private key unique to its region. When you validate a digest file from a specific region, you must look in the same region for its corresponding public key.

", "ListQueries": "

Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for EventDataStore. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding StartTime and EndTime parameters, and a QueryStatus value. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

", - "ListTags": "

Lists the tags for the trail in the current region.

", + "ListTags": "

Lists the tags for the trail or event data store in the current region.

", "ListTrails": "

Lists trails that are in the current account.

", "LookupEvents": "

Looks up management events or CloudTrail Insights events that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events:

Lookup supports the following attributes for Insights events:

All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.

The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs.

", "PutEventSelectors": "

Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.

When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

Example

  1. You create an event selector for a trail and specify that you want write-only events.

  2. The EC2 GetConsoleOutput and RunInstances API operations occur in your account.

  3. CloudTrail evaluates whether the events match your event selectors.

  4. The RunInstances is a write-only event and it matches your event selector. The trail logs the event.

  5. The GetConsoleOutput is a read-only event that doesn't match your event selector. The trail doesn't log the event.

The PutEventSelectors operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException exception is thrown.

You can configure up to five event selectors for each trail. For more information, see Logging data and management events for trails and Quotas in CloudTrail in the CloudTrail User Guide.

You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide.

", "PutInsightSelectors": "

Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail. You also use PutInsightSelectors to turn off Insights event logging, by passing an empty list of insight types. The valid Insights event types in this release are ApiErrorRateInsight and ApiCallRateInsight.

", - "RemoveTags": "

Removes the specified tags from a trail.

", + "RemoveTags": "

Removes the specified tags from a trail or event data store.

", "RestoreEventDataStore": "

Restores a deleted event data store specified by EventDataStore, which accepts an event data store ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring an event data store can take several minutes, depending on the size of the event data store.

", "StartLogging": "

Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

", "StartQuery": "

Starts a CloudTrail Lake query. The required QueryStatement parameter provides your SQL query, enclosed in single quotation marks.

", @@ -34,7 +34,7 @@ }, "shapes": { "AddTagsRequest": { - "base": "

Specifies the tags to add to a trail.

", + "base": "

Specifies the tags to add to a trail or event data store.

", "refs": { } }, @@ -54,7 +54,7 @@ "refs": { "CreateEventDataStoreRequest$AdvancedEventSelectors": "

The advanced event selectors to use to select the events for the data store. For more information about how to use advanced event selectors, see Log events by using advanced event selectors in the CloudTrail User Guide.

", "CreateEventDataStoreResponse$AdvancedEventSelectors": "

The advanced event selectors that were used to select the events for the data store.

", - "EventDataStore$AdvancedEventSelectors": "

The advanced event selectors that were used to select events for the data store.

", + "EventDataStore$AdvancedEventSelectors": "

This field is being deprecated. The advanced event selectors that were used to select events for the data store.

", "GetEventDataStoreResponse$AdvancedEventSelectors": "

The advanced event selectors used to select events for the data store.

", "GetEventSelectorsResponse$AdvancedEventSelectors": "

The advanced event selectors that are configured for the trail.

", "PutEventSelectorsRequest$AdvancedEventSelectors": "

Specifies the settings for advanced event selectors. You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide.

", @@ -92,8 +92,8 @@ "CreateTrailResponse$LogFileValidationEnabled": "

Specifies whether log file integrity validation is enabled.

", "CreateTrailResponse$IsOrganizationTrail": "

Specifies whether the trail is an organization trail.

", "DescribeTrailsRequest$includeShadowTrails": "

Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and region replication trails will not be returned. The default is true.

", - "EventDataStore$MultiRegionEnabled": "

Indicates whether the event data store includes events from all regions, or only from the region in which it was created.

", - "EventDataStore$OrganizationEnabled": "

Indicates that an event data store is collecting logged events for an organization.

", + "EventDataStore$MultiRegionEnabled": "

This field is being deprecated. Indicates whether the event data store includes events from all regions, or only from the region in which it was created.

", + "EventDataStore$OrganizationEnabled": "

This field is being deprecated. Indicates that an event data store is collecting logged events for an organization.

", "EventSelector$IncludeManagementEvents": "

Specify if you want your event selector to include management events for your trail.

For more information, see Management Events in the CloudTrail User Guide.

By default, the value is true.

The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same region. For more information about CloudTrail pricing, see CloudTrail Pricing.

", "GetEventDataStoreResponse$MultiRegionEnabled": "

Indicates whether the event data store includes events from all regions, or only from the region in which it was created.

", "GetEventDataStoreResponse$OrganizationEnabled": "

Indicates whether an event data store is collecting logged events for an organization in Organizations.

", @@ -157,7 +157,7 @@ } }, "ConflictException": { - "base": "

This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a trail before CloudTrail has time to fully load the trail. If this exception occurs, wait a few minutes, and then try the operation again.

", + "base": "

This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource. If this exception occurs, wait a few minutes, and then try the operation again.

", "refs": { } }, @@ -205,8 +205,8 @@ "CreateEventDataStoreResponse$CreatedTimestamp": "

The timestamp that shows when the event data store was created.

", "CreateEventDataStoreResponse$UpdatedTimestamp": "

The timestamp that shows when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

", "Event$EventTime": "

The date and time of the event returned.

", - "EventDataStore$CreatedTimestamp": "

The timestamp of the event data store's creation.

", - "EventDataStore$UpdatedTimestamp": "

The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

", + "EventDataStore$CreatedTimestamp": "

This field is being deprecated. The timestamp of the event data store's creation.

", + "EventDataStore$UpdatedTimestamp": "

This field is being deprecated. The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

", "GetEventDataStoreResponse$CreatedTimestamp": "

The timestamp of the event data store's creation.

", "GetEventDataStoreResponse$UpdatedTimestamp": "

Shows the time that an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

", "GetTrailStatusResponse$LatestDeliveryTime": "

Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.

", @@ -350,7 +350,7 @@ "base": null, "refs": { "CreateEventDataStoreResponse$Status": "

The status of event data store creation.

", - "EventDataStore$Status": "

The status of an event data store. Values are ENABLED and PENDING_DELETION.

", + "EventDataStore$Status": "

This field is being deprecated. The status of an event data store. Values are ENABLED and PENDING_DELETION.

", "GetEventDataStoreResponse$Status": "

The status of an event data store. Values can be ENABLED and PENDING_DELETION.

", "RestoreEventDataStoreResponse$Status": "

The status of the event data store.

", "UpdateEventDataStoreResponse$Status": "

The status of an event data store. Values can be ENABLED and PENDING_DELETION.

" @@ -454,7 +454,7 @@ } }, "InactiveEventDataStoreException": { - "base": "

The event data store against which you ran your query is inactive.

", + "base": "

The event data store is inactive.

", "refs": { } }, @@ -489,7 +489,7 @@ } }, "InsufficientDependencyServiceAccessPermissionException": { - "base": "

This exception is thrown when the IAM user or role that is used to create the organization trail is lacking one or more required permissions for creating an organization trail in a required service. For more information, see Prepare For Creating a Trail For Your Organization.

", + "base": "

This exception is thrown when the IAM user or role that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.

", "refs": { } }, @@ -527,7 +527,7 @@ } }, "InvalidDateRangeException": { - "base": "

A date range for the query was specified that is not valid. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide.

", + "base": "

A date range for the query was specified that is not valid. Be sure that the start time is chronologically before the end time. For more information about writing a query, see Create or edit a query in the CloudTrail User Guide.

", "refs": { } }, @@ -689,7 +689,7 @@ } }, "ListTagsRequest": { - "base": "

Specifies a list of trail tags to return.

", + "base": "

Specifies a list of tags to return.

", "refs": { } }, @@ -775,7 +775,7 @@ } }, "NotOrganizationMasterAccountException": { - "base": "

This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization.

", + "base": "

This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.

", "refs": { } }, @@ -802,7 +802,7 @@ } }, "OrganizationNotInAllFeaturesModeException": { - "base": "

This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail. For more information, see Prepare For Creating a Trail For Your Organization.

", + "base": "

This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.

", "refs": { } }, @@ -937,7 +937,7 @@ } }, "RemoveTagsRequest": { - "base": "

Specifies the tags to remove from a trail.

", + "base": "

Specifies the tags to remove from a trail or event data store.

", "refs": { } }, @@ -955,7 +955,7 @@ "ResourceIdList": { "base": null, "refs": { - "ListTagsRequest$ResourceIdList": "

Specifies a list of trail ARNs whose tags will be listed. The list has a limit of 20 ARNs. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" + "ListTagsRequest$ResourceIdList": "

Specifies a list of trail and event data store ARNs whose tags will be listed. The list has a limit of 20 ARNs.

" } }, "ResourceList": { @@ -1001,7 +1001,7 @@ "refs": { "CreateEventDataStoreRequest$RetentionPeriod": "

The retention period of the event data store, in days. You can set a retention period of up to 2555 days, the equivalent of seven years.

", "CreateEventDataStoreResponse$RetentionPeriod": "

The retention period of an event data store, in days.

", - "EventDataStore$RetentionPeriod": "

The retention period, in days.

", + "EventDataStore$RetentionPeriod": "

This field is being deprecated. The retention period, in days.

", "GetEventDataStoreResponse$RetentionPeriod": "

The retention period of the event data store, in days.

", "RestoreEventDataStoreResponse$RetentionPeriod": "

The retention period, in days.

", "UpdateEventDataStoreRequest$RetentionPeriod": "

The retention period, in days.

", @@ -1058,7 +1058,7 @@ "String": { "base": null, "refs": { - "AddTagsRequest$ResourceId": "

Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

", + "AddTagsRequest$ResourceId": "

Specifies the ARN of the trail or event data store to which one or more tags will be added. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

", "CreateTrailRequest$Name": "

Specifies the name of the trail. The name must meet the following requirements:

", "CreateTrailRequest$S3BucketName": "

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

", "CreateTrailRequest$S3KeyPrefix": "

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

", @@ -1114,7 +1114,7 @@ "PutEventSelectorsResponse$TrailARN": "

Specifies the ARN of the trail that was updated with event selectors. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

", "PutInsightSelectorsRequest$TrailName": "

The name of the CloudTrail trail for which you want to change or add Insights selectors.

", "PutInsightSelectorsResponse$TrailARN": "

The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights selectors.

", - "RemoveTagsRequest$ResourceId": "

Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

", + "RemoveTagsRequest$ResourceId": "

Specifies the ARN of the trail or event data store from which tags should be removed.

Example trail ARN format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Example event data store ARN format: arn:aws:cloudtrail:us-east-2:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

", "Resource$ResourceType": "

The type of a resource referenced by the event returned. When the resource type cannot be determined, null is returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail, DBInstance for Amazon RDS, and AccessKey for IAM. To learn more about how to look up and filter events by the resource types supported for a service, see Filtering CloudTrail Events.

", "Resource$ResourceName": "

The name of the resource referenced by the event returned. These are user-created names whose values will depend on the environment. For example, the resource name might be \"auto-scaling-test-group\" for an Auto Scaling Group or \"i-1234567\" for an EC2 Instance.

", "ResourceIdList$member": null, @@ -1192,7 +1192,7 @@ "refs": { "CreateEventDataStoreRequest$TerminationProtectionEnabled": "

Specifies whether termination protection is enabled for the event data store. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.

", "CreateEventDataStoreResponse$TerminationProtectionEnabled": "

Indicates whether termination protection is enabled for the event data store.

", - "EventDataStore$TerminationProtectionEnabled": "

Indicates whether the event data store is protected from termination.

", + "EventDataStore$TerminationProtectionEnabled": "

This field is being deprecated. Indicates whether the event data store is protected from termination.

", "GetEventDataStoreResponse$TerminationProtectionEnabled": "

Indicates that termination protection is enabled.

", "RestoreEventDataStoreResponse$TerminationProtectionEnabled": "

Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

", "UpdateEventDataStoreRequest$TerminationProtectionEnabled": "

Indicates that termination protection is enabled and the event data store cannot be automatically deleted.

", diff --git a/models/apis/iotwireless/2020-11-22/api-2.json b/models/apis/iotwireless/2020-11-22/api-2.json index bca3c0a61e1..db6c93169e6 100644 --- a/models/apis/iotwireless/2020-11-22/api-2.json +++ b/models/apis/iotwireless/2020-11-22/api-2.json @@ -224,6 +224,24 @@ {"shape":"ThrottlingException"} ] }, + "CreateNetworkAnalyzerConfiguration":{ + "name":"CreateNetworkAnalyzerConfiguration", + "http":{ + "method":"POST", + "requestUri":"/network-analyzer-configurations", + "responseCode":201 + }, + "input":{"shape":"CreateNetworkAnalyzerConfigurationRequest"}, + "output":{"shape":"CreateNetworkAnalyzerConfigurationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ] + }, "CreateServiceProfile":{ "name":"CreateServiceProfile", "http":{ @@ -383,6 +401,24 @@ {"shape":"ThrottlingException"} ] }, + "DeleteNetworkAnalyzerConfiguration":{ + "name":"DeleteNetworkAnalyzerConfiguration", + "http":{ + "method":"DELETE", + "requestUri":"/network-analyzer-configurations/{ConfigurationName}", + "responseCode":204 + }, + "input":{"shape":"DeleteNetworkAnalyzerConfigurationRequest"}, + "output":{"shape":"DeleteNetworkAnalyzerConfigurationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ] + }, "DeleteQueuedMessages":{ "name":"DeleteQueuedMessages", "http":{ @@ -639,6 +675,20 @@ {"shape":"ThrottlingException"} ] }, + "GetEventConfigurationByResourceTypes":{ + "name":"GetEventConfigurationByResourceTypes", + "http":{ + "method":"GET", + "requestUri":"/event-configurations-resource-types" + }, + "input":{"shape":"GetEventConfigurationByResourceTypesRequest"}, + "output":{"shape":"GetEventConfigurationByResourceTypesResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "GetFuotaTask":{ "name":"GetFuotaTask", "http":{ @@ -960,6 +1010,21 @@ {"shape":"ThrottlingException"} ] }, + "ListEventConfigurations":{ + "name":"ListEventConfigurations", + "http":{ + "method":"GET", + "requestUri":"/event-configurations" + }, + "input":{"shape":"ListEventConfigurationsRequest"}, + "output":{"shape":"ListEventConfigurationsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "ListFuotaTasks":{ "name":"ListFuotaTasks", "http":{ @@ -1006,6 +1071,21 @@ {"shape":"ThrottlingException"} ] }, + "ListNetworkAnalyzerConfigurations":{ + "name":"ListNetworkAnalyzerConfigurations", + "http":{ + "method":"GET", + "requestUri":"/network-analyzer-configurations" + }, + "input":{"shape":"ListNetworkAnalyzerConfigurationsRequest"}, + "output":{"shape":"ListNetworkAnalyzerConfigurationsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ] + }, "ListPartnerAccounts":{ "name":"ListPartnerAccounts", "http":{ @@ -1336,6 +1416,22 @@ {"shape":"ThrottlingException"} ] }, + "UpdateEventConfigurationByResourceTypes":{ + "name":"UpdateEventConfigurationByResourceTypes", + "http":{ + "method":"PATCH", + "requestUri":"/event-configurations-resource-types", + "responseCode":204 + }, + "input":{"shape":"UpdateEventConfigurationByResourceTypesRequest"}, + "output":{"shape":"UpdateEventConfigurationByResourceTypesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "UpdateFuotaTask":{ "name":"UpdateFuotaTask", "http":{ @@ -1481,14 +1577,16 @@ "type":"structure", "members":{ "DevAddr":{"shape":"DevAddr"}, - "SessionKeys":{"shape":"SessionKeysAbpV1_0_x"} + "SessionKeys":{"shape":"SessionKeysAbpV1_0_x"}, + "FCntStart":{"shape":"FCntStart"} } }, "AbpV1_1":{ "type":"structure", "members":{ "DevAddr":{"shape":"DevAddr"}, - "SessionKeys":{"shape":"SessionKeysAbpV1_1"} + "SessionKeys":{"shape":"SessionKeysAbpV1_1"}, + "FCntStart":{"shape":"FCntStart"} } }, "AccessDeniedException":{ @@ -1753,6 +1851,19 @@ "Disconnected" ] }, + "ConnectionStatusEventConfiguration":{ + "type":"structure", + "members":{ + "LoRaWAN":{"shape":"LoRaWANConnectionStatusEventNotificationConfigurations"}, + "WirelessGatewayIdEventTopic":{"shape":"EventNotificationTopicStatus"} + } + }, + "ConnectionStatusResourceTypeEventConfiguration":{ + "type":"structure", + "members":{ + "LoRaWAN":{"shape":"LoRaWANConnectionStatusResourceTypeEventConfiguration"} + } + }, "Crc":{ "type":"long", "max":4294967295, @@ -1852,6 +1963,29 @@ "Id":{"shape":"MulticastGroupId"} } }, + "CreateNetworkAnalyzerConfigurationRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"NetworkAnalyzerConfigurationName"}, + "TraceContent":{"shape":"TraceContent"}, + "WirelessDevices":{"shape":"WirelessDeviceList"}, + "WirelessGateways":{"shape":"WirelessGatewayList"}, + "Description":{"shape":"Description"}, + "Tags":{"shape":"TagList"}, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + } + } + }, + "CreateNetworkAnalyzerConfigurationResponse":{ + "type":"structure", + "members":{ + "Arn":{"shape":"NetworkAnalyzerConfigurationArn"}, + "Name":{"shape":"NetworkAnalyzerConfigurationName"} + } + }, "CreateServiceProfileRequest":{ "type":"structure", "members":{ @@ -2026,6 +2160,22 @@ "members":{ } }, + "DeleteNetworkAnalyzerConfigurationRequest":{ + "type":"structure", + "required":["ConfigurationName"], + "members":{ + "ConfigurationName":{ + "shape":"NetworkAnalyzerConfigurationName", + "location":"uri", + "locationName":"ConfigurationName" + } + } + }, + "DeleteNetworkAnalyzerConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteQueuedMessagesRequest":{ "type":"structure", "required":[ @@ -2201,7 +2351,14 @@ "DeviceRegistrationStateEventConfiguration":{ "type":"structure", "members":{ - "Sidewalk":{"shape":"SidewalkEventNotificationConfigurations"} + "Sidewalk":{"shape":"SidewalkEventNotificationConfigurations"}, + "WirelessDeviceIdEventTopic":{"shape":"EventNotificationTopicStatus"} + } + }, + "DeviceRegistrationStateResourceTypeEventConfiguration":{ + "type":"structure", + "members":{ + "Sidewalk":{"shape":"SidewalkResourceTypeEventConfiguration"} } }, "DeviceState":{ @@ -2428,10 +2585,40 @@ "passthrough" ] }, + "EventConfigurationItem":{ + "type":"structure", + "members":{ + "Identifier":{"shape":"Identifier"}, + "IdentifierType":{"shape":"IdentifierType"}, + "PartnerType":{"shape":"EventNotificationPartnerType"}, + "Events":{"shape":"EventNotificationItemConfigurations"} + } + }, + "EventConfigurationsList":{ + "type":"list", + "member":{"shape":"EventConfigurationItem"} + }, + "EventNotificationItemConfigurations":{ + "type":"structure", + "members":{ + "DeviceRegistrationState":{"shape":"DeviceRegistrationStateEventConfiguration"}, + "Proximity":{"shape":"ProximityEventConfiguration"}, + "Join":{"shape":"JoinEventConfiguration"}, + "ConnectionStatus":{"shape":"ConnectionStatusEventConfiguration"} + } + }, "EventNotificationPartnerType":{ "type":"string", "enum":["Sidewalk"] }, + "EventNotificationResourceType":{ + "type":"string", + "enum":[ + "SidewalkAccount", + "WirelessDevice", + "WirelessGateway" + ] + }, "EventNotificationTopicStatus":{ "type":"string", "enum":[ @@ -2450,6 +2637,11 @@ "MqttTopic" ] }, + "FCntStart":{ + "type":"integer", + "max":65535, + "min":0 + }, "FNwkSIntKey":{ "type":"string", "pattern":"[a-fA-F0-9]{32}" @@ -2590,6 +2782,20 @@ "LoRaWAN":{"shape":"LoRaWANDeviceProfile"} } }, + "GetEventConfigurationByResourceTypesRequest":{ + "type":"structure", + "members":{ + } + }, + "GetEventConfigurationByResourceTypesResponse":{ + "type":"structure", + "members":{ + "DeviceRegistrationState":{"shape":"DeviceRegistrationStateResourceTypeEventConfiguration"}, + "Proximity":{"shape":"ProximityResourceTypeEventConfiguration"}, + "Join":{"shape":"JoinResourceTypeEventConfiguration"}, + "ConnectionStatus":{"shape":"ConnectionStatusResourceTypeEventConfiguration"} + } + }, "GetFuotaTaskRequest":{ "type":"structure", "required":["Id"], @@ -2684,7 +2890,10 @@ "members":{ "TraceContent":{"shape":"TraceContent"}, "WirelessDevices":{"shape":"WirelessDeviceList"}, - "WirelessGateways":{"shape":"WirelessGatewayList"} + "WirelessGateways":{"shape":"WirelessGatewayList"}, + "Description":{"shape":"Description"}, + "Arn":{"shape":"NetworkAnalyzerConfigurationArn"}, + "Name":{"shape":"NetworkAnalyzerConfigurationName"} } }, "GetPartnerAccountRequest":{ @@ -2741,7 +2950,9 @@ "type":"structure", "members":{ "DeviceRegistrationState":{"shape":"DeviceRegistrationStateEventConfiguration"}, - "Proximity":{"shape":"ProximityEventConfiguration"} + "Proximity":{"shape":"ProximityEventConfiguration"}, + "Join":{"shape":"JoinEventConfiguration"}, + "ConnectionStatus":{"shape":"ConnectionStatusEventConfiguration"} } }, "GetResourceLogLevelRequest":{ @@ -2998,7 +3209,13 @@ }, "IdentifierType":{ "type":"string", - "enum":["PartnerAccountId"] + "enum":[ + "PartnerAccountId", + "DevEui", + "GatewayEui", + "WirelessDeviceId", + "WirelessGatewayId" + ] }, "Integer":{"type":"integer"}, "InternalServerException":{ @@ -3030,6 +3247,19 @@ "max":2, "min":2 }, + "JoinEventConfiguration":{ + "type":"structure", + "members":{ + "LoRaWAN":{"shape":"LoRaWANJoinEventNotificationConfigurations"}, + "WirelessDeviceIdEventTopic":{"shape":"EventNotificationTopicStatus"} + } + }, + "JoinResourceTypeEventConfiguration":{ + "type":"structure", + "members":{ + "LoRaWAN":{"shape":"LoRaWANJoinResourceTypeEventConfiguration"} + } + }, "ListDestinationsRequest":{ "type":"structure", "members":{ @@ -3074,6 +3304,34 @@ "DeviceProfileList":{"shape":"DeviceProfileList"} } }, + "ListEventConfigurationsRequest":{ + "type":"structure", + "required":["ResourceType"], + "members":{ + "ResourceType":{ + "shape":"EventNotificationResourceType", + "location":"querystring", + "locationName":"resourceType" + }, + "MaxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListEventConfigurationsResponse":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"NextToken"}, + "EventConfigurationsList":{"shape":"EventConfigurationsList"} + } + }, "ListFuotaTasksRequest":{ "type":"structure", "members":{ @@ -3146,6 +3404,28 @@ "MulticastGroupList":{"shape":"MulticastGroupList"} } }, + "ListNetworkAnalyzerConfigurationsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListNetworkAnalyzerConfigurationsResponse":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"NextToken"}, + "NetworkAnalyzerConfigurationList":{"shape":"NetworkAnalyzerConfigurationList"} + } + }, "ListPartnerAccountsRequest":{ "type":"structure", "members":{ @@ -3341,6 +3621,18 @@ "WirelessGatewayList":{"shape":"WirelessGatewayStatisticsList"} } }, + "LoRaWANConnectionStatusEventNotificationConfigurations":{ + "type":"structure", + "members":{ + "GatewayEuiEventTopic":{"shape":"EventNotificationTopicStatus"} + } + }, + "LoRaWANConnectionStatusResourceTypeEventConfiguration":{ + "type":"structure", + "members":{ + "WirelessGatewayEventTopic":{"shape":"EventNotificationTopicStatus"} + } + }, "LoRaWANDevice":{ "type":"structure", "members":{ @@ -3462,6 +3754,18 @@ "MinGwDiversity":{"shape":"MinGwDiversity"} } }, + "LoRaWANJoinEventNotificationConfigurations":{ + "type":"structure", + "members":{ + "DevEuiEventTopic":{"shape":"EventNotificationTopicStatus"} + } + }, + "LoRaWANJoinResourceTypeEventConfiguration":{ + "type":"structure", + "members":{ + "WirelessDeviceEventTopic":{"shape":"EventNotificationTopicStatus"} + } + }, "LoRaWANListDevice":{ "type":"structure", "members":{ @@ -3521,7 +3825,9 @@ "type":"structure", "members":{ "DeviceProfileId":{"shape":"DeviceProfileId"}, - "ServiceProfileId":{"shape":"ServiceProfileId"} + "ServiceProfileId":{"shape":"ServiceProfileId"}, + "AbpV1_1":{"shape":"UpdateAbpV1_1"}, + "AbpV1_0_x":{"shape":"UpdateAbpV1_0_x"} } }, "LoRaWANUpdateGatewayTaskCreate":{ @@ -3658,11 +3964,26 @@ "max":10, "min":0 }, + "NetworkAnalyzerConfigurationArn":{ + "type":"string", + "max":1124 + }, + "NetworkAnalyzerConfigurationList":{ + "type":"list", + "member":{"shape":"NetworkAnalyzerConfigurations"} + }, "NetworkAnalyzerConfigurationName":{ "type":"string", "max":1024, "min":1, - "pattern":"NetworkAnalyzerConfig_Default" + "pattern":"[a-zA-Z0-9-_]+" + }, + "NetworkAnalyzerConfigurations":{ + "type":"structure", + "members":{ + "Arn":{"shape":"NetworkAnalyzerConfigurationArn"}, + "Name":{"shape":"NetworkAnalyzerConfigurationName"} + } }, "NextToken":{ "type":"string", @@ -3742,7 +4063,14 @@ "ProximityEventConfiguration":{ "type":"structure", "members":{ - "Sidewalk":{"shape":"SidewalkEventNotificationConfigurations"} + "Sidewalk":{"shape":"SidewalkEventNotificationConfigurations"}, + "WirelessDeviceIdEventTopic":{"shape":"EventNotificationTopicStatus"} + } + }, + "ProximityResourceTypeEventConfiguration":{ + "type":"structure", + "members":{ + "Sidewalk":{"shape":"SidewalkResourceTypeEventConfiguration"} } }, "PutResourceLogLevelRequest":{ @@ -4027,6 +4355,12 @@ "type":"string", "max":64 }, + "SidewalkResourceTypeEventConfiguration":{ + "type":"structure", + "members":{ + "WirelessDeviceEventTopic":{"shape":"EventNotificationTopicStatus"} + } + }, "SidewalkSendDataToDevice":{ "type":"structure", "members":{ @@ -4297,6 +4631,18 @@ "members":{ } }, + "UpdateAbpV1_0_x":{ + "type":"structure", + "members":{ + "FCntStart":{"shape":"FCntStart"} + } + }, + "UpdateAbpV1_1":{ + "type":"structure", + "members":{ + "FCntStart":{"shape":"FCntStart"} + } + }, "UpdateDataSource":{ "type":"string", "max":4096, @@ -4322,6 +4668,20 @@ "members":{ } }, + "UpdateEventConfigurationByResourceTypesRequest":{ + "type":"structure", + "members":{ + "DeviceRegistrationState":{"shape":"DeviceRegistrationStateResourceTypeEventConfiguration"}, + "Proximity":{"shape":"ProximityResourceTypeEventConfiguration"}, + "Join":{"shape":"JoinResourceTypeEventConfiguration"}, + "ConnectionStatus":{"shape":"ConnectionStatusResourceTypeEventConfiguration"} + } + }, + "UpdateEventConfigurationByResourceTypesResponse":{ + "type":"structure", + "members":{ + } + }, "UpdateFuotaTaskRequest":{ "type":"structure", "required":["Id"], @@ -4388,7 +4748,8 @@ "WirelessDevicesToAdd":{"shape":"WirelessDeviceList"}, "WirelessDevicesToRemove":{"shape":"WirelessDeviceList"}, "WirelessGatewaysToAdd":{"shape":"WirelessGatewayList"}, - "WirelessGatewaysToRemove":{"shape":"WirelessGatewayList"} + "WirelessGatewaysToRemove":{"shape":"WirelessGatewayList"}, + "Description":{"shape":"Description"} } }, "UpdateNetworkAnalyzerConfigurationResponse":{ @@ -4445,7 +4806,9 @@ "locationName":"partnerType" }, "DeviceRegistrationState":{"shape":"DeviceRegistrationStateEventConfiguration"}, - "Proximity":{"shape":"ProximityEventConfiguration"} + "Proximity":{"shape":"ProximityEventConfiguration"}, + "Join":{"shape":"JoinEventConfiguration"}, + "ConnectionStatus":{"shape":"ConnectionStatusEventConfiguration"} } }, "UpdateResourceEventConfigurationResponse":{ diff --git a/models/apis/iotwireless/2020-11-22/docs-2.json b/models/apis/iotwireless/2020-11-22/docs-2.json index f4320390225..ff9a03da7a4 100644 --- a/models/apis/iotwireless/2020-11-22/docs-2.json +++ b/models/apis/iotwireless/2020-11-22/docs-2.json @@ -14,6 +14,7 @@ "CreateDeviceProfile": "

Creates a new device profile.

", "CreateFuotaTask": "

Creates a FUOTA task.

", "CreateMulticastGroup": "

Creates a multicast group.

", + "CreateNetworkAnalyzerConfiguration": "

Creates a new network analyzer configuration.

", "CreateServiceProfile": "

Creates a new service profile.

", "CreateWirelessDevice": "

Provisions a wireless device.

", "CreateWirelessGateway": "

Provisions a wireless gateway.

", @@ -23,7 +24,8 @@ "DeleteDeviceProfile": "

Deletes a device profile.

", "DeleteFuotaTask": "

Deletes a FUOTA task.

", "DeleteMulticastGroup": "

Deletes a multicast group if it is not in use by a fuota task.

", - "DeleteQueuedMessages": "

The operation to delete queued messages.

", + "DeleteNetworkAnalyzerConfiguration": "

Deletes a network analyzer configuration.

", + "DeleteQueuedMessages": "

Remove queued messages from the downlink queue.

", "DeleteServiceProfile": "

Deletes a service profile.

", "DeleteWirelessDevice": "

Deletes a wireless device.

", "DeleteWirelessGateway": "

Deletes a wireless gateway.

", @@ -38,11 +40,12 @@ "DisassociateWirelessGatewayFromThing": "

Disassociates a wireless gateway from its currently associated thing.

", "GetDestination": "

Gets information about a destination.

", "GetDeviceProfile": "

Gets information about a device profile.

", + "GetEventConfigurationByResourceTypes": "

Get the event configuration by resource types.

", "GetFuotaTask": "

Gets information about a FUOTA task.

", "GetLogLevelsByResourceTypes": "

Returns current default log levels or log levels by resource types. Based on resource types, log levels can be for wireless device log options or wireless gateway log options.

", "GetMulticastGroup": "

Gets information about a multicast group.

", "GetMulticastGroupSession": "

Gets information about a multicast group session.

", - "GetNetworkAnalyzerConfiguration": "

Get NetworkAnalyzer configuration.

", + "GetNetworkAnalyzerConfiguration": "

Get network analyzer configuration.

", "GetPartnerAccount": "

Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.

", "GetResourceEventConfiguration": "

Get the event configuration for a particular resource identifier.

", "GetResourceLogLevel": "

Fetches the log-level override, if any, for a given resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.

", @@ -58,11 +61,13 @@ "GetWirelessGatewayTaskDefinition": "

Gets information about a wireless gateway task definition.

", "ListDestinations": "

Lists the destinations registered to your AWS account.

", "ListDeviceProfiles": "

Lists the device profiles registered to your AWS account.

", + "ListEventConfigurations": "

List event configurations where at least one event topic has been enabled.

", "ListFuotaTasks": "

Lists the FUOTA tasks registered to your AWS account.

", "ListMulticastGroups": "

Lists the multicast groups registered to your AWS account.

", "ListMulticastGroupsByFuotaTask": "

List all multicast groups associated with a fuota task.

", + "ListNetworkAnalyzerConfigurations": "

Lists the network analyzer configurations.

", "ListPartnerAccounts": "

Lists the partner accounts associated with your AWS account.

", - "ListQueuedMessages": "

The operation to list queued messages.

", + "ListQueuedMessages": "

List queued messages in the downlink queue.

", "ListServiceProfiles": "

Lists the service profiles registered to your AWS account.

", "ListTagsForResource": "

Lists the tags (metadata) you have assigned to the resource.

", "ListWirelessDevices": "

Lists the wireless devices registered to your AWS account.

", @@ -81,10 +86,11 @@ "TestWirelessDevice": "

Simulates a provisioned device by sending an uplink data payload of Hello.

", "UntagResource": "

Removes one or more tags from a resource.

", "UpdateDestination": "

Updates properties of a destination.

", + "UpdateEventConfigurationByResourceTypes": "

Update the event configuration by resource types.

", "UpdateFuotaTask": "

Updates properties of a FUOTA task.

", "UpdateLogLevelsByResourceTypes": "

Set default log level, or log levels by resource types. This can be for wireless device log options or wireless gateways log options and is used to control the log messages that'll be displayed in CloudWatch.

", "UpdateMulticastGroup": "

Updates properties of a multicast group session.

", - "UpdateNetworkAnalyzerConfiguration": "

Update NetworkAnalyzer configuration.

", + "UpdateNetworkAnalyzerConfiguration": "

Update network analyzer configuration.

", "UpdatePartnerAccount": "

Updates properties of a partner account.

", "UpdateResourceEventConfiguration": "

Update the event configuration for a particular resource identifier.

", "UpdateWirelessDevice": "

Updates properties of a wireless device.

", @@ -303,6 +309,7 @@ "CreateDeviceProfileRequest$ClientRequestToken": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", "CreateFuotaTaskRequest$ClientRequestToken": null, "CreateMulticastGroupRequest$ClientRequestToken": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", + "CreateNetworkAnalyzerConfigurationRequest$ClientRequestToken": null, "CreateServiceProfileRequest$ClientRequestToken": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", "CreateWirelessDeviceRequest$ClientRequestToken": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", "CreateWirelessGatewayRequest$ClientRequestToken": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", @@ -320,6 +327,21 @@ "GetWirelessGatewayStatisticsResponse$ConnectionStatus": "

The connection status of the wireless gateway.

" } }, + "ConnectionStatusEventConfiguration": { + "base": "

Connection status event configuration object for enabling or disabling topic.

", + "refs": { + "EventNotificationItemConfigurations$ConnectionStatus": "

Connection status event configuration for an event configuration item.

", + "GetResourceEventConfigurationResponse$ConnectionStatus": "

Event configuration for the connection status event.

", + "UpdateResourceEventConfigurationRequest$ConnectionStatus": "

Event configuration for the connection status event

" + } + }, + "ConnectionStatusResourceTypeEventConfiguration": { + "base": "

Connection status resource type event configuration object for enabling or disabling topic.

", + "refs": { + "GetEventConfigurationByResourceTypesResponse$ConnectionStatus": "

Resource type event configuration for the connection status event

", + "UpdateEventConfigurationByResourceTypesRequest$ConnectionStatus": "

Connection status resource type event configuration object for enabling and disabling wireless gateway topic.

" + } + }, "Crc": { "base": null, "refs": { @@ -366,6 +388,16 @@ "refs": { } }, + "CreateNetworkAnalyzerConfigurationRequest": { + "base": null, + "refs": { + } + }, + "CreateNetworkAnalyzerConfigurationResponse": { + "base": null, + "refs": { + } + }, "CreateServiceProfileRequest": { "base": null, "refs": { @@ -463,6 +495,16 @@ "refs": { } }, + "DeleteNetworkAnalyzerConfigurationRequest": { + "base": null, + "refs": { + } + }, + "DeleteNetworkAnalyzerConfigurationResponse": { + "base": null, + "refs": { + } + }, "DeleteQueuedMessagesRequest": { "base": null, "refs": { @@ -529,17 +571,20 @@ "CreateDestinationRequest$Description": "

The description of the new resource.

", "CreateFuotaTaskRequest$Description": null, "CreateMulticastGroupRequest$Description": "

The description of the multicast group.

", + "CreateNetworkAnalyzerConfigurationRequest$Description": null, "CreateWirelessDeviceRequest$Description": "

The description of the new resource.

", "CreateWirelessGatewayRequest$Description": "

The description of the new resource.

", "Destinations$Description": "

The description of the resource.

", "GetDestinationResponse$Description": "

The description of the resource.

", "GetFuotaTaskResponse$Description": null, "GetMulticastGroupResponse$Description": null, + "GetNetworkAnalyzerConfigurationResponse$Description": null, "GetWirelessDeviceResponse$Description": "

The description of the resource.

", "GetWirelessGatewayResponse$Description": "

The description of the resource.

", "UpdateDestinationRequest$Description": "

A new description of the resource.

", "UpdateFuotaTaskRequest$Description": null, "UpdateMulticastGroupRequest$Description": null, + "UpdateNetworkAnalyzerConfigurationRequest$Description": null, "UpdateWirelessDeviceRequest$Description": "

A new description of the resource.

", "UpdateWirelessGatewayRequest$Description": "

A new description of the resource.

", "WirelessGatewayStatistics$Description": "

The description of the resource.

" @@ -654,10 +699,18 @@ "DeviceRegistrationStateEventConfiguration": { "base": "

Device registration state event configuration object for enabling and disabling relevant topics.

", "refs": { + "EventNotificationItemConfigurations$DeviceRegistrationState": "

Device registration state event configuration for an event configuration item.

", "GetResourceEventConfigurationResponse$DeviceRegistrationState": "

Event configuration for the device registration state event

", "UpdateResourceEventConfigurationRequest$DeviceRegistrationState": "

Event configuration for the device registration state event

" } }, + "DeviceRegistrationStateResourceTypeEventConfiguration": { + "base": "

Device registration state resource type event configuration object for enabling or disabling topic.

", + "refs": { + "GetEventConfigurationByResourceTypesResponse$DeviceRegistrationState": "

Resource type event configuration for the device registration state event

", + "UpdateEventConfigurationByResourceTypesRequest$DeviceRegistrationState": "

Device registration state resource type event configuration object for enabling and disabling wireless gateway topic.

" + } + }, "DeviceState": { "base": "

Device state defines the device status of sidewalk device.

", "refs": { @@ -779,7 +832,7 @@ } }, "DownlinkQueueMessage": { - "base": "

The message in downlink queue.

", + "base": "

The message in the downlink queue.

", "refs": { "DownlinkQueueMessagesList$member": null } @@ -787,7 +840,7 @@ "DownlinkQueueMessagesList": { "base": null, "refs": { - "ListQueuedMessagesResponse$DownlinkQueueMessagesList": "

The messages in downlink queue.

" + "ListQueuedMessagesResponse$DownlinkQueueMessagesList": "

The messages in the downlink queue.

" } }, "DrMax": { @@ -814,17 +867,51 @@ "SidewalkDeviceMetadata$Event": "

Sidewalk device status notification.

" } }, + "EventConfigurationItem": { + "base": "

Event configuration object for a single resource.

", + "refs": { + "EventConfigurationsList$member": null + } + }, + "EventConfigurationsList": { + "base": null, + "refs": { + "ListEventConfigurationsResponse$EventConfigurationsList": "

Event configurations of all events for a single resource.

" + } + }, + "EventNotificationItemConfigurations": { + "base": "

Object of all event configurations and the status of the event topics.

", + "refs": { + "EventConfigurationItem$Events": null + } + }, "EventNotificationPartnerType": { "base": null, "refs": { + "EventConfigurationItem$PartnerType": "

Partner type of the resource if the identifier type is PartnerAccountId.

", "GetResourceEventConfigurationRequest$PartnerType": "

Partner type of the resource if the identifier type is PartnerAccountId.

", "UpdateResourceEventConfigurationRequest$PartnerType": "

Partner type of the resource if the identifier type is PartnerAccountId

" } }, + "EventNotificationResourceType": { + "base": null, + "refs": { + "ListEventConfigurationsRequest$ResourceType": "

Resource type to filter event configurations.

" + } + }, "EventNotificationTopicStatus": { "base": null, "refs": { - "SidewalkEventNotificationConfigurations$AmazonIdEventTopic": "

Enum to denote whether amazon id event topic is enabled or disabled.

" + "ConnectionStatusEventConfiguration$WirelessGatewayIdEventTopic": "

Enum to denote whether the wireless gateway id connection status event topic is enabled or disabled .

", + "DeviceRegistrationStateEventConfiguration$WirelessDeviceIdEventTopic": "

Enum to denote whether the wireless device id device registration state event topic is enabled or disabled.

", + "JoinEventConfiguration$WirelessDeviceIdEventTopic": "

Enum to denote whether the wireless device id join event topic is enabled or disabled.

", + "LoRaWANConnectionStatusEventNotificationConfigurations$GatewayEuiEventTopic": "

Enum to denote whether the gateway eui connection status event topic is enabled or disabled.

", + "LoRaWANConnectionStatusResourceTypeEventConfiguration$WirelessGatewayEventTopic": "

Enum to denote whether the wireless gateway connection status event topic is enabled or disabled.

", + "LoRaWANJoinEventNotificationConfigurations$DevEuiEventTopic": "

Enum to denote whether the dev eui join event topic is enabled or disabled.

", + "LoRaWANJoinResourceTypeEventConfiguration$WirelessDeviceEventTopic": "

Enum to denote whether the wireless device join event topic is enabled or disabled.

", + "ProximityEventConfiguration$WirelessDeviceIdEventTopic": "

Enum to denote whether the wireless device id proximity event topic is enabled or disabled.

", + "SidewalkEventNotificationConfigurations$AmazonIdEventTopic": "

Enum to denote whether amazon id event topic is enabled or disabled.

", + "SidewalkResourceTypeEventConfiguration$WirelessDeviceEventTopic": "

Enum to denote whether the wireless device join event topic is enabled or disabled.

" } }, "Expression": { @@ -845,6 +932,15 @@ "UpdateDestinationRequest$ExpressionType": "

The type of value in Expression.

" } }, + "FCntStart": { + "base": "

The FCnt init value.

", + "refs": { + "AbpV1_0_x$FCntStart": "

The FCnt init value.

", + "AbpV1_1$FCntStart": "

The FCnt init value.

", + "UpdateAbpV1_0_x$FCntStart": "

The FCnt init value.

", + "UpdateAbpV1_1$FCntStart": "

The FCnt init value.

" + } + }, "FNwkSIntKey": { "base": null, "refs": { @@ -987,6 +1083,16 @@ "refs": { } }, + "GetEventConfigurationByResourceTypesRequest": { + "base": null, + "refs": { + } + }, + "GetEventConfigurationByResourceTypesResponse": { + "base": null, + "refs": { + } + }, "GetFuotaTaskRequest": { "base": null, "refs": { @@ -1176,7 +1282,7 @@ "ISODateTimeString": { "base": null, "refs": { - "DownlinkQueueMessage$ReceivedAt": "

The timestamp that Iot Wireless received the message.

", + "DownlinkQueueMessage$ReceivedAt": "

The time at which Iot Wireless received the downlink message.

", "GetWirelessDeviceStatisticsResponse$LastUplinkReceivedAt": "

The date and time when the most recent uplink was received.

", "GetWirelessGatewayStatisticsResponse$LastUplinkReceivedAt": "

The date and time when the most recent uplink was received.

", "GetWirelessGatewayTaskResponse$LastUplinkReceivedAt": "

The date and time when the most recent uplink was received.

", @@ -1189,6 +1295,7 @@ "Identifier": { "base": null, "refs": { + "EventConfigurationItem$Identifier": "

Resource identifier opted in for event messaging.

", "GetResourceEventConfigurationRequest$Identifier": "

Resource identifier to opt in for event messaging.

", "GetWirelessDeviceRequest$Identifier": "

The identifier of the wireless device to get.

", "GetWirelessGatewayRequest$Identifier": "

The identifier of the wireless gateway to get.

", @@ -1198,6 +1305,7 @@ "IdentifierType": { "base": null, "refs": { + "EventConfigurationItem$IdentifierType": "

Identifier type of the particular resource identifier for event configuration.

", "GetResourceEventConfigurationRequest$IdentifierType": "

Identifier type of the particular resource identifier for event configuration.

", "UpdateResourceEventConfigurationRequest$IdentifierType": "

Identifier type of the particular resource identifier for event configuration.

" } @@ -1245,6 +1353,21 @@ "JoinEuiFilters$member": null } }, + "JoinEventConfiguration": { + "base": "

Join event configuration object for enabling or disabling topic.

", + "refs": { + "EventNotificationItemConfigurations$Join": "

Join event configuration for an event configuration item.

", + "GetResourceEventConfigurationResponse$Join": "

Event configuration for the join event.

", + "UpdateResourceEventConfigurationRequest$Join": "

Event configuration for the join event

" + } + }, + "JoinResourceTypeEventConfiguration": { + "base": "

Join resource type event configuration object for enabling or disabling topic.

", + "refs": { + "GetEventConfigurationByResourceTypesResponse$Join": "

Resource type event configuration for the join event

", + "UpdateEventConfigurationByResourceTypesRequest$Join": "

Join resource type event configuration object for enabling and disabling wireless device topic.

" + } + }, "ListDestinationsRequest": { "base": null, "refs": { @@ -1265,6 +1388,16 @@ "refs": { } }, + "ListEventConfigurationsRequest": { + "base": null, + "refs": { + } + }, + "ListEventConfigurationsResponse": { + "base": null, + "refs": { + } + }, "ListFuotaTasksRequest": { "base": null, "refs": { @@ -1295,6 +1428,16 @@ "refs": { } }, + "ListNetworkAnalyzerConfigurationsRequest": { + "base": null, + "refs": { + } + }, + "ListNetworkAnalyzerConfigurationsResponse": { + "base": null, + "refs": { + } + }, "ListPartnerAccountsRequest": { "base": null, "refs": { @@ -1365,6 +1508,18 @@ "refs": { } }, + "LoRaWANConnectionStatusEventNotificationConfigurations": { + "base": "

Object for LoRaWAN connection status resource type event configuration.

", + "refs": { + "ConnectionStatusEventConfiguration$LoRaWAN": "

Connection status event configuration object for enabling or disabling LoRaWAN related event topics.

" + } + }, + "LoRaWANConnectionStatusResourceTypeEventConfiguration": { + "base": "

Object for LoRaWAN connection status resource type event configuration.

", + "refs": { + "ConnectionStatusResourceTypeEventConfiguration$LoRaWAN": "

Connection status resource type event configuration object for enabling or disabling LoRaWAN related event topics.

" + } + }, "LoRaWANDevice": { "base": "

LoRaWAN object for create functions.

", "refs": { @@ -1440,6 +1595,18 @@ "GetServiceProfileResponse$LoRaWAN": "

Information about the service profile.

" } }, + "LoRaWANJoinEventNotificationConfigurations": { + "base": "

Object for LoRaWAN join resource type event configuration.

", + "refs": { + "JoinEventConfiguration$LoRaWAN": "

Join event configuration object for enabling or disabling LoRaWAN related event topics.

" + } + }, + "LoRaWANJoinResourceTypeEventConfiguration": { + "base": "

Object for LoRaWAN join resource type event configuration.

", + "refs": { + "JoinResourceTypeEventConfiguration$LoRaWAN": "

Join resource type event configuration object for enabling or disabling LoRaWAN related event topics.

" + } + }, "LoRaWANListDevice": { "base": "

LoRaWAN object for list functions.

", "refs": { @@ -1510,7 +1677,7 @@ } }, "LogLevel": { - "base": "

The log level for a log message.

", + "base": "

The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

", "refs": { "GetLogLevelsByResourceTypesResponse$DefaultLogLevel": null, "GetResourceLogLevelResponse$LogLevel": null, @@ -1546,9 +1713,11 @@ "refs": { "ListDestinationsRequest$MaxResults": "

The maximum number of results to return in this operation.

", "ListDeviceProfilesRequest$MaxResults": "

The maximum number of results to return in this operation.

", + "ListEventConfigurationsRequest$MaxResults": null, "ListFuotaTasksRequest$MaxResults": null, "ListMulticastGroupsByFuotaTaskRequest$MaxResults": null, "ListMulticastGroupsRequest$MaxResults": null, + "ListNetworkAnalyzerConfigurationsRequest$MaxResults": null, "ListPartnerAccountsRequest$MaxResults": "

The maximum number of results to return in this operation.

", "ListQueuedMessagesRequest$MaxResults": "

The maximum number of results to return in this operation.

", "ListServiceProfilesRequest$MaxResults": "

The maximum number of results to return in this operation.

", @@ -1578,8 +1747,8 @@ "MessageId": { "base": null, "refs": { - "DeleteQueuedMessagesRequest$MessageId": "

if messageID==\"*\", the queue for a particular wireless deviceId will be purged, otherwise, the specific message with messageId will be deleted

", - "DownlinkQueueMessage$MessageId": "

The messageId allocated by IoT Wireless for tracing purpose

", + "DeleteQueuedMessagesRequest$MessageId": "

If message ID is \"*\", it cleares the entire downlink queue for a given device, specified by the wireless device ID. Otherwise, the downlink message with the specified message ID will be deleted.

", + "DownlinkQueueMessage$MessageId": "

The message ID assigned by IoT Wireless to each downlink message, which helps identify the message.

", "SendDataToWirelessDeviceResponse$MessageId": "

The ID of the message sent to the wireless device.

" } }, @@ -1702,13 +1871,38 @@ "UpdateWirelessGatewayRequest$NetIdFilters": null } }, + "NetworkAnalyzerConfigurationArn": { + "base": null, + "refs": { + "CreateNetworkAnalyzerConfigurationResponse$Arn": "

The Amazon Resource Name of the new resource.

", + "GetNetworkAnalyzerConfigurationResponse$Arn": "

The Amazon Resource Name of the new resource.

", + "NetworkAnalyzerConfigurations$Arn": "

The Amazon Resource Name of the new resource.

" + } + }, + "NetworkAnalyzerConfigurationList": { + "base": null, + "refs": { + "ListNetworkAnalyzerConfigurationsResponse$NetworkAnalyzerConfigurationList": "

The list of network analyzer configurations.

" + } + }, "NetworkAnalyzerConfigurationName": { - "base": "

NetworkAnalyzer configuration name.

", + "base": "

Name of the network analyzer configuration.

", "refs": { + "CreateNetworkAnalyzerConfigurationRequest$Name": null, + "CreateNetworkAnalyzerConfigurationResponse$Name": null, + "DeleteNetworkAnalyzerConfigurationRequest$ConfigurationName": null, "GetNetworkAnalyzerConfigurationRequest$ConfigurationName": null, + "GetNetworkAnalyzerConfigurationResponse$Name": null, + "NetworkAnalyzerConfigurations$Name": null, "UpdateNetworkAnalyzerConfigurationRequest$ConfigurationName": null } }, + "NetworkAnalyzerConfigurations": { + "base": "

Network analyzer configurations.

", + "refs": { + "NetworkAnalyzerConfigurationList$member": null + } + }, "NextToken": { "base": null, "refs": { @@ -1716,12 +1910,16 @@ "ListDestinationsResponse$NextToken": "

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

", "ListDeviceProfilesRequest$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "ListDeviceProfilesResponse$NextToken": "

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

", + "ListEventConfigurationsRequest$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", + "ListEventConfigurationsResponse$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "ListFuotaTasksRequest$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "ListFuotaTasksResponse$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "ListMulticastGroupsByFuotaTaskRequest$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "ListMulticastGroupsByFuotaTaskResponse$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "ListMulticastGroupsRequest$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "ListMulticastGroupsResponse$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", + "ListNetworkAnalyzerConfigurationsRequest$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", + "ListNetworkAnalyzerConfigurationsResponse$NextToken": "

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

", "ListPartnerAccountsRequest$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "ListPartnerAccountsResponse$NextToken": "

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

", "ListQueuedMessagesRequest$NextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", @@ -1853,10 +2051,18 @@ "ProximityEventConfiguration": { "base": "

Proximity event configuration object for enabling and disabling relevant topics.

", "refs": { + "EventNotificationItemConfigurations$Proximity": "

Proximity event configuration for an event configuration item.

", "GetResourceEventConfigurationResponse$Proximity": "

Event configuration for the Proximity event

", "UpdateResourceEventConfigurationRequest$Proximity": "

Event configuration for the Proximity event

" } }, + "ProximityResourceTypeEventConfiguration": { + "base": "

Proximity resource type event configuration object for enabling or disabling topic.

", + "refs": { + "GetEventConfigurationByResourceTypesResponse$Proximity": "

Resource type event configuration for the proximity event

", + "UpdateEventConfigurationByResourceTypesRequest$Proximity": "

Proximity resource type event configuration object for enabling and disabling wireless gateway topic.

" + } + }, "PutResourceLogLevelRequest": { "base": null, "refs": { @@ -2151,6 +2357,13 @@ "SidewalkListDevice$SidewalkManufacturingSn": "

The Sidewalk manufacturing series number.

" } }, + "SidewalkResourceTypeEventConfiguration": { + "base": "

Sidewalk resource type event configuration object for enabling or disabling topic.

", + "refs": { + "DeviceRegistrationStateResourceTypeEventConfiguration$Sidewalk": "

Device registration resource type state event configuration object for enabling or disabling Sidewalk related event topics.

", + "ProximityResourceTypeEventConfiguration$Sidewalk": "

Proximity resource type event configuration object for enabling and disabling wireless device topic.

" + } + }, "SidewalkSendDataToDevice": { "base": "

Information about a Sidewalk router.

", "refs": { @@ -2293,6 +2506,7 @@ "CreateDeviceProfileRequest$Tags": "

The tags to attach to the new device profile. Tags are metadata that you can use to manage a resource.

", "CreateFuotaTaskRequest$Tags": null, "CreateMulticastGroupRequest$Tags": null, + "CreateNetworkAnalyzerConfigurationRequest$Tags": null, "CreateServiceProfileRequest$Tags": "

The tags to attach to the new service profile. Tags are metadata that you can use to manage a resource.

", "CreateWirelessDeviceRequest$Tags": "

The tags to attach to the new wireless device. Tags are metadata that you can use to manage a resource.

", "CreateWirelessGatewayRequest$Tags": "

The tags to attach to the new wireless gateway. Tags are metadata that you can use to manage a resource.

", @@ -2362,8 +2576,9 @@ } }, "TraceContent": { - "base": "

Trace Content for resources.

", + "base": "

Trace content for your wireless gateway and wireless device resources.

", "refs": { + "CreateNetworkAnalyzerConfigurationRequest$TraceContent": null, "GetNetworkAnalyzerConfigurationResponse$TraceContent": null, "UpdateNetworkAnalyzerConfigurationRequest$TraceContent": null } @@ -2371,7 +2586,7 @@ "TransmitMode": { "base": null, "refs": { - "DownlinkQueueMessage$TransmitMode": "

The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).

", + "DownlinkQueueMessage$TransmitMode": "

The transmit mode to use for sending data to the wireless device. This can be 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).

", "SendDataToWirelessDeviceRequest$TransmitMode": "

The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).

" } }, @@ -2403,6 +2618,18 @@ "refs": { } }, + "UpdateAbpV1_0_x": { + "base": "

ABP device object for LoRaWAN specification v1.0.x

", + "refs": { + "LoRaWANUpdateDevice$AbpV1_0_x": "

ABP device object for update APIs for v1.0.x

" + } + }, + "UpdateAbpV1_1": { + "base": "

ABP device object for LoRaWAN specification v1.1

", + "refs": { + "LoRaWANUpdateDevice$AbpV1_1": "

ABP device object for update APIs for v1.1

" + } + }, "UpdateDataSource": { "base": null, "refs": { @@ -2420,6 +2647,16 @@ "refs": { } }, + "UpdateEventConfigurationByResourceTypesRequest": { + "base": null, + "refs": { + } + }, + "UpdateEventConfigurationByResourceTypesResponse": { + "base": null, + "refs": { + } + }, "UpdateFuotaTaskRequest": { "base": null, "refs": { @@ -2551,7 +2788,7 @@ } }, "WirelessDeviceFrameInfo": { - "base": "

WirelessDevice FrameInfo for trace content.

", + "base": "

FrameInfo of your wireless device resources for the trace content. Use FrameInfo to debug the communication between your LoRaWAN end devices and the network server.

", "refs": { "TraceContent$WirelessDeviceFrameInfo": null } @@ -2564,7 +2801,7 @@ "AssociateWirelessDeviceWithThingRequest$Id": "

The ID of the resource to update.

", "CreateWirelessDeviceResponse$Id": "

The ID of the new wireless device.

", "CreateWirelessGatewayResponse$Id": "

The ID of the new wireless gateway.

", - "DeleteQueuedMessagesRequest$Id": "

Id of a given wireless device which messages will be deleted

", + "DeleteQueuedMessagesRequest$Id": "

The ID of a given wireless device for which downlink messages will be deleted.

", "DeleteWirelessDeviceRequest$Id": "

The ID of the resource to delete.

", "DisassociateWirelessDeviceFromFuotaTaskRequest$WirelessDeviceId": null, "DisassociateWirelessDeviceFromMulticastGroupRequest$WirelessDeviceId": null, @@ -2572,7 +2809,7 @@ "GetWirelessDeviceResponse$Id": "

The ID of the wireless device.

", "GetWirelessDeviceStatisticsRequest$WirelessDeviceId": "

The ID of the wireless device for which to get the data.

", "GetWirelessDeviceStatisticsResponse$WirelessDeviceId": "

The ID of the wireless device.

", - "ListQueuedMessagesRequest$Id": "

Id of a given wireless device which the downlink packets are targeted

", + "ListQueuedMessagesRequest$Id": "

The ID of a given wireless device which the downlink message packets are being sent.

", "SendDataToWirelessDeviceRequest$Id": "

The ID of the wireless device to receive the data.

", "TestWirelessDeviceRequest$Id": "

The ID of the wireless device to test.

", "UpdateWirelessDeviceRequest$Id": "

The ID of the resource to update.

", @@ -2589,9 +2826,10 @@ "WirelessDeviceList": { "base": null, "refs": { - "GetNetworkAnalyzerConfigurationResponse$WirelessDevices": "

List of WirelessDevices in the NetworkAnalyzerConfiguration.

", - "UpdateNetworkAnalyzerConfigurationRequest$WirelessDevicesToAdd": "

WirelessDevices to add into NetworkAnalyzerConfiguration.

", - "UpdateNetworkAnalyzerConfigurationRequest$WirelessDevicesToRemove": "

WirelessDevices to remove from NetworkAnalyzerConfiguration.

" + "CreateNetworkAnalyzerConfigurationRequest$WirelessDevices": "

Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId of the resource to add in the input array.

", + "GetNetworkAnalyzerConfigurationResponse$WirelessDevices": "

List of wireless gateway resources that have been added to the network analyzer configuration.

", + "UpdateNetworkAnalyzerConfigurationRequest$WirelessDevicesToAdd": "

Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId of the resource to add in the input array.

", + "UpdateNetworkAnalyzerConfigurationRequest$WirelessDevicesToRemove": "

Wireless device resources to remove from the network analyzer configuration. Provide the WirelessDeviceId of the resources to remove in the input array.

" } }, "WirelessDeviceLogOption": { @@ -2632,9 +2870,9 @@ "base": null, "refs": { "CreateWirelessDeviceRequest$Type": "

The wireless device type.

", - "DeleteQueuedMessagesRequest$WirelessDeviceType": "

The wireless device type, it is either Sidewalk or LoRaWAN.

", + "DeleteQueuedMessagesRequest$WirelessDeviceType": "

The wireless device type, which can be either Sidewalk or LoRaWAN.

", "GetWirelessDeviceResponse$Type": "

The wireless device type.

", - "ListQueuedMessagesRequest$WirelessDeviceType": "

The wireless device type, it is either Sidewalk or LoRaWAN.

", + "ListQueuedMessagesRequest$WirelessDeviceType": "

The wireless device type, whic can be either Sidewalk or LoRaWAN.

", "ListWirelessDevicesRequest$WirelessDeviceType": "

A filter to list only the wireless devices that use this wireless device type.

", "WirelessDeviceLogOption$Type": "

The wireless device type.

", "WirelessDeviceStatistics$Type": "

The wireless device type.

" @@ -2697,9 +2935,10 @@ "WirelessGatewayList": { "base": null, "refs": { - "GetNetworkAnalyzerConfigurationResponse$WirelessGateways": "

List of WirelessGateways in the NetworkAnalyzerConfiguration.

", - "UpdateNetworkAnalyzerConfigurationRequest$WirelessGatewaysToAdd": "

WirelessGateways to add into NetworkAnalyzerConfiguration.

", - "UpdateNetworkAnalyzerConfigurationRequest$WirelessGatewaysToRemove": "

WirelessGateways to remove from NetworkAnalyzerConfiguration.

" + "CreateNetworkAnalyzerConfigurationRequest$WirelessGateways": "

Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId of the resource to add in the input array.

", + "GetNetworkAnalyzerConfigurationResponse$WirelessGateways": "

List of wireless gateway resources that have been added to the network analyzer configuration.

", + "UpdateNetworkAnalyzerConfigurationRequest$WirelessGatewaysToAdd": "

Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId of the resource to add in the input array.

", + "UpdateNetworkAnalyzerConfigurationRequest$WirelessGatewaysToRemove": "

Wireless gateway resources to remove from the network analyzer configuration. Provide the WirelessGatewayId of the resources to remove in the input array.

" } }, "WirelessGatewayLogOption": { @@ -2727,7 +2966,7 @@ "WirelessGatewayServiceType": { "base": null, "refs": { - "GetServiceEndpointRequest$ServiceType": "

The service type for which to get endpoint information about. Can be CUPS for the Configuration and Update Server endpoint, or LNS for the LoRaWAN Network Server endpoint.

", + "GetServiceEndpointRequest$ServiceType": "

The service type for which to get endpoint information about. Can be CUPS for the Configuration and Update Server endpoint, or LNS for the LoRaWAN Network Server endpoint or CLAIM for the global endpoint.

", "GetServiceEndpointResponse$ServiceType": "

The endpoint's service type.

" } }, diff --git a/models/apis/iotwireless/2020-11-22/paginators-1.json b/models/apis/iotwireless/2020-11-22/paginators-1.json index d8018e60231..6d71883f05f 100644 --- a/models/apis/iotwireless/2020-11-22/paginators-1.json +++ b/models/apis/iotwireless/2020-11-22/paginators-1.json @@ -25,6 +25,11 @@ "output_token": "NextToken", "limit_key": "MaxResults" }, + "ListNetworkAnalyzerConfigurations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, "ListQueuedMessages": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/models/apis/lookoutequipment/2020-12-15/api-2.json b/models/apis/lookoutequipment/2020-12-15/api-2.json index a8fa7d211ce..19133cfa2e9 100644 --- a/models/apis/lookoutequipment/2020-12-15/api-2.json +++ b/models/apis/lookoutequipment/2020-12-15/api-2.json @@ -252,6 +252,22 @@ {"shape":"InternalServerException"} ] }, + "ListSensorStatistics":{ + "name":"ListSensorStatistics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSensorStatisticsRequest"}, + "output":{"shape":"ListSensorStatisticsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ @@ -384,12 +400,27 @@ "max":1011, "min":1 }, + "Boolean":{"type":"boolean"}, "BoundedLengthString":{ "type":"string", "max":5000, "min":1, "pattern":"[\\P{M}\\p{M}]{1,5000}" }, + "CategoricalValues":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{"shape":"StatisticalIssueStatus"}, + "NumberOfCategory":{"shape":"Integer"} + } + }, + "ComponentName":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[0-9a-zA-Z._\\-]{1,200}$" + }, "ComponentTimestampDelimiter":{ "type":"string", "max":1, @@ -404,11 +435,21 @@ }, "exception":true }, + "CountPercent":{ + "type":"structure", + "required":[ + "Count", + "Percentage" + ], + "members":{ + "Count":{"shape":"Integer"}, + "Percentage":{"shape":"Float"} + } + }, "CreateDatasetRequest":{ "type":"structure", "required":[ "DatasetName", - "DatasetSchema", "ClientToken" ], "members":{ @@ -524,6 +565,27 @@ "TargetSamplingRate":{"shape":"TargetSamplingRate"} } }, + "DataQualitySummary":{ + "type":"structure", + "required":[ + "InsufficientSensorData", + "MissingSensorData", + "InvalidSensorData", + "UnsupportedTimestamps", + "DuplicateTimestamps" + ], + "members":{ + "InsufficientSensorData":{"shape":"InsufficientSensorData"}, + "MissingSensorData":{"shape":"MissingSensorData"}, + "InvalidSensorData":{"shape":"InvalidSensorData"}, + "UnsupportedTimestamps":{"shape":"UnsupportedTimestamps"}, + "DuplicateTimestamps":{"shape":"DuplicateTimestamps"} + } + }, + "DataSizeInBytes":{ + "type":"long", + "min":0 + }, "DataUploadFrequency":{ "type":"string", "enum":[ @@ -619,7 +681,13 @@ "RoleArn":{"shape":"IamRoleArn"}, "CreatedAt":{"shape":"Timestamp"}, "Status":{"shape":"IngestionJobStatus"}, - "FailedReason":{"shape":"BoundedLengthString"} + "FailedReason":{"shape":"BoundedLengthString"}, + "DataQualitySummary":{"shape":"DataQualitySummary"}, + "IngestedFilesSummary":{"shape":"IngestedFilesSummary"}, + "StatusDetail":{"shape":"BoundedLengthString"}, + "IngestedDataSize":{"shape":"DataSizeInBytes"}, + "DataStartTime":{"shape":"Timestamp"}, + "DataEndTime":{"shape":"Timestamp"} } }, "DescribeDatasetRequest":{ @@ -642,7 +710,12 @@ "jsonvalue":true }, "ServerSideKmsKeyId":{"shape":"KmsKeyArn"}, - "IngestionInputConfiguration":{"shape":"IngestionInputConfiguration"} + "IngestionInputConfiguration":{"shape":"IngestionInputConfiguration"}, + "DataQualitySummary":{"shape":"DataQualitySummary"}, + "IngestedFilesSummary":{"shape":"IngestedFilesSummary"}, + "RoleArn":{"shape":"IamRoleArn"}, + "DataStartTime":{"shape":"Timestamp"}, + "DataEndTime":{"shape":"Timestamp"} } }, "DescribeInferenceSchedulerRequest":{ @@ -709,10 +782,18 @@ "OffCondition":{"shape":"OffCondition"} } }, + "DuplicateTimestamps":{ + "type":"structure", + "required":["TotalNumberOfDuplicateTimestamps"], + "members":{ + "TotalNumberOfDuplicateTimestamps":{"shape":"Integer"} + } + }, "FileNameTimestampFormat":{ "type":"string", "pattern":"^EPOCH|yyyy-MM-dd-HH-mm-ss|yyyyMMddHHmmss$" }, + "Float":{"type":"float"}, "IamRoleArn":{ "type":"string", "max":2048, @@ -836,6 +917,18 @@ "DataUploadFrequency":{"shape":"DataUploadFrequency"} } }, + "IngestedFilesSummary":{ + "type":"structure", + "required":[ + "TotalNumberOfFiles", + "IngestedNumberOfFiles" + ], + "members":{ + "TotalNumberOfFiles":{"shape":"Integer"}, + "IngestedNumberOfFiles":{"shape":"Integer"}, + "DiscardedFiles":{"shape":"ListOfDiscardedFiles"} + } + }, "IngestionInputConfiguration":{ "type":"structure", "required":["S3InputConfiguration"], @@ -861,7 +954,8 @@ "required":["Bucket"], "members":{ "Bucket":{"shape":"S3Bucket"}, - "Prefix":{"shape":"S3Prefix"} + "Prefix":{"shape":"S3Prefix"}, + "KeyPattern":{"shape":"KeyPattern"} } }, "InlineDataSchema":{ @@ -869,6 +963,18 @@ "max":1000000, "min":1 }, + "InsufficientSensorData":{ + "type":"structure", + "required":[ + "MissingCompleteSensorData", + "SensorsWithShortDateRange" + ], + "members":{ + "MissingCompleteSensorData":{"shape":"MissingCompleteSensorData"}, + "SensorsWithShortDateRange":{"shape":"SensorsWithShortDateRange"} + } + }, + "Integer":{"type":"integer"}, "InternalServerException":{ "type":"structure", "required":["Message"], @@ -878,6 +984,22 @@ "exception":true, "fault":true }, + "InvalidSensorData":{ + "type":"structure", + "required":[ + "AffectedSensorCount", + "TotalNumberOfInvalidValues" + ], + "members":{ + "AffectedSensorCount":{"shape":"Integer"}, + "TotalNumberOfInvalidValues":{"shape":"Integer"} + } + }, + "KeyPattern":{ + "type":"string", + "max":2048, + "min":1 + }, "KmsKeyArn":{ "type":"string", "max":1024, @@ -899,6 +1021,15 @@ "Prefix":{"shape":"S3Prefix"} } }, + "LargeTimestampGaps":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{"shape":"StatisticalIssueStatus"}, + "NumberOfLargeTimestampGaps":{"shape":"Integer"}, + "MaxTimestampGapInDays":{"shape":"Integer"} + } + }, "ListDataIngestionJobsRequest":{ "type":"structure", "members":{ @@ -982,6 +1113,28 @@ "ModelSummaries":{"shape":"ModelSummaries"} } }, + "ListOfDiscardedFiles":{ + "type":"list", + "member":{"shape":"S3Object"}, + "min":0 + }, + "ListSensorStatisticsRequest":{ + "type":"structure", + "required":["DatasetName"], + "members":{ + "DatasetName":{"shape":"DatasetName"}, + "IngestionJobId":{"shape":"IngestionJobId"}, + "MaxResults":{"shape":"MaxResults"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListSensorStatisticsResponse":{ + "type":"structure", + "members":{ + "SensorStatisticsSummaries":{"shape":"SensorStatisticsSummaries"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], @@ -1000,6 +1153,24 @@ "max":500, "min":1 }, + "MissingCompleteSensorData":{ + "type":"structure", + "required":["AffectedSensorCount"], + "members":{ + "AffectedSensorCount":{"shape":"Integer"} + } + }, + "MissingSensorData":{ + "type":"structure", + "required":[ + "AffectedSensorCount", + "TotalNumberOfMissingValues" + ], + "members":{ + "AffectedSensorCount":{"shape":"Integer"}, + "TotalNumberOfMissingValues":{"shape":"Integer"} + } + }, "ModelArn":{ "type":"string", "max":2048, @@ -1040,6 +1211,29 @@ "CreatedAt":{"shape":"Timestamp"} } }, + "MonotonicValues":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{"shape":"StatisticalIssueStatus"}, + "Monotonicity":{"shape":"Monotonicity"} + } + }, + "Monotonicity":{ + "type":"string", + "enum":[ + "DECREASING", + "INCREASING", + "STATIC" + ] + }, + "MultipleOperatingModes":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{"shape":"StatisticalIssueStatus"} + } + }, "NameOrArn":{ "type":"string", "max":2048, @@ -1093,6 +1287,41 @@ "min":0, "pattern":"(^$)|([\\P{M}\\p{M}]{1,1023}/$)" }, + "SensorName":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[0-9a-zA-Z:#$.\\-_]{1,200}$" + }, + "SensorStatisticsSummaries":{ + "type":"list", + "member":{"shape":"SensorStatisticsSummary"} + }, + "SensorStatisticsSummary":{ + "type":"structure", + "members":{ + "ComponentName":{"shape":"ComponentName"}, + "SensorName":{"shape":"SensorName"}, + "DataExists":{"shape":"Boolean"}, + "MissingValues":{"shape":"CountPercent"}, + "InvalidValues":{"shape":"CountPercent"}, + "InvalidDateEntries":{"shape":"CountPercent"}, + "DuplicateTimestamps":{"shape":"CountPercent"}, + "CategoricalValues":{"shape":"CategoricalValues"}, + "MultipleOperatingModes":{"shape":"MultipleOperatingModes"}, + "LargeTimestampGaps":{"shape":"LargeTimestampGaps"}, + "MonotonicValues":{"shape":"MonotonicValues"}, + "DataStartTime":{"shape":"Timestamp"}, + "DataEndTime":{"shape":"Timestamp"} + } + }, + "SensorsWithShortDateRange":{ + "type":"structure", + "required":["AffectedSensorCount"], + "members":{ + "AffectedSensorCount":{"shape":"Integer"} + } + }, "ServiceQuotaExceededException":{ "type":"structure", "required":["Message"], @@ -1143,6 +1372,13 @@ "Status":{"shape":"InferenceSchedulerStatus"} } }, + "StatisticalIssueStatus":{ + "type":"string", + "enum":[ + "POTENTIAL_ISSUE_DETECTED", + "NO_ISSUE_DETECTED" + ] + }, "StopInferenceSchedulerRequest":{ "type":"structure", "required":["InferenceSchedulerName"], @@ -1240,6 +1476,13 @@ "pattern":"^(\\+|\\-)[0-9]{2}\\:[0-9]{2}$" }, "Timestamp":{"type":"timestamp"}, + "UnsupportedTimestamps":{ + "type":"structure", + "required":["TotalNumberOfUnsupportedTimestamps"], + "members":{ + "TotalNumberOfUnsupportedTimestamps":{"shape":"Integer"} + } + }, "UntagResourceRequest":{ "type":"structure", "required":[ diff --git a/models/apis/lookoutequipment/2020-12-15/docs-2.json b/models/apis/lookoutequipment/2020-12-15/docs-2.json index 1aa7d5cf7c9..54561cf613c 100644 --- a/models/apis/lookoutequipment/2020-12-15/docs-2.json +++ b/models/apis/lookoutequipment/2020-12-15/docs-2.json @@ -8,8 +8,8 @@ "DeleteDataset": "

Deletes a dataset and associated artifacts. The operation will check to see if any inference scheduler or data ingestion job is currently using the dataset, and if there isn't, the dataset, its metadata, and any associated data stored in S3 will be deleted. This does not affect any models that used this dataset for training and evaluation, but does prevent it from being used in the future.

", "DeleteInferenceScheduler": "

Deletes an inference scheduler that has been set up. Already processed output results are not affected.

", "DeleteModel": "

Deletes an ML model currently available for Amazon Lookout for Equipment. This will prevent it from being used with an inference scheduler, even one that is already set up.

", - "DescribeDataIngestionJob": "

Provides information on a specific data ingestion job such as creation time, dataset ARN, status, and so on.

", - "DescribeDataset": "

Provides a JSON description of the data that is in each time series dataset, including names, column names, and data types.

", + "DescribeDataIngestionJob": "

Provides information on a specific data ingestion job such as creation time, dataset ARN, and status.

", + "DescribeDataset": "

Provides a JSON description of the data in each time series dataset, including names, column names, and data types.

", "DescribeInferenceScheduler": "

Specifies information about the inference scheduler being used, including name, model, status, and associated metadata

", "DescribeModel": "

Provides a JSON containing the overall information about a specific ML model, including model name and ARN, dataset, training and evaluation information, status, and so on.

", "ListDataIngestionJobs": "

Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on.

", @@ -17,6 +17,7 @@ "ListInferenceExecutions": "

Lists all inference executions that have been performed by the specified inference scheduler.

", "ListInferenceSchedulers": "

Retrieves a list of all inference schedulers currently available for your account.

", "ListModels": "

Generates a list of all models in the account, including model name and ARN, dataset, and status.

", + "ListSensorStatistics": "

Lists statistics about the data collected for each of the sensors that have been successfully ingested in the particular dataset. Can also be used to retreive Sensor Statistics for a previous ingestion job.

", "ListTagsForResource": "

Lists all the tags for a specified resource, including key and value.

", "StartDataIngestionJob": "

Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.

", "StartInferenceScheduler": "

Starts an inference scheduler.

", @@ -39,12 +40,19 @@ "UntagResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the resource to which the tag is currently associated.

" } }, + "Boolean": { + "base": null, + "refs": { + "SensorStatisticsSummary$DataExists": "

Parameter that indicates whether data exists for the sensor that the statistics belong to.

" + } + }, "BoundedLengthString": { "base": null, "refs": { "AccessDeniedException$Message": null, "ConflictException$Message": null, "DescribeDataIngestionJobResponse$FailedReason": "

Specifies the reason for failure when a data ingestion job has failed.

", + "DescribeDataIngestionJobResponse$StatusDetail": "

Provides details about status of the ingestion job that is currently in progress.

", "DescribeModelResponse$FailedReason": "

If the training of the ML model failed, this indicates the reason for that failure.

", "InferenceExecutionSummary$FailedReason": "

Specifies the reason for failure when an inference execution has failed.

", "InternalServerException$Message": null, @@ -54,6 +62,18 @@ "ValidationException$Message": null } }, + "CategoricalValues": { + "base": "

Entity that comprises information on categorical values in data.

", + "refs": { + "SensorStatisticsSummary$CategoricalValues": "

Parameter that describes potential risk about whether data associated with the sensor is categorical.

" + } + }, + "ComponentName": { + "base": null, + "refs": { + "SensorStatisticsSummary$ComponentName": "

Name of the component to which the particular sensor belongs for which the statistics belong to.

" + } + }, "ComponentTimestampDelimiter": { "base": null, "refs": { @@ -65,6 +85,15 @@ "refs": { } }, + "CountPercent": { + "base": "

Entity that comprises information of count and percentage.

", + "refs": { + "SensorStatisticsSummary$MissingValues": "

Parameter that describes the total number of, and percentage of, values that are missing for the sensor that the statistics belong to.

", + "SensorStatisticsSummary$InvalidValues": "

Parameter that describes the total number of, and percentage of, values that are invalid for the sensor that the statistics belong to.

", + "SensorStatisticsSummary$InvalidDateEntries": "

Parameter that describes the total number of invalid date entries associated with the sensor that the statistics belong to.

", + "SensorStatisticsSummary$DuplicateTimestamps": "

Parameter that describes the total number of duplicate timestamp records associated with the sensor that the statistics belong to.

" + } + }, "CreateDatasetRequest": { "base": null, "refs": { @@ -123,6 +152,19 @@ "DescribeModelResponse$DataPreProcessingConfiguration": "

The configuration is the TargetSamplingRate, which is the sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been collected at a 1 second level and you want the system to resample the data at a 1 minute rate before training, the TargetSamplingRate is 1 minute.

When providing a value for the TargetSamplingRate, you must attach the prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore PT1S, the value for a 15 minute rate is PT15M, and the value for a 1 hour rate is PT1H

" } }, + "DataQualitySummary": { + "base": "

DataQualitySummary gives aggregated statistics over all the sensors about a completed ingestion job. It primarily gives more information about statistics over different incorrect data like MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, DuplicateTimeStamps.

", + "refs": { + "DescribeDataIngestionJobResponse$DataQualitySummary": "

Gives statistics about a completed ingestion job. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.

", + "DescribeDatasetResponse$DataQualitySummary": "

Gives statistics associated with the given dataset for the latest successful associated ingestion job id. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.

" + } + }, + "DataSizeInBytes": { + "base": null, + "refs": { + "DescribeDataIngestionJobResponse$IngestedDataSize": "

Indicates the size of the ingested dataset.

" + } + }, "DataUploadFrequency": { "base": null, "refs": { @@ -165,6 +207,7 @@ "ListDataIngestionJobsRequest$DatasetName": "

The name of the dataset being used for the data ingestion job.

", "ListDatasetsRequest$DatasetNameBeginsWith": "

The beginning of the name of the datasets to be listed.

", "ListModelsRequest$DatasetNameBeginsWith": "

The beginning of the name of the dataset of the ML models to be listed.

", + "ListSensorStatisticsRequest$DatasetName": "

The name of the dataset associated with the list of Sensor Statistics.

", "ModelSummary$DatasetName": "

The name of the dataset being used for the ML model.

" } }, @@ -250,18 +293,31 @@ "refs": { } }, + "DuplicateTimestamps": { + "base": "

Entity that comprises information abount duplicate timestamps in the dataset.

", + "refs": { + "DataQualitySummary$DuplicateTimestamps": "

Parameter that gives information about duplicate timestamps in the input data.

" + } + }, "FileNameTimestampFormat": { "base": null, "refs": { "InferenceInputNameConfiguration$TimestampFormat": "

The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).

" } }, + "Float": { + "base": null, + "refs": { + "CountPercent$Percentage": "

Indicates the percentage of occurances of the given statistic.

" + } + }, "IamRoleArn": { "base": null, "refs": { "CreateInferenceSchedulerRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to access the data source being used for the inference.

", "CreateModelRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to access the data source being used to create the ML model.

", "DescribeDataIngestionJobResponse$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source being ingested.

", + "DescribeDatasetResponse$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role that you are using for this the data ingestion job.

", "DescribeInferenceSchedulerResponse$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler being described.

", "DescribeModelResponse$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to access the data source for the ML model being described.

", "StartDataIngestionJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of a role with permission to access the data source for the data ingestion job.

", @@ -297,7 +353,7 @@ } }, "InferenceInputConfiguration": { - "base": "

Specifies configuration information for the input data for the inference, including S3 location of input data..

", + "base": "

Specifies configuration information for the input data for the inference, including Amazon S3 location of input data..

", "refs": { "CreateInferenceSchedulerRequest$DataInputConfiguration": "

Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

", "DescribeInferenceSchedulerResponse$DataInputConfiguration": "

Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

", @@ -316,14 +372,14 @@ "refs": { "CreateInferenceSchedulerRequest$DataOutputConfiguration": "

Specifies configuration information for the output results for the inference scheduler, including the S3 location for the output.

", "DescribeInferenceSchedulerResponse$DataOutputConfiguration": "

Specifies information for the output results for the inference scheduler, including the output S3 location.

", - "InferenceExecutionSummary$DataOutputConfiguration": "

Specifies configuration information for the output results from for the inference execution, including the output S3 location.

", + "InferenceExecutionSummary$DataOutputConfiguration": "

Specifies configuration information for the output results from for the inference execution, including the output Amazon S3 location.

", "UpdateInferenceSchedulerRequest$DataOutputConfiguration": "

Specifies information for the output results from the inference scheduler, including the output S3 location.

" } }, "InferenceS3InputConfiguration": { "base": "

Specifies configuration information for the input data for the inference, including input data S3 location.

", "refs": { - "InferenceInputConfiguration$S3InputConfiguration": "

Specifies configuration information for the input data for the inference, including S3 location of input data..

" + "InferenceInputConfiguration$S3InputConfiguration": "

Specifies configuration information for the input data for the inference, including Amazon S3 location of input data.

" } }, "InferenceS3OutputConfiguration": { @@ -389,10 +445,17 @@ "InferenceSchedulerSummaries$member": null } }, + "IngestedFilesSummary": { + "base": "

Gives statistics about how many files have been ingested, and which files have not been ingested, for a particular ingestion job.

", + "refs": { + "DescribeDataIngestionJobResponse$IngestedFilesSummary": null, + "DescribeDatasetResponse$IngestedFilesSummary": "

IngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id.

" + } + }, "IngestionInputConfiguration": { "base": "

Specifies configuration information for the input data for the data ingestion job, including input data S3 location.

", "refs": { - "DataIngestionJobSummary$IngestionInputConfiguration": "

Specifies information for the input data for the data inference job, including data S3 location parameters.

", + "DataIngestionJobSummary$IngestionInputConfiguration": "

Specifies information for the input data for the data inference job, including data Amazon S3 location parameters.

", "DescribeDataIngestionJobResponse$IngestionInputConfiguration": "

Specifies the S3 location configuration for the data input for the data ingestion job.

", "DescribeDatasetResponse$IngestionInputConfiguration": "

Specifies the S3 location configuration for the data input for the data ingestion job.

", "StartDataIngestionJobRequest$IngestionInputConfiguration": "

Specifies information for the input data for the data ingestion job, including dataset S3 location.

" @@ -404,6 +467,7 @@ "DataIngestionJobSummary$JobId": "

Indicates the job ID of the data ingestion job.

", "DescribeDataIngestionJobRequest$JobId": "

The job ID of the data ingestion job.

", "DescribeDataIngestionJobResponse$JobId": "

Indicates the job ID of the data ingestion job.

", + "ListSensorStatisticsRequest$IngestionJobId": "

The ingestion job id associated with the list of Sensor Statistics. To get sensor statistics for a particular ingestion job id, both dataset name and ingestion job id must be submitted as inputs.

", "StartDataIngestionJobResponse$JobId": "

Indicates the job ID of the data ingestion job.

" } }, @@ -430,11 +494,48 @@ "DescribeModelResponse$Schema": "

A JSON description of the data that is in each time series dataset, including names, column names, and data types.

" } }, + "InsufficientSensorData": { + "base": "

Entity that comprises aggregated information on sensors having insufficient data.

", + "refs": { + "DataQualitySummary$InsufficientSensorData": "

Parameter that gives information about insufficient data for sensors in the dataset. This includes information about those sensors that have complete data missing and those with a short date range.

" + } + }, + "Integer": { + "base": null, + "refs": { + "CategoricalValues$NumberOfCategory": "

Indicates the number of categories in the data.

", + "CountPercent$Count": "

Indicates the count of occurences of the given statistic.

", + "DuplicateTimestamps$TotalNumberOfDuplicateTimestamps": "

Indicates the total number of duplicate timestamps.

", + "IngestedFilesSummary$TotalNumberOfFiles": "

Indicates the total number of files that were submitted for ingestion.

", + "IngestedFilesSummary$IngestedNumberOfFiles": "

Indicates the number of files that were successfully ingested.

", + "InvalidSensorData$AffectedSensorCount": "

Indicates the number of sensors that have at least some invalid values.

", + "InvalidSensorData$TotalNumberOfInvalidValues": "

Indicates the total number of invalid values across all the sensors.

", + "LargeTimestampGaps$NumberOfLargeTimestampGaps": "

Indicates the number of large timestamp gaps, if there are any.

", + "LargeTimestampGaps$MaxTimestampGapInDays": "

Indicates the size of the largest timestamp gap, in days.

", + "MissingCompleteSensorData$AffectedSensorCount": "

Indicates the number of sensors that have data missing completely.

", + "MissingSensorData$AffectedSensorCount": "

Indicates the number of sensors that have atleast some data missing.

", + "MissingSensorData$TotalNumberOfMissingValues": "

Indicates the total number of missing values across all the sensors.

", + "SensorsWithShortDateRange$AffectedSensorCount": "

Indicates the number of sensors that have less than 90 days of data.

", + "UnsupportedTimestamps$TotalNumberOfUnsupportedTimestamps": "

Indicates the total number of unsupported timestamps across the ingested data.

" + } + }, "InternalServerException": { "base": "

Processing of the request has failed because of an unknown error, exception or failure.

", "refs": { } }, + "InvalidSensorData": { + "base": "

Entity that comprises aggregated information on sensors having insufficient data.

", + "refs": { + "DataQualitySummary$InvalidSensorData": "

Parameter that gives information about data that is invalid over all the sensors in the input data.

" + } + }, + "KeyPattern": { + "base": null, + "refs": { + "IngestionS3InputConfiguration$KeyPattern": "

Pattern for matching the Amazon S3 files which will be used for ingestion. If no KeyPattern is provided, we will use the default hierarchy file structure, which is same as KeyPattern {prefix}/{component_name}/*

" + } + }, "KmsKeyArn": { "base": null, "refs": { @@ -456,6 +557,12 @@ "LabelsInputConfiguration$S3InputConfiguration": "

Contains location information for the S3 location being used for label data.

" } }, + "LargeTimestampGaps": { + "base": "

Entity that comprises information on large gaps between consecutive timestamps in data.

", + "refs": { + "SensorStatisticsSummary$LargeTimestampGaps": "

Parameter that describes potential risk about whether data associated with the sensor contains one or more large gaps between consecutive timestamps.

" + } + }, "ListDataIngestionJobsRequest": { "base": null, "refs": { @@ -506,6 +613,22 @@ "refs": { } }, + "ListOfDiscardedFiles": { + "base": null, + "refs": { + "IngestedFilesSummary$DiscardedFiles": "

Indicates the number of files that were discarded. A file could be discarded because its format is invalid (for example, a jpg or pdf) or not readable.

" + } + }, + "ListSensorStatisticsRequest": { + "base": null, + "refs": { + } + }, + "ListSensorStatisticsResponse": { + "base": null, + "refs": { + } + }, "ListTagsForResourceRequest": { "base": null, "refs": { @@ -523,7 +646,20 @@ "ListDatasetsRequest$MaxResults": "

Specifies the maximum number of datasets to list.

", "ListInferenceExecutionsRequest$MaxResults": "

Specifies the maximum number of inference executions to list.

", "ListInferenceSchedulersRequest$MaxResults": "

Specifies the maximum number of inference schedulers to list.

", - "ListModelsRequest$MaxResults": "

Specifies the maximum number of ML models to list.

" + "ListModelsRequest$MaxResults": "

Specifies the maximum number of ML models to list.

", + "ListSensorStatisticsRequest$MaxResults": "

Specifies the maximum number of sensors for which to retrieve statistics.

" + } + }, + "MissingCompleteSensorData": { + "base": "

Entity that comprises information on sensors that have sensor data completely missing.

", + "refs": { + "InsufficientSensorData$MissingCompleteSensorData": "

Parameter that describes the total number of sensors that have data completely missing for it.

" + } + }, + "MissingSensorData": { + "base": "

Entity that comprises aggregated information on sensors having missing data.

", + "refs": { + "DataQualitySummary$MissingSensorData": "

Parameter that gives information about data that is missing over all the sensors in the input data.

" } }, "ModelArn": { @@ -584,6 +720,24 @@ "ModelSummaries$member": null } }, + "MonotonicValues": { + "base": "

Entity that comprises information on monotonic values in the data.

", + "refs": { + "SensorStatisticsSummary$MonotonicValues": "

Parameter that describes potential risk about whether data associated with the sensor is mostly monotonic.

" + } + }, + "Monotonicity": { + "base": null, + "refs": { + "MonotonicValues$Monotonicity": "

Indicates the monotonicity of values. Can be INCREASING, DECREASING, or STATIC.

" + } + }, + "MultipleOperatingModes": { + "base": "

Entity that comprises information on operating modes in data.

", + "refs": { + "SensorStatisticsSummary$MultipleOperatingModes": "

Parameter that describes potential risk about whether data associated with the sensor has more than one operating mode.

" + } + }, "NameOrArn": { "base": null, "refs": { @@ -605,7 +759,9 @@ "ListInferenceSchedulersRequest$NextToken": "

An opaque pagination token indicating where to continue the listing of inference schedulers.

", "ListInferenceSchedulersResponse$NextToken": "

An opaque pagination token indicating where to continue the listing of inference schedulers.

", "ListModelsRequest$NextToken": "

An opaque pagination token indicating where to continue the listing of ML models.

", - "ListModelsResponse$NextToken": "

An opaque pagination token indicating where to continue the listing of ML models.

" + "ListModelsResponse$NextToken": "

An opaque pagination token indicating where to continue the listing of ML models.

", + "ListSensorStatisticsRequest$NextToken": "

An opaque pagination token indicating where to continue the listing of sensor statistics.

", + "ListSensorStatisticsResponse$NextToken": "

An opaque pagination token indicating where to continue the listing of sensor statistics.

" } }, "OffCondition": { @@ -639,7 +795,8 @@ "S3Object": { "base": "

Contains information about an S3 bucket.

", "refs": { - "InferenceExecutionSummary$CustomerResultObject": "

" + "InferenceExecutionSummary$CustomerResultObject": "

", + "ListOfDiscardedFiles$member": null } }, "S3Prefix": { @@ -651,6 +808,30 @@ "LabelsS3InputConfiguration$Prefix": "

The prefix for the S3 bucket used for the label data.

" } }, + "SensorName": { + "base": null, + "refs": { + "SensorStatisticsSummary$SensorName": "

Name of the sensor that the statistics belong to.

" + } + }, + "SensorStatisticsSummaries": { + "base": null, + "refs": { + "ListSensorStatisticsResponse$SensorStatisticsSummaries": "

Provides ingestion-based statistics regarding the specified sensor with respect to various validation types, such as whether data exists, the number and percentage of missing values, and the number and percentage of duplicate timestamps.

" + } + }, + "SensorStatisticsSummary": { + "base": "

Summary of ingestion statistics like whether data exists, number of missing values, number of invalid values and so on related to the particular sensor.

", + "refs": { + "SensorStatisticsSummaries$member": null + } + }, + "SensorsWithShortDateRange": { + "base": "

Entity that comprises information on sensors that have shorter date range.

", + "refs": { + "InsufficientSensorData$SensorsWithShortDateRange": "

Parameter that describes the total number of sensors that have a short date range of less than 90 days of data overall.

" + } + }, "ServiceQuotaExceededException": { "base": "

Resource limitations have been exceeded.

", "refs": { @@ -676,6 +857,15 @@ "refs": { } }, + "StatisticalIssueStatus": { + "base": null, + "refs": { + "CategoricalValues$Status": "

Indicates whether there is a potential data issue related to categorical values.

", + "LargeTimestampGaps$Status": "

Indicates whether there is a potential data issue related to large gaps in timestamps.

", + "MonotonicValues$Status": "

Indicates whether there is a potential data issue related to having monotonic values.

", + "MultipleOperatingModes$Status": "

Indicates whether there is a potential data issue related to having multiple operating modes.

" + } + }, "StopInferenceSchedulerRequest": { "base": null, "refs": { @@ -745,7 +935,7 @@ "TimeZoneOffset": { "base": null, "refs": { - "InferenceInputConfiguration$InputTimeZoneOffset": "

Indicates the difference between your time zone and Greenwich Mean Time (GMT).

" + "InferenceInputConfiguration$InputTimeZoneOffset": "

Indicates the difference between your time zone and Coordinated Universal Time (UTC).

" } }, "Timestamp": { @@ -757,8 +947,12 @@ "CreateModelRequest$EvaluationDataEndTime": "

Indicates the time reference in the dataset that should be used to end the subset of evaluation data for the ML model.

", "DatasetSummary$CreatedAt": "

The time at which the dataset was created in Amazon Lookout for Equipment.

", "DescribeDataIngestionJobResponse$CreatedAt": "

The time at which the data ingestion job was created.

", + "DescribeDataIngestionJobResponse$DataStartTime": "

Indicates the earliest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

", + "DescribeDataIngestionJobResponse$DataEndTime": "

Indicates the latest timestamp corresponding to data that was successfully ingested during this specific ingestion job.

", "DescribeDatasetResponse$CreatedAt": "

Specifies the time the dataset was created in Amazon Lookout for Equipment.

", "DescribeDatasetResponse$LastUpdatedAt": "

Specifies the time the dataset was last updated, if it was.

", + "DescribeDatasetResponse$DataStartTime": "

Indicates the earliest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.

", + "DescribeDatasetResponse$DataEndTime": "

Indicates the latest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.

", "DescribeInferenceSchedulerResponse$CreatedAt": "

Specifies the time at which the inference scheduler was created.

", "DescribeInferenceSchedulerResponse$UpdatedAt": "

Specifies the time at which the inference scheduler was last updated, if it was.

", "DescribeModelResponse$TrainingDataStartTime": "

Indicates the time reference in the dataset that was used to begin the subset of training data for the ML model.

", @@ -774,7 +968,15 @@ "InferenceExecutionSummary$DataEndTime": "

Indicates the time reference in the dataset at which the inference execution stopped.

", "ListInferenceExecutionsRequest$DataStartTimeAfter": "

The time reference in the inferenced dataset after which Amazon Lookout for Equipment started the inference execution.

", "ListInferenceExecutionsRequest$DataEndTimeBefore": "

The time reference in the inferenced dataset before which Amazon Lookout for Equipment stopped the inference execution.

", - "ModelSummary$CreatedAt": "

The time at which the specific model was created.

" + "ModelSummary$CreatedAt": "

The time at which the specific model was created.

", + "SensorStatisticsSummary$DataStartTime": "

Indicates the time reference to indicate the beginning of valid data associated with the sensor that the statistics belong to.

", + "SensorStatisticsSummary$DataEndTime": "

Indicates the time reference to indicate the end of valid data associated with the sensor that the statistics belong to.

" + } + }, + "UnsupportedTimestamps": { + "base": "

Entity that comprises information abount unsupported timestamps in the dataset.

", + "refs": { + "DataQualitySummary$UnsupportedTimestamps": "

Parameter that gives information about unsupported timestamps in the input data.

" } }, "UntagResourceRequest": { diff --git a/models/apis/lookoutequipment/2020-12-15/paginators-1.json b/models/apis/lookoutequipment/2020-12-15/paginators-1.json index 4e4242164a8..ec69388fc64 100644 --- a/models/apis/lookoutequipment/2020-12-15/paginators-1.json +++ b/models/apis/lookoutequipment/2020-12-15/paginators-1.json @@ -24,6 +24,11 @@ "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults" + }, + "ListSensorStatistics": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" } } } diff --git a/models/apis/rekognition/2016-06-27/api-2.json b/models/apis/rekognition/2016-06-27/api-2.json index 388562a0a90..ecdbb0b9e80 100644 --- a/models/apis/rekognition/2016-06-27/api-2.json +++ b/models/apis/rekognition/2016-06-27/api-2.json @@ -1099,6 +1099,23 @@ {"shape":"ResourceInUseException"}, {"shape":"ResourceNotFoundException"} ] + }, + "UpdateStreamProcessor":{ + "name":"UpdateStreamProcessor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateStreamProcessorRequest"}, + "output":{"shape":"UpdateStreamProcessorResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ProvisionedThroughputExceededException"} + ] } }, "shapes":{ @@ -1318,6 +1335,28 @@ "Confidence":{"shape":"Percent"} } }, + "ConnectedHomeLabel":{"type":"string"}, + "ConnectedHomeLabels":{ + "type":"list", + "member":{"shape":"ConnectedHomeLabel"}, + "max":128, + "min":1 + }, + "ConnectedHomeSettings":{ + "type":"structure", + "required":["Labels"], + "members":{ + "Labels":{"shape":"ConnectedHomeLabels"}, + "MinConfidence":{"shape":"Percent"} + } + }, + "ConnectedHomeSettingsForUpdate":{ + "type":"structure", + "members":{ + "Labels":{"shape":"ConnectedHomeLabels"}, + "MinConfidence":{"shape":"Percent"} + } + }, "ContentClassifier":{ "type":"string", "enum":[ @@ -1440,7 +1479,11 @@ "Name":{"shape":"StreamProcessorName"}, "Settings":{"shape":"StreamProcessorSettings"}, "RoleArn":{"shape":"RoleArn"}, - "Tags":{"shape":"TagMap"} + "Tags":{"shape":"TagMap"}, + "NotificationChannel":{"shape":"StreamProcessorNotificationChannel"}, + "KmsKeyId":{"shape":"KmsKeyId"}, + "RegionsOfInterest":{"shape":"RegionsOfInterest"}, + "DataSharingPreference":{"shape":"StreamProcessorDataSharingPreference"} } }, "CreateStreamProcessorResponse":{ @@ -1749,7 +1792,11 @@ "Input":{"shape":"StreamProcessorInput"}, "Output":{"shape":"StreamProcessorOutput"}, "RoleArn":{"shape":"RoleArn"}, - "Settings":{"shape":"StreamProcessorSettings"} + "Settings":{"shape":"StreamProcessorSettings"}, + "NotificationChannel":{"shape":"StreamProcessorNotificationChannel"}, + "KmsKeyId":{"shape":"KmsKeyId"}, + "RegionsOfInterest":{"shape":"RegionsOfInterest"}, + "DataSharingPreference":{"shape":"StreamProcessorDataSharingPreference"} } }, "DetectCustomLabelsRequest":{ @@ -2482,6 +2529,19 @@ "Arn":{"shape":"KinesisVideoArn"} } }, + "KinesisVideoStreamFragmentNumber":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[0-9]+$" + }, + "KinesisVideoStreamStartSelector":{ + "type":"structure", + "members":{ + "ProducerTimestamp":{"shape":"ULong"}, + "FragmentNumber":{"shape":"KinesisVideoStreamFragmentNumber"} + } + }, "KmsKeyId":{ "type":"string", "max":2048, @@ -2692,6 +2752,11 @@ "Tags":{"shape":"TagMap"} } }, + "MaxDurationInSecondsULong":{ + "type":"long", + "max":120, + "min":1 + }, "MaxFaces":{ "type":"integer", "max":4096, @@ -3053,7 +3118,8 @@ "RegionOfInterest":{ "type":"structure", "members":{ - "BoundingBox":{"shape":"BoundingBox"} + "BoundingBox":{"shape":"BoundingBox"}, + "Polygon":{"shape":"Polygon"} } }, "RegionsOfInterest":{ @@ -3105,6 +3171,13 @@ "min":3, "pattern":"[0-9A-Za-z\\.\\-_]*" }, + "S3Destination":{ + "type":"structure", + "members":{ + "Bucket":{"shape":"S3Bucket"}, + "KeyPrefix":{"shape":"S3KeyPrefix"} + } + }, "S3KeyPrefix":{ "type":"string", "max":1024 @@ -3403,14 +3476,18 @@ "type":"structure", "required":["Name"], "members":{ - "Name":{"shape":"StreamProcessorName"} + "Name":{"shape":"StreamProcessorName"}, + "StartSelector":{"shape":"StreamProcessingStartSelector"}, + "StopSelector":{"shape":"StreamProcessingStopSelector"} } }, "StartStreamProcessorResponse":{ "type":"structure", "members":{ + "SessionId":{"shape":"StartStreamProcessorSessionId"} } }, + "StartStreamProcessorSessionId":{"type":"string"}, "StartTechnicalCueDetectionFilter":{ "type":"structure", "members":{ @@ -3468,6 +3545,18 @@ "members":{ } }, + "StreamProcessingStartSelector":{ + "type":"structure", + "members":{ + "KVSStreamStartSelector":{"shape":"KinesisVideoStreamStartSelector"} + } + }, + "StreamProcessingStopSelector":{ + "type":"structure", + "members":{ + "MaxDurationInSeconds":{"shape":"MaxDurationInSecondsULong"} + } + }, "StreamProcessor":{ "type":"structure", "members":{ @@ -3479,6 +3568,13 @@ "type":"string", "pattern":"(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:streamprocessor\\/.+$)" }, + "StreamProcessorDataSharingPreference":{ + "type":"structure", + "required":["OptIn"], + "members":{ + "OptIn":{"shape":"Boolean"} + } + }, "StreamProcessorInput":{ "type":"structure", "members":{ @@ -3495,16 +3591,42 @@ "min":1, "pattern":"[a-zA-Z0-9_.\\-]+" }, + "StreamProcessorNotificationChannel":{ + "type":"structure", + "required":["SNSTopicArn"], + "members":{ + "SNSTopicArn":{"shape":"SNSTopicArn"} + } + }, "StreamProcessorOutput":{ "type":"structure", "members":{ - "KinesisDataStream":{"shape":"KinesisDataStream"} + "KinesisDataStream":{"shape":"KinesisDataStream"}, + "S3Destination":{"shape":"S3Destination"} } }, + "StreamProcessorParameterToDelete":{ + "type":"string", + "enum":[ + "ConnectedHomeMinConfidence", + "RegionsOfInterest" + ] + }, + "StreamProcessorParametersToDelete":{ + "type":"list", + "member":{"shape":"StreamProcessorParameterToDelete"} + }, "StreamProcessorSettings":{ "type":"structure", "members":{ - "FaceSearch":{"shape":"FaceSearchSettings"} + "FaceSearch":{"shape":"FaceSearchSettings"}, + "ConnectedHome":{"shape":"ConnectedHomeSettings"} + } + }, + "StreamProcessorSettingsForUpdate":{ + "type":"structure", + "members":{ + "ConnectedHomeForUpdate":{"shape":"ConnectedHomeSettingsForUpdate"} } }, "StreamProcessorStatus":{ @@ -3514,7 +3636,8 @@ "STARTING", "RUNNING", "FAILED", - "STOPPING" + "STOPPING", + "UPDATING" ] }, "String":{"type":"string"}, @@ -3713,6 +3836,22 @@ "members":{ } }, + "UpdateStreamProcessorRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"StreamProcessorName"}, + "SettingsForUpdate":{"shape":"StreamProcessorSettingsForUpdate"}, + "RegionsOfInterestForUpdate":{"shape":"RegionsOfInterest"}, + "DataSharingPreferenceForUpdate":{"shape":"StreamProcessorDataSharingPreference"}, + "ParametersToDelete":{"shape":"StreamProcessorParametersToDelete"} + } + }, + "UpdateStreamProcessorResponse":{ + "type":"structure", + "members":{ + } + }, "Url":{"type":"string"}, "Urls":{ "type":"list", diff --git a/models/apis/rekognition/2016-06-27/docs-2.json b/models/apis/rekognition/2016-06-27/docs-2.json index 70e4255ff08..15529f43703 100644 --- a/models/apis/rekognition/2016-06-27/docs-2.json +++ b/models/apis/rekognition/2016-06-27/docs-2.json @@ -1,14 +1,14 @@ { "version": "2.0", - "service": "

This is the Amazon Rekognition API reference.

", + "service": "

This is the API Reference for Amazon Rekognition Image, Amazon Rekognition Custom Labels, Amazon Rekognition Stored Video, Amazon Rekognition Streaming Video. It provides descriptions of actions, data types, common parameters, and common errors.

Amazon Rekognition Image

Amazon Rekognition Custom Labels

Amazon Rekognition Video Stored Video

Amazon Rekognition Video Streaming Video

", "operations": { "CompareFaces": "

Compares a face in the source input image with each of the 100 largest faces detected in the target input image.

If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image.

CompareFaces uses machine learning algorithms, which are probabilistic. A false negative is an incorrect prediction that a face in the target image has a low similarity confidence score when compared to the face in the source image. To reduce the probability of false negatives, we recommend that you compare the target image against multiple source images. If you plan to use CompareFaces to make a decision that impacts an individual's rights, privacy, or access to services, we recommend that you pass the result to a human for review and further validation before taking action.

You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.

In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match.

By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter.

CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value.

The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE.

If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation.

If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error.

This is a stateless API operation. That is, data returned by this operation doesn't persist.

For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:CompareFaces action.

", "CreateCollection": "

Creates a collection in an AWS Region. You can add faces to the collection using the IndexFaces operation.

For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container.

When you create a collection, it is associated with the latest version of the face model version.

Collection names are case-sensitive.

This operation requires permissions to perform the rekognition:CreateCollection action. If you want to tag your collection, you also require permission to perform the rekognition:TagResource operation.

", "CreateDataset": "

Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.

To create a training dataset for a project, specify train for the value of DatasetType. To create the test dataset for a project, specify test for the value of DatasetType.

The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset. Creating a dataset takes a while to complete. Use DescribeDataset to check the current status. The dataset created successfully if the value of Status is CREATE_COMPLETE.

To check if any non-terminal errors occurred, call ListDatasetEntries and check for the presence of errors lists in the JSON Lines.

Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). Currently, you can't access the terminal error information.

For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide.

This operation requires permissions to perform the rekognition:CreateDataset action. If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.

", "CreateProject": "

Creates a new Amazon Rekognition Custom Labels project. A project is a group of resources (datasets, model versions) that you use to create and manage Amazon Rekognition Custom Labels models.

This operation requires permissions to perform the rekognition:CreateProject action.

", "CreateProjectVersion": "

Creates a new version of a model and begins training. Models are managed as part of an Amazon Rekognition Custom Labels project. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the version of the model.

Training uses the training and test datasets associated with the project. For more information, see Creating training and test dataset in the Amazon Rekognition Custom Labels Developer Guide.

You can train a modelin a project that doesn't have associated datasets by specifying manifest files in the TrainingData and TestingData fields.

If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates the datasets for you using the most recent manifest files. You can no longer train a model version for the project by specifying manifest files.

Instead of training with a project without associated datasets, we recommend that you use the manifest files to create training and test datasets for the project.

Training takes a while to complete. You can get the current status by calling DescribeProjectVersions. Training completed successfully if the value of the Status field is TRAINING_COMPLETED.

If training fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer guide.

Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels developers guide.

After evaluating the model, you start the model by calling StartProjectVersion.

This operation requires permissions to perform the rekognition:CreateProjectVersion action.

", - "CreateStreamProcessor": "

Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.

Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.

You provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the face recognition criteria in Settings. For example, the collection containing faces that you want to recognize. Use Name to assign an identifier for the stream processor. You use Name to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with the Name field.

After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing. You can delete the stream processor by calling DeleteStreamProcessor.

This operation requires permissions to perform the rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource operation.

", - "DeleteCollection": "

Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see delete-collection-procedure.

This operation requires permissions to perform the rekognition:DeleteCollection action.

", + "CreateStreamProcessor": "

Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.

Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.

Use Name to assign an identifier for the stream processor. You use Name to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with the Name field.

This operation requires permissions to perform the rekognition:CreateStreamProcessor action. If you want to tag your stream processor, you also require permission to perform the rekognition:TagResource operation.

", + "DeleteCollection": "

Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see Deleting a collection.

This operation requires permissions to perform the rekognition:DeleteCollection action.

", "DeleteDataset": "

Deletes an existing Amazon Rekognition Custom Labels dataset. Deleting a dataset might take while. Use DescribeDataset to check the current status. The dataset is still deleting if the value of Status is DELETE_IN_PROGRESS. If you try to access the dataset after it is deleted, you get a ResourceNotFoundException exception.

You can't delete a dataset while it is creating (Status = CREATE_IN_PROGRESS) or if the dataset is updating (Status = UPDATE_IN_PROGRESS).

This operation requires permissions to perform the rekognition:DeleteDataset action.

", "DeleteFaces": "

Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.

This operation requires permissions to perform the rekognition:DeleteFaces action.

", "DeleteProject": "

Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated with the project. To delete a model, see DeleteProjectVersion.

DeleteProject is an asynchronous operation. To check if the project is deleted, call DescribeProjects. The project is deleted when the project no longer appears in the response.

This operation requires permissions to perform the rekognition:DeleteProject action.

", @@ -21,45 +21,46 @@ "DescribeStreamProcessor": "

Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.

", "DetectCustomLabels": "

Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.

You specify which version of a model version to use by using the ProjectVersionArn input parameter.

You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

For each object that the model version detects on an image, the API returns a (CustomLabel) object in an array (CustomLabels). Each CustomLabel object provides the label name (Name), the level of confidence that the image contains the object (Confidence), and object location information, if it exists, for the label on the image (Geometry).

To filter labels that are returned, specify a value for MinConfidence. DetectCustomLabelsLabels only returns labels with a confidence that's higher than the specified value. The value of MinConfidence maps to the assumed threshold values created during training. For more information, see Assumed threshold in the Amazon Rekognition Custom Labels Developer Guide. Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence responses from DetectCustomLabels are also returned as a percentage. You can use MinConfidence to change the precision and recall or your model. For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

If you don't specify a value for MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each label.

This is a stateless API operation. That is, the operation does not persist any data.

This operation requires permissions to perform the rekognition:DetectCustomLabels action.

For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

", "DetectFaces": "

Detects faces within an image that is provided as input.

DetectFaces detects the 100 largest faces in the image. For each face detected, the operation returns face details. These details include a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), presence of beard, sunglasses, and so on.

The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence.

You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

This is a stateless API operation. That is, the operation does not persist any data.

This operation requires permissions to perform the rekognition:DetectFaces action.

", - "DetectLabels": "

Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.

For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.

DetectLabels does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.

You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object.

{Name: lighthouse, Confidence: 98.4629}

{Name: rock,Confidence: 79.2097}

{Name: sea,Confidence: 75.061}

In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.

{Name: flower,Confidence: 99.0562}

{Name: plant,Confidence: 99.0562}

{Name: tulip,Confidence: 99.0562}

In this example, the detection algorithm more precisely identifies the flower as a tulip.

In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 55%. You can also add the MaxLabels parameter to limit the number of labels returned.

If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides.

DetectLabels returns bounding boxes for instances of common object labels in an array of Instance objects. An Instance object contains a BoundingBox object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected.

DetectLabels also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.

This is a stateless API operation. That is, the operation does not persist any data.

This operation requires permissions to perform the rekognition:DetectLabels action.

", + "DetectLabels": "

Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.

For an example, see Analyzing images stored in an Amazon S3 bucket in the Amazon Rekognition Developer Guide.

DetectLabels does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.

You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object.

{Name: lighthouse, Confidence: 98.4629}

{Name: rock,Confidence: 79.2097}

{Name: sea,Confidence: 75.061}

In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.

{Name: flower,Confidence: 99.0562}

{Name: plant,Confidence: 99.0562}

{Name: tulip,Confidence: 99.0562}

In this example, the detection algorithm more precisely identifies the flower as a tulip.

In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 55%. You can also add the MaxLabels parameter to limit the number of labels returned.

If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides.

DetectLabels returns bounding boxes for instances of common object labels in an array of Instance objects. An Instance object contains a BoundingBox object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected.

DetectLabels also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.

This is a stateless API operation. That is, the operation does not persist any data.

This operation requires permissions to perform the rekognition:DetectLabels action.

", "DetectModerationLabels": "

Detects unsafe content in a specified JPEG or PNG format image. Use DetectModerationLabels to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content.

To filter images, use the labels returned by DetectModerationLabels to determine which types of content are appropriate.

For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.

You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

", "DetectProtectiveEquipment": "

Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the following types of PPE.

You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. The image must be either a PNG or JPG formatted file.

DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image.

For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand). For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE covers the body part. The API returns the confidence it has in each detection (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox) for each detected person and each detected item of PPE.

You can optionally request a summary of detected PPE items with the SummarizationAttributes input parameter. The summary provides the following information.

This is a stateless API operation. That is, the operation does not persist any data.

This operation requires permissions to perform the rekognition:DetectProtectiveEquipment action.

", - "DetectText": "

Detects text in the input image and converts it into machine-readable text.

Pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not supported. The image must be either a .png or .jpeg formatted file.

The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each TextDetection element provides information about a single word or line of text that was detected in the image.

A word is one or more script characters that are not separated by spaces. DetectText can detect up to 100 words in an image.

A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when there is a large gap between words, relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't represent the end of a line. If a sentence spans multiple lines, the DetectText operation returns multiple lines.

To determine whether a TextDetection element is a line of text or a word, use the TextDetection object Type field.

To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.

For more information, see DetectText in the Amazon Rekognition Developer Guide.

", + "DetectText": "

Detects text in the input image and converts it into machine-readable text.

Pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not supported. The image must be either a .png or .jpeg formatted file.

The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each TextDetection element provides information about a single word or line of text that was detected in the image.

A word is one or more script characters that are not separated by spaces. DetectText can detect up to 100 words in an image.

A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when there is a large gap between words, relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't represent the end of a line. If a sentence spans multiple lines, the DetectText operation returns multiple lines.

To determine whether a TextDetection element is a line of text or a word, use the TextDetection object Type field.

To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.

For more information, see Detecting text in the Amazon Rekognition Developer Guide.

", "DistributeDatasetEntries": "

Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project. DistributeDatasetEntries moves 20% of the training dataset images to the test dataset. An entry is a JSON Line that describes an image.

You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. The training dataset must contain the images that you want to split. The test dataset must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.

Distributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. If the dataset split fails, the value of Status is UPDATE_FAILED.

This operation requires permissions to perform the rekognition:DistributeDatasetEntries action.

", - "GetCelebrityInfo": "

Gets the name and additional information about a celebrity based on their Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty.

For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:GetCelebrityInfo action.

", + "GetCelebrityInfo": "

Gets the name and additional information about a celebrity based on their Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty.

For more information, see Getting information about a celebrity in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:GetCelebrityInfo action.

", "GetCelebrityRecognition": "

Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition.

Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId).

When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityDetection and pass the job identifier (JobId) from the initial call to StartCelebrityDetection.

For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.

GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array (Celebrities) of CelebrityRecognition objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail object and the time, Timestamp, the celebrity was detected. This CelebrityDetail object stores information about the detected celebrity's face attributes, a face bounding box, known gender, the celebrity's name, and a confidence estimate.

GetCelebrityRecognition only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The BoundingBox field only applies to the detected face instance. The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

By default, the Celebrities array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter.

The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer.

No information is returned for faces not recognized as celebrities.

Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection and populate the NextToken request parameter with the token value returned from the previous call to GetCelebrityRecognition.

", - "GetContentModeration": "

Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.

Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling StartContentModeration which returns a job identifier (JobId). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration. To get the results of the content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide.

GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels, and the time they are detected, in an array, ModerationLabels, of ContentModerationDetection objects.

By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME for the SortBy input parameter.

Since video analysis can return a large number of results, use the MaxResults parameter to limit the number of labels returned in a single call to GetContentModeration. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetContentModeration and populate the NextToken request parameter with the value of NextToken returned from the previous call to GetContentModeration.

For more information, see Content moderation in the Amazon Rekognition Developer Guide.

", + "GetContentModeration": "

Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.

Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling StartContentModeration which returns a job identifier (JobId). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration. To get the results of the content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide.

GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels, and the time they are detected, in an array, ModerationLabels, of ContentModerationDetection objects.

By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME for the SortBy input parameter.

Since video analysis can return a large number of results, use the MaxResults parameter to limit the number of labels returned in a single call to GetContentModeration. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetContentModeration and populate the NextToken request parameter with the value of NextToken returned from the previous call to GetContentModeration.

For more information, see moderating content in the Amazon Rekognition Developer Guide.

", "GetFaceDetection": "

Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.

Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling StartFaceDetection which returns a job identifier (JobId). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection.

GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected.

Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetFaceDetection and populate the NextToken request parameter with the token value returned from the previous call to GetFaceDetection.

", "GetFaceSearch": "

Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video.

Face search in a video is an asynchronous operation. You start face search by calling to StartFaceSearch which returns a job identifier (JobId). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch.

For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

The search results are retured in an array, Persons, of PersonMatch objects. EachPersonMatch element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.

GetFaceSearch only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

By default, the Persons array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX for the SORTBY input parameter.

", "GetLabelDetection": "

Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.

The label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection.

GetLabelDetection returns an array of detected labels (Labels) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME for the SortBy input parameter.

The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video.

The returned labels also include bounding box information for common objects, a hierarchical taxonomy of detected labels, and the version of the label model used for detection.

Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetlabelDetection and populate the NextToken request parameter with the token value returned from the previous call to GetLabelDetection.

", "GetPersonTracking": "

Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.

The person path tracking operation is started by a call to StartPersonTracking which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking.

To get the results of the person path tracking operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking.

GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their paths were tracked in the video.

GetPersonTracking only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned.

For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

By default, the array is sorted by the time(s) a person's path is tracked in the video. You can sort by tracked persons by specifying INDEX for the SortBy input parameter.

Use the MaxResults parameter to limit the number of items returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token value returned from the previous call to GetPersonTracking.

", - "GetSegmentDetection": "

Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by calling StartSegmentDetection which returns a job identifier (JobId). When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartSegmentDetection. To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call of StartSegmentDetection.

GetSegmentDetection returns detected segments in an array (Segments) of SegmentDetection objects. Segments is sorted by the segment types specified in the SegmentTypes input parameter of StartSegmentDetection. Each element of the array includes the detected segment, the precentage confidence in the acuracy of the detected segment, the type of the segment, and the frame in which the segment was detected.

Use SelectedSegmentTypes to find out the type of segment detection requested in the call to StartSegmentDetection.

Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection and populate the NextToken request parameter with the token value returned from the previous call to GetSegmentDetection.

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

", + "GetSegmentDetection": "

Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by calling StartSegmentDetection which returns a job identifier (JobId). When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartSegmentDetection. To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call of StartSegmentDetection.

GetSegmentDetection returns detected segments in an array (Segments) of SegmentDetection objects. Segments is sorted by the segment types specified in the SegmentTypes input parameter of StartSegmentDetection. Each element of the array includes the detected segment, the precentage confidence in the acuracy of the detected segment, the type of the segment, and the frame in which the segment was detected.

Use SelectedSegmentTypes to find out the type of segment detection requested in the call to StartSegmentDetection.

Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection and populate the NextToken request parameter with the token value returned from the previous call to GetSegmentDetection.

For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.

", "GetTextDetection": "

Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.

Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by calling StartTextDetection which returns a job identifier (JobId) When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartTextDetection. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call of StartLabelDetection.

GetTextDetection returns an array of detected text (TextDetections) sorted by the time the text was detected, up to 50 words per frame of video.

Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected text, the time the text was detected, bounding box information for where the text was located, and unique identifiers for words and their lines.

Use MaxResults parameter to limit the number of text detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetTextDetection and populate the NextToken request parameter with the token value returned from the previous call to GetTextDetection.

", - "IndexFaces": "

Detects faces in the input image and adds them to the specified collection.

Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the SearchFaces and SearchFacesByImage operations.

For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide.

To get the number of faces in a collection, call DescribeCollection.

If you're using version 1.0 of the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image.

If you're using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection field.

To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response from IndexFaces

For more information, see Model Versioning in the Amazon Rekognition Developer Guide.

If you provide the optional ExternalImageId for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.

You can specify the maximum number of faces to index with the MaxFaces input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background.

The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. By default, IndexFaces chooses the quality bar that's used to filter faces. You can also explicitly choose the quality bar. Use QualityFilter, to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE.

To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

Information about faces detected in an image, but not indexed, is returned in an array of UnindexedFace objects, UnindexedFaces. Faces aren't indexed for reasons such as:

In response, the IndexFaces operation returns an array of metadata for all detected faces, FaceRecords. This includes:

If you request all facial attributes (by using the detectionAttributes parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes. If you provide the same image, specify the same collection, use the same external ID, and use the same model version in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

The input image is passed either as base64-encoded image bytes, or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.

This operation requires permissions to perform the rekognition:IndexFaces action.

", - "ListCollections": "

Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

For an example, see Listing Collections in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:ListCollections action.

", + "IndexFaces": "

Detects faces in the input image and adds them to the specified collection.

Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the SearchFaces and SearchFacesByImage operations.

For more information, see Adding faces to a collection in the Amazon Rekognition Developer Guide.

To get the number of faces in a collection, call DescribeCollection.

If you're using version 1.0 of the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image.

If you're using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection field.

To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response from IndexFaces

For more information, see Model Versioning in the Amazon Rekognition Developer Guide.

If you provide the optional ExternalImageId for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.

You can specify the maximum number of faces to index with the MaxFaces input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background.

The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. By default, IndexFaces chooses the quality bar that's used to filter faces. You can also explicitly choose the quality bar. Use QualityFilter, to set the quality bar by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE.

To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

Information about faces detected in an image, but not indexed, is returned in an array of UnindexedFace objects, UnindexedFaces. Faces aren't indexed for reasons such as:

In response, the IndexFaces operation returns an array of metadata for all detected faces, FaceRecords. This includes:

If you request all facial attributes (by using the detectionAttributes parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

The input image is passed either as base64-encoded image bytes, or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.

This operation requires permissions to perform the rekognition:IndexFaces action.

", + "ListCollections": "

Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

For an example, see Listing collections in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:ListCollections action.

", "ListDatasetEntries": "

Lists the entries (images) within a dataset. An entry is a JSON Line that contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Creating a manifest file.

JSON Lines in the response include information about non-terminal errors found in the dataset. Non terminal errors are reported in errors lists within each JSON Line. The same information is reported in the training and testing validation result manifests that Amazon Rekognition Custom Labels creates during model training.

You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.

This operation requires permissions to perform the rekognition:ListDatasetEntries action.

", "ListDatasetLabels": "

Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images.

Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images in the Amazon Rekognition Custom Labels Developer Guide.

", "ListFaces": "

Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:ListFaces action.

", "ListStreamProcessors": "

Gets a list of stream processors that you have created with CreateStreamProcessor.

", "ListTagsForResource": "

Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.

This operation requires permissions to perform the rekognition:ListTagsForResource action.

", - "RecognizeCelebrities": "

Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.

RecognizeCelebrities returns the 64 largest faces in the image. It lists the recognized celebrities in the CelebrityFaces array and any unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 64 faces in the image.

For each celebrity recognized, RecognizeCelebrities returns a Celebrity object. The Celebrity object contains the celebrity name, ID, URL links to additional information, match confidence, and a ComparedFace object that you can use to locate the celebrity's face on the image.

Amazon Rekognition doesn't retain information about which images a celebrity has been recognized in. Your application must store this information and use the Celebrity ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by RecognizeCelebrities, you will need the ID to identify the celebrity in a call to the GetCelebrityInfo operation.

You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:RecognizeCelebrities operation.

", - "SearchFaces": "

For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.

You can also search faces without indexing faces by using the SearchFacesByImage operation.

The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face.

For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:SearchFaces action.

", + "RecognizeCelebrities": "

Returns an array of celebrities recognized in the input image. For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.

RecognizeCelebrities returns the 64 largest faces in the image. It lists the recognized celebrities in the CelebrityFaces array and any unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 64 faces in the image.

For each celebrity recognized, RecognizeCelebrities returns a Celebrity object. The Celebrity object contains the celebrity name, ID, URL links to additional information, match confidence, and a ComparedFace object that you can use to locate the celebrity's face on the image.

Amazon Rekognition doesn't retain information about which images a celebrity has been recognized in. Your application must store this information and use the Celebrity ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by RecognizeCelebrities, you will need the ID to identify the celebrity in a call to the GetCelebrityInfo operation.

You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

For an example, see Recognizing celebrities in an image in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:RecognizeCelebrities operation.

", + "SearchFaces": "

For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.

You can also search faces without indexing faces by using the SearchFacesByImage operation.

The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face.

For an example, see Searching for a face using its face ID in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:SearchFaces action.

", "SearchFacesByImage": "

For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.

To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation.

You can also call the DetectFaces operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage operation.

You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image.

If no faces are detected in the input image, SearchFacesByImage returns an InvalidParameterException error.

For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.

The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar for filtering by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE.

To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

This operation requires permissions to perform the rekognition:SearchFacesByImage action.

", - "StartCelebrityRecognition": "

Starts asynchronous recognition of celebrities in a stored video.

Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition returns a job identifier (JobId) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier (JobId) from the initial call to StartCelebrityRecognition.

For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.

", - "StartContentModeration": "

Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.

Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartContentModeration returns a job identifier (JobId) which you use to get the results of the analysis. When content analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

For more information, see Content moderation in the Amazon Rekognition Developer Guide.

", - "StartFaceDetection": "

Starts asynchronous detection of faces in a stored video.

Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection returns a job identifier (JobId) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection.

For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide.

", - "StartFaceSearch": "

Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see procedure-person-search-videos.

", + "StartCelebrityRecognition": "

Starts asynchronous recognition of celebrities in a stored video.

Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition returns a job identifier (JobId) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier (JobId) from the initial call to StartCelebrityRecognition.

For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.

", + "StartContentModeration": "

Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.

Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartContentModeration returns a job identifier (JobId) which you use to get the results of the analysis. When content analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

For more information, see Moderating content in the Amazon Rekognition Developer Guide.

", + "StartFaceDetection": "

Starts asynchronous detection of faces in a stored video.

Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection returns a job identifier (JobId) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection.

For more information, see Detecting faces in a stored video in the Amazon Rekognition Developer Guide.

", + "StartFaceSearch": "

Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see Searching stored videos for faces.

", "StartLabelDetection": "

Starts asynchronous detection of labels in a stored video.

Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartLabelDetection returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection.

", "StartPersonTracking": "

Starts the asynchronous tracking of a person's path in a stored video.

Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartPersonTracking returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking.

", "StartProjectVersion": "

Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions.

Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels.

You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion.

This operation requires permissions to perform the rekognition:StartProjectVersion action.

", - "StartSegmentDetection": "

Starts asynchronous detection of segment detection in a stored video.

Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

You can use the Filters (StartSegmentDetectionFilters) input parameter to specify the minimum detection confidence returned in the response. Within Filters, use ShotFilter (StartShotDetectionFilter) to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter) to filter technical cues.

To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call to StartSegmentDetection.

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

", - "StartStreamProcessor": "

Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor.

", + "StartSegmentDetection": "

Starts asynchronous detection of segment detection in a stored video.

Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

You can use the Filters (StartSegmentDetectionFilters) input parameter to specify the minimum detection confidence returned in the response. Within Filters, use ShotFilter (StartShotDetectionFilter) to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter) to filter technical cues.

To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call to StartSegmentDetection.

For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.

", + "StartStreamProcessor": "

Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor.

If you are using a label detection stream processor to detect labels, you need to provide a Start selector and a Stop selector to determine the length of the stream processing time.

", "StartTextDetection": "

Starts asynchronous detection of text in a stored video.

Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartTextDetection returns a job identifier (JobId) which you use to get the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetTextDetection and pass the job identifier (JobId) from the initial call to StartTextDetection.

", "StopProjectVersion": "

Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions.

", "StopStreamProcessor": "

Stops a running stream processor that was created by CreateStreamProcessor.

", "TagResource": "

Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model. For more information, see Tagging AWS Resources.

This operation requires permissions to perform the rekognition:TagResource action.

", "UntagResource": "

Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.

This operation requires permissions to perform the rekognition:UntagResource action.

", - "UpdateDatasetEntries": "

Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.

If the source-ref field in the JSON line references an existing image, the existing image in the dataset is updated. If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.

You specify the changes that you want to make in the Changes input parameter. There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less than 5MB.

UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete. Use DescribeDataset to check the current status. The dataset updated successfully if the value of Status is UPDATE_COMPLETE.

To check if any non-terminal errors occured, call ListDatasetEntries and check for the presence of errors lists in the JSON Lines.

Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.

This operation requires permissions to perform the rekognition:UpdateDatasetEntries action.

" + "UpdateDatasetEntries": "

Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the information for a single image, including the image location, assigned labels, and object location bounding boxes. For more information, see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.

If the source-ref field in the JSON line references an existing image, the existing image in the dataset is updated. If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.

You specify the changes that you want to make in the Changes input parameter. There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less than 5MB.

UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete. Use DescribeDataset to check the current status. The dataset updated successfully if the value of Status is UPDATE_COMPLETE.

To check if any non-terminal errors occured, call ListDatasetEntries and check for the presence of errors lists in the JSON Lines.

Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.

This operation requires permissions to perform the rekognition:UpdateDatasetEntries action.

", + "UpdateStreamProcessor": "

Allows you to update a stream processor. You can change some settings and regions of interest and delete certain parameters.

" }, "shapes": { "AccessDeniedException": { @@ -146,12 +147,13 @@ "MouthOpen$Value": "

Boolean value that indicates whether the mouth on the face is open or not.

", "Mustache$Value": "

Boolean value that indicates whether the face has mustache or not.

", "Smile$Value": "

Boolean value that indicates whether the face is smiling or not.

", + "StreamProcessorDataSharingPreference$OptIn": "

If this option is set to true, you choose to share data with Rekognition to improve model performance.

", "Sunglasses$Value": "

Boolean value that indicates whether the face is wearing sunglasses or not.

", "TestingData$AutoCreate": "

If specified, Amazon Rekognition Custom Labels temporarily splits the training dataset (80%) to create a test dataset (20%) for the training job. After training completes, the test dataset is not stored and the training dataset reverts to its previous size.

" } }, "BoundingBox": { - "base": "

Identifies the bounding box around the label, face, text or personal protective equipment. The left (x-coordinate) and top (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

The top and left values returned are ratios of the overall image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of the bounding box is 350x50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200).

The width and height values represent the dimensions of the bounding box as a ratio of the overall image dimension. For example, if the input image is 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

The bounding box coordinates can have negative values. For example, if Amazon Rekognition is able to detect a face that is at the image edge and is only partially visible, the service can return coordinates that are outside the image bounds and, depending on the image edge, you might get negative values or values greater than 1 for the left or top values.

", + "base": "

Identifies the bounding box around the label, face, text, object of interest, or personal protective equipment. The left (x-coordinate) and top (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

The top and left values returned are ratios of the overall image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of the bounding box is 350x50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200).

The width and height values represent the dimensions of the bounding box as a ratio of the overall image dimension. For example, if the input image is 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

The bounding box coordinates can have negative values. For example, if Amazon Rekognition is able to detect a face that is at the image edge and is only partially visible, the service can return coordinates that are outside the image bounds and, depending on the image edge, you might get negative values or values greater than 1 for the left or top values.

", "refs": { "CelebrityDetail$BoundingBox": "

Bounding box around the body of a celebrity.

", "ComparedFace$BoundingBox": "

Bounding box of the face.

", @@ -299,6 +301,31 @@ "CompareFacesResponse$SourceImageFace": "

The face in the source image that was used for comparison.

" } }, + "ConnectedHomeLabel": { + "base": null, + "refs": { + "ConnectedHomeLabels$member": null + } + }, + "ConnectedHomeLabels": { + "base": null, + "refs": { + "ConnectedHomeSettings$Labels": "

Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: \"PERSON\", \"PET\", \"PACKAGE\", and \"ALL\".

", + "ConnectedHomeSettingsForUpdate$Labels": "

Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: \"PERSON\", \"PET\", \"PACKAGE\", and \"ALL\".

" + } + }, + "ConnectedHomeSettings": { + "base": "

Label detection settings to use on a streaming video. Defining the settings is required in the request parameter for CreateStreamProcessor. Including this setting in the CreateStreamProcessor request enables you to use the stream processor for label detection. You can then select what you want the stream processor to detect, such as people or pets. When the stream processor has started, one notification is sent for each object class specified. For example, if packages and pets are selected, one SNS notification is published the first time a package is detected and one SNS notification is published the first time a pet is detected, as well as an end-of-session summary.

", + "refs": { + "StreamProcessorSettings$ConnectedHome": null + } + }, + "ConnectedHomeSettingsForUpdate": { + "base": "

The label detection settings you want to use in your stream processor. This includes the labels you want the stream processor to detect and the minimum confidence level allowed to label objects.

", + "refs": { + "StreamProcessorSettingsForUpdate$ConnectedHomeForUpdate": "

The label detection settings you want to use for your stream processor.

" + } + }, "ContentClassifier": { "base": null, "refs": { @@ -889,7 +916,7 @@ "FaceModelVersionList": { "base": null, "refs": { - "ListCollectionsResponse$FaceModelVersions": "

Latest face models being used with the corresponding collections in the array. For more information, see Model versioning. For example, the value of FaceModelVersions[2] is the version number for the face detection model used by the collection in CollectionId[2].

" + "ListCollectionsResponse$FaceModelVersions": "

Version numbers of the face detection models associated with the collections in the array CollectionIds. For example, the value of FaceModelVersions[2] is the version number for the face detection model used by the collection in CollectionId[2].

" } }, "FaceRecord": { @@ -905,7 +932,7 @@ } }, "FaceSearchSettings": { - "base": "

Input face recognition parameters for an Amazon Rekognition stream processor. FaceRecognitionSettings is a request parameter for CreateStreamProcessor.

", + "base": "

Input face recognition parameters for an Amazon Rekognition stream processor. Includes the collection to use for face recognition and the face attributes to detect. Defining the settings is required in the request parameter for CreateStreamProcessor.

", "refs": { "StreamProcessorSettings$FaceSearch": "

Face search settings to use on a streaming video.

" } @@ -940,7 +967,7 @@ } }, "Gender": { - "base": "

The predicted gender of a detected face.

Amazon Rekognition makes gender binary (male/female) predictions based on the physical appearance of a face in a particular image. This kind of prediction is not designed to categorize a person’s gender identity, and you shouldn't use Amazon Rekognition to make such a determination. For example, a male actor wearing a long-haired wig and earrings for a role might be predicted as female.

Using Amazon Rekognition to make gender binary predictions is best suited for use cases where aggregate gender distribution statistics need to be analyzed without identifying specific users. For example, the percentage of female users compared to male users on a social media platform.

We don't recommend using gender binary predictions to make decisions that impact
 an individual's rights, privacy, or access to services.

", + "base": "

The predicted gender of a detected face.

Amazon Rekognition makes gender binary (male/female) predictions based on the physical appearance of a face in a particular image. This kind of prediction is not designed to categorize a person’s gender identity, and you shouldn't use Amazon Rekognition to make such a determination. For example, a male actor wearing a long-haired wig and earrings for a role might be predicted as female.

Using Amazon Rekognition to make gender binary predictions is best suited for use cases where aggregate gender distribution statistics need to be analyzed without identifying specific users. For example, the percentage of female users compared to male users on a social media platform.

We don't recommend using gender binary predictions to make decisions that impact an individual's rights, privacy, or access to services.

", "refs": { "FaceDetail$Gender": "

The predicted gender of a detected face.

" } @@ -1127,7 +1154,7 @@ } }, "Image": { - "base": "

Provides the input image either as bytes or an S3 object.

You pass image bytes to an Amazon Rekognition API operation by using the Bytes property. For example, you would use the Bytes property to pass an image loaded from a local file system. Image bytes passed by using the Bytes property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.

For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.

You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded.

The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.

", + "base": "

Provides the input image either as bytes or an S3 object.

You pass image bytes to an Amazon Rekognition API operation by using the Bytes property. For example, you would use the Bytes property to pass an image loaded from a local file system. Image bytes passed by using the Bytes property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.

For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.

You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded.

The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

", "refs": { "CompareFacesRequest$SourceImage": "

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

", "CompareFacesRequest$TargetImage": "

The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

", @@ -1162,7 +1189,7 @@ } }, "ImageTooLargeException": { - "base": "

The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

", + "base": "

The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

", "refs": { } }, @@ -1290,10 +1317,24 @@ "StreamProcessorInput$KinesisVideoStream": "

The Kinesis video stream input stream for the source streaming video.

" } }, + "KinesisVideoStreamFragmentNumber": { + "base": null, + "refs": { + "KinesisVideoStreamStartSelector$FragmentNumber": "

The unique identifier of the fragment. This value monotonically increases based on the ingestion order.

" + } + }, + "KinesisVideoStreamStartSelector": { + "base": "

Specifies the starting point in a Kinesis stream to start processing. You can use the producer timestamp or the fragment number. For more information, see Fragment.

", + "refs": { + "StreamProcessingStartSelector$KVSStreamStartSelector": "

Specifies the starting point in the stream to start processing. This can be done with a timestamp or a fragment number in a Kinesis stream.

" + } + }, "KmsKeyId": { "base": null, "refs": { "CreateProjectVersionRequest$KmsKeyId": "

The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket (OutputConfig).

If you choose to use your own KMS key, you need the following permissions on the KMS key.

If you don't specify a value for KmsKeyId, images copied into the service are encrypted using a key that AWS owns and manages.

", + "CreateStreamProcessorRequest$KmsKeyId": "

The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor. You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt results and data published to your Amazon S3 bucket, which includes image frames and hero images. Your source images are unaffected.

", + "DescribeStreamProcessorResponse$KmsKeyId": "

The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors.

", "ProjectVersionDescription$KmsKeyId": "

The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training.

" } }, @@ -1438,6 +1479,12 @@ "refs": { } }, + "MaxDurationInSecondsULong": { + "base": null, + "refs": { + "StreamProcessingStopSelector$MaxDurationInSeconds": "

Specifies the maximum amount of time in seconds that you want the stream to be processed. The largest amount of time is 2 minutes. The default is 10 seconds.

" + } + }, "MaxFaces": { "base": null, "refs": { @@ -1503,7 +1550,7 @@ } }, "NotificationChannel": { - "base": "

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic. For more information, see Giving access to multiple Amazon SNS topics.

", + "base": "

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see Calling Amazon Rekognition Video operations. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic. For more information, see Giving access to multiple Amazon SNS topics.

", "refs": { "StartCelebrityRecognitionRequest$NotificationChannel": "

The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

", "StartContentModerationRequest$NotificationChannel": "

The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the content analysis to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

", @@ -1588,12 +1635,14 @@ "CompareFacesRequest$SimilarityThreshold": "

The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.

", "ComparedFace$Confidence": "

Level of confidence that what the bounding box contains is a face.

", "ComparedSourceImageFace$Confidence": "

Confidence level that the selected bounding box contains a face.

", + "ConnectedHomeSettings$MinConfidence": "

The minimum confidence required to label an object in the video.

", + "ConnectedHomeSettingsForUpdate$MinConfidence": "

The minimum confidence required to label an object in the video.

", "CoversBodyPart$Confidence": "

The confidence that Amazon Rekognition has in the value of Value.

", "CustomLabel$Confidence": "

The confidence that the model has in the detection of the custom label. The range is 0-100. A higher value indicates a higher confidence.

", "DetectCustomLabelsRequest$MinConfidence": "

Specifies the minimum confidence level for the labels to return. DetectCustomLabels doesn't return any labels with a confidence value that's lower than this specified value. If you specify a value of 0, DetectCustomLabels returns all labels, regardless of the assumed threshold applied to each label. If you don't specify a value for MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each label.

", "DetectLabelsRequest$MinConfidence": "

Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.

If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.

", "DetectModerationLabelsRequest$MinConfidence": "

Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value.

If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

", - "DetectionFilter$MinConfidence": "

Sets the confidence of word detection. Words with detection confidence below this will be excluded from the result. Values should be between 50 and 100 as Text in Video will not return any result below 50.

", + "DetectionFilter$MinConfidence": "

Sets the confidence of word detection. Words with detection confidence below this will be excluded from the result. Values should be between 0 and 100. The default MinConfidence is 80.

", "Emotion$Confidence": "

Level of confidence in the determination.

", "EquipmentDetection$Confidence": "

The confidence that Amazon Rekognition has that the bounding box (BoundingBox) contains an item of PPE.

", "EyeOpen$Confidence": "

Level of confidence in the determination.

", @@ -1666,7 +1715,7 @@ } }, "Point": { - "base": "

The X and Y coordinates of a point on an image. The X and Y values returned are ratios of the overall image size. For example, if the input image is 700x200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image.

An array of Point objects, Polygon, is returned by DetectText and by DetectCustomLabels. Polygon represents a fine-grained polygon around a detected item. For more information, see Geometry in the Amazon Rekognition Developer Guide.

", + "base": "

The X and Y coordinates of a point on an image or video frame. The X and Y values are ratios of the overall image size or video resolution. For example, if an input image is 700x200 and the values are X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image.

An array of Point objects makes up a Polygon. A Polygon is returned by DetectText and by DetectCustomLabels Polygon represents a fine-grained polygon around a detected item. For more information, see Geometry in the Amazon Rekognition Developer Guide.

", "refs": { "Polygon$member": null } @@ -1674,7 +1723,8 @@ "Polygon": { "base": null, "refs": { - "Geometry$Polygon": "

Within the bounding box, a fine-grained polygon around the detected item.

" + "Geometry$Polygon": "

Within the bounding box, a fine-grained polygon around the detected item.

", + "RegionOfInterest$Polygon": "

Specifies a shape made up of up to 10 Point objects to define a region of interest.

" } }, "Pose": { @@ -1864,7 +1914,7 @@ } }, "RegionOfInterest": { - "base": "

Specifies a location within the frame that Rekognition checks for text. Uses a BoundingBox object to set a region of the screen.

A word is included in the region if the word is more than half in that region. If there is more than one region, the word will be compared with all regions of the screen. Any word more than half in a region is kept in the results.

", + "base": "

Specifies a location within the frame that Rekognition checks for objects of interest such as text, labels, or faces. It uses a BoundingBox or object or Polygon to set a region of the screen.

A word, face, or label is included in the region if it is more than half in that region. If there is more than one region, the word, face, or label is compared with all regions of the screen. Any object of interest that is more than half in a region is kept in the results.

", "refs": { "RegionsOfInterest$member": null } @@ -1872,8 +1922,11 @@ "RegionsOfInterest": { "base": null, "refs": { + "CreateStreamProcessorRequest$RegionsOfInterest": "

Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.

", + "DescribeStreamProcessorResponse$RegionsOfInterest": "

Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.

", "DetectTextFilters$RegionsOfInterest": "

A Filter focusing on a certain area of the image. Uses a BoundingBox object to set the region of the image.

", - "StartTextDetectionFilters$RegionsOfInterest": "

Filter focusing on a certain area of the frame. Uses a BoundingBox object to set the region of the screen.

" + "StartTextDetectionFilters$RegionsOfInterest": "

Filter focusing on a certain area of the frame. Uses a BoundingBox object to set the region of the screen.

", + "UpdateStreamProcessorRequest$RegionsOfInterestForUpdate": "

Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.

" } }, "RekognitionUniqueId": { @@ -1915,7 +1968,7 @@ "RoleArn": { "base": null, "refs": { - "CreateStreamProcessorRequest$RoleArn": "

ARN of the IAM role that allows access to the stream processor.

", + "CreateStreamProcessorRequest$RoleArn": "

The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor. The IAM role provides Rekognition read permissions for a Kinesis stream. It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required for both face search and label detection stream processors.

", "DescribeStreamProcessorResponse$RoleArn": "

ARN of the IAM role that allows access to the stream processor.

", "NotificationChannel$RoleArn": "

The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.

" } @@ -1924,17 +1977,25 @@ "base": null, "refs": { "OutputConfig$S3Bucket": "

The S3 bucket where training output is placed.

", + "S3Destination$Bucket": "

The name of the Amazon S3 bucket you want to associate with the streaming video project. You must be the owner of the Amazon S3 bucket.

", "S3Object$Bucket": "

Name of the S3 bucket.

" } }, + "S3Destination": { + "base": "

The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation. These results include the name of the stream processor resource, the session ID of the stream processing session, and labeled timestamps and bounding boxes for detected labels.

", + "refs": { + "StreamProcessorOutput$S3Destination": "

The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.

" + } + }, "S3KeyPrefix": { "base": null, "refs": { - "OutputConfig$S3KeyPrefix": "

The prefix applied to the training output files.

" + "OutputConfig$S3KeyPrefix": "

The prefix applied to the training output files.

", + "S3Destination$KeyPrefix": "

The prefix value of the location within the bucket that you want the information to be published to. For more information, see Using prefixes.

" } }, "S3Object": { - "base": "

Provides the S3 bucket name and object name.

The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

", + "base": "

Provides the S3 bucket name and object name.

The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see How Amazon Rekognition works with IAM in the Amazon Rekognition Developer Guide.

", "refs": { "GroundTruthManifest$S3Object": null, "Image$S3Object": "

Identifies an S3 object as the image source.

", @@ -1957,7 +2018,8 @@ "SNSTopicArn": { "base": null, "refs": { - "NotificationChannel$SNSTopicArn": "

The Amazon SNS topic to which Amazon Rekognition to posts the completion status.

" + "NotificationChannel$SNSTopicArn": "

The Amazon SNS topic to which Amazon Rekognition posts the completion status.

", + "StreamProcessorNotificationChannel$SNSTopicArn": "

The Amazon Resource Number (ARN) of the Amazon Amazon Simple Notification Service topic to which Amazon Rekognition posts the completion status.

" } }, "SearchFacesByImageRequest": { @@ -2028,7 +2090,7 @@ } }, "ServiceQuotaExceededException": { - "base": "

The size of the collection exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

", + "base": "

The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.

", "refs": { } }, @@ -2147,6 +2209,12 @@ "refs": { } }, + "StartStreamProcessorSessionId": { + "base": null, + "refs": { + "StartStreamProcessorResponse$SessionId": "

A unique identifier for the stream processing session.

" + } + }, "StartTechnicalCueDetectionFilter": { "base": "

Filters for the technical segments returned by GetSegmentDetection. For more information, see StartSegmentDetectionFilters.

", "refs": { @@ -2205,8 +2273,20 @@ "refs": { } }, + "StreamProcessingStartSelector": { + "base": "

", + "refs": { + "StartStreamProcessorRequest$StartSelector": "

Specifies the starting point in the Kinesis stream to start processing. You can use the producer timestamp or the fragment number. For more information, see Fragment.

This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

" + } + }, + "StreamProcessingStopSelector": { + "base": "

Specifies when to stop processing the stream. You can specify a maximum amount of time to process the video.

", + "refs": { + "StartStreamProcessorRequest$StopSelector": "

Specifies when to stop processing the stream. You can specify a maximum amount of time to process the video.

This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.

" + } + }, "StreamProcessor": { - "base": "

An object that recognizes faces in a streaming video. An Amazon Rekognition stream processor is created by a call to CreateStreamProcessor. The request parameters for CreateStreamProcessor describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.

", + "base": "

An object that recognizes faces or labels in a streaming video. An Amazon Rekognition stream processor is created by a call to CreateStreamProcessor. The request parameters for CreateStreamProcessor describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.

", "refs": { "StreamProcessorList$member": null } @@ -2214,14 +2294,22 @@ "StreamProcessorArn": { "base": null, "refs": { - "CreateStreamProcessorResponse$StreamProcessorArn": "

ARN for the newly create stream processor.

", + "CreateStreamProcessorResponse$StreamProcessorArn": "

Amazon Resource Number for the newly created stream processor.

", "DescribeStreamProcessorResponse$StreamProcessorArn": "

ARN of the stream processor.

" } }, + "StreamProcessorDataSharingPreference": { + "base": "

Allows you to opt in or opt out to share data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.

", + "refs": { + "CreateStreamProcessorRequest$DataSharingPreference": "

Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.

", + "DescribeStreamProcessorResponse$DataSharingPreference": "

Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.

", + "UpdateStreamProcessorRequest$DataSharingPreferenceForUpdate": "

Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis. Note that if you opt out at the account level this setting is ignored on individual streams.

" + } + }, "StreamProcessorInput": { "base": "

Information about the source streaming video.

", "refs": { - "CreateStreamProcessorRequest$Input": "

Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput.

", + "CreateStreamProcessorRequest$Input": "

Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput. This is required for both face search and label detection stream processors.

", "DescribeStreamProcessorResponse$Input": "

Kinesis video stream that provides the source streaming video.

" } }, @@ -2234,27 +2322,53 @@ "StreamProcessorName": { "base": null, "refs": { - "CreateStreamProcessorRequest$Name": "

An identifier you assign to the stream processor. You can use Name to manage the stream processor. For example, you can get the current status of the stream processor by calling DescribeStreamProcessor. Name is idempotent.

", + "CreateStreamProcessorRequest$Name": "

An identifier you assign to the stream processor. You can use Name to manage the stream processor. For example, you can get the current status of the stream processor by calling DescribeStreamProcessor. Name is idempotent. This is required for both face search and label detection stream processors.

", "DeleteStreamProcessorRequest$Name": "

The name of the stream processor you want to delete.

", "DescribeStreamProcessorRequest$Name": "

Name of the stream processor for which you want information.

", "DescribeStreamProcessorResponse$Name": "

Name of the stream processor.

", "StartStreamProcessorRequest$Name": "

The name of the stream processor to start processing.

", "StopStreamProcessorRequest$Name": "

The name of a stream processor created by CreateStreamProcessor.

", - "StreamProcessor$Name": "

Name of the Amazon Rekognition stream processor.

" + "StreamProcessor$Name": "

Name of the Amazon Rekognition stream processor.

", + "UpdateStreamProcessorRequest$Name": "

Name of the stream processor that you want to update.

" + } + }, + "StreamProcessorNotificationChannel": { + "base": "

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.

Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications, one for a person at second 2 and one for a pet at second 4.

Amazon Rekognition also publishes an an end-of-session notification with a summary when the stream processing session is complete.

", + "refs": { + "CreateStreamProcessorRequest$NotificationChannel": null, + "DescribeStreamProcessorResponse$NotificationChannel": null } }, "StreamProcessorOutput": { "base": "

Information about the Amazon Kinesis Data Streams stream to which a Amazon Rekognition Video stream processor streams the results of a video analysis. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.

", "refs": { - "CreateStreamProcessorRequest$Output": "

Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput.

", + "CreateStreamProcessorRequest$Output": "

Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput. This must be a S3Destination of an Amazon S3 bucket that you own for a label detection stream processor or a Kinesis data stream ARN for a face search stream processor.

", "DescribeStreamProcessorResponse$Output": "

Kinesis data stream to which Amazon Rekognition Video puts the analysis results.

" } }, + "StreamProcessorParameterToDelete": { + "base": null, + "refs": { + "StreamProcessorParametersToDelete$member": null + } + }, + "StreamProcessorParametersToDelete": { + "base": null, + "refs": { + "UpdateStreamProcessorRequest$ParametersToDelete": "

A list of parameters you want to delete from the stream processor.

" + } + }, "StreamProcessorSettings": { - "base": "

Input parameters used to recognize faces in a streaming video analyzed by a Amazon Rekognition stream processor.

", + "base": "

Input parameters used in a streaming video analyzed by a Amazon Rekognition stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

", "refs": { - "CreateStreamProcessorRequest$Settings": "

Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.

", - "DescribeStreamProcessorResponse$Settings": "

Face recognition input parameters that are being used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.

" + "CreateStreamProcessorRequest$Settings": "

Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

", + "DescribeStreamProcessorResponse$Settings": "

Input parameters used in a streaming video analyzed by a stream processor. You can use FaceSearch to recognize faces in a streaming video, or you can use ConnectedHome to detect labels.

" + } + }, + "StreamProcessorSettingsForUpdate": { + "base": "

The stream processor settings that you want to update. ConnectedHome settings can be updated to detect different labels with a different minimum confidence.

", + "refs": { + "UpdateStreamProcessorRequest$SettingsForUpdate": "

The stream processor settings that you want to update. Label detection settings can be updated to detect different labels with a different minimum confidence.

" } }, "StreamProcessorStatus": { @@ -2271,9 +2385,9 @@ "Celebrity$Name": "

The name of the celebrity.

", "CelebrityDetail$Name": "

The name of the celebrity.

", "CreateCollectionResponse$CollectionArn": "

Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.

", - "CreateCollectionResponse$FaceModelVersion": "

Latest face model being used with the collection. For more information, see Model versioning.

", + "CreateCollectionResponse$FaceModelVersion": "

Version number of the face detection model associated with the collection you are creating.

", "CustomLabel$Name": "

The name of the custom label.

", - "DescribeCollectionResponse$FaceModelVersion": "

The version of the face model that's used by the collection for face detection.

For more information, see Model Versioning in the Amazon Rekognition Developer Guide.

", + "DescribeCollectionResponse$FaceModelVersion": "

The version of the face model that's used by the collection for face detection.

For more information, see Model versioning in the Amazon Rekognition Developer Guide.

", "DescribeCollectionResponse$CollectionARN": "

The Amazon Resource Name (ARN) of the collection.

", "DescribeStreamProcessorResponse$StatusMessage": "

Detailed status message about the stream processor.

", "DetectLabelsResponse$LabelModelVersion": "

Version number of the label detection model that was used to detect labels.

", @@ -2288,15 +2402,15 @@ "HumanLoopQuotaExceededException$ResourceType": "

The resource type.

", "HumanLoopQuotaExceededException$QuotaCode": "

The quota code.

", "HumanLoopQuotaExceededException$ServiceCode": "

The service code.

", - "IndexFacesResponse$FaceModelVersion": "

Latest face model being used with the collection. For more information, see Model versioning.

", + "IndexFacesResponse$FaceModelVersion": "

The version number of the face detection model that's associated with the input collection (CollectionId).

", "Label$Name": "

The name (label) of the object or scene.

", "ListFacesResponse$NextToken": "

If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.

", - "ListFacesResponse$FaceModelVersion": "

Latest face model being used with the collection. For more information, see Model versioning.

", + "ListFacesResponse$FaceModelVersion": "

Version number of the face detection model associated with the input collection (CollectionId).

", "ModerationLabel$Name": "

The label name for the type of unsafe content detected in the image.

", "ModerationLabel$ParentName": "

The name for the parent label. Labels at the top level of the hierarchy have the parent label \"\".

", "Parent$Name": "

The name of the parent label.

", - "SearchFacesByImageResponse$FaceModelVersion": "

Latest face model being used with the collection. For more information, see Model versioning.

", - "SearchFacesResponse$FaceModelVersion": "

Latest face model being used with the collection. For more information, see Model versioning.

", + "SearchFacesByImageResponse$FaceModelVersion": "

Version number of the face detection model associated with the input collection (CollectionId).

", + "SearchFacesResponse$FaceModelVersion": "

Version number of the face detection model associated with the input collection (CollectionId).

", "SegmentTypeInfo$ModelVersion": "

The version of the model used to detect segments.

", "TextDetection$DetectedText": "

The word or line of text recognized by Amazon Rekognition.

", "VideoMetadata$Codec": "

Type of compression used in the analyzed video.

", @@ -2381,7 +2495,7 @@ } }, "TextDetection": { - "base": "

Information about a word or line of text detected by DetectText.

The DetectedText field contains the text that Amazon Rekognition detected in the image.

Every word and line has an identifier (Id). Each word belongs to a line and has a parent identifier (ParentId) that identifies the line of text in which the word appears. The word Id is also an index for the word within a line of words.

For more information, see Detecting Text in the Amazon Rekognition Developer Guide.

", + "base": "

Information about a word or line of text detected by DetectText.

The DetectedText field contains the text that Amazon Rekognition detected in the image.

Every word and line has an identifier (Id). Each word belongs to a line and has a parent identifier (ParentId) that identifies the line of text in which the word appears. The word Id is also an index for the word within a line of words.

For more information, see Detecting text in the Amazon Rekognition Developer Guide.

", "refs": { "TextDetectionList$member": null, "TextDetectionResult$TextDetection": "

Details about text detected in a video.

" @@ -2480,6 +2594,7 @@ "AudioMetadata$SampleRate": "

The sample rate for the audio stream.

", "AudioMetadata$NumberOfChannels": "

The number of audio channels in the segment.

", "DescribeCollectionResponse$FaceCount": "

The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.

", + "KinesisVideoStreamStartSelector$ProducerTimestamp": "

The timestamp from the producer corresponding to the fragment.

", "ProjectVersionDescription$BillableTrainingTimeInSeconds": "

The duration, in seconds, that you were billed for a successful training of the model version. This value is only returned if the model version has been successfully trained.

", "SegmentDetection$DurationMillis": "

The duration of the detected segment in milliseconds.

", "SegmentDetection$StartFrameNumber": "

The frame number of the start of a video segment, using a frame index that starts with 0.

", @@ -2523,6 +2638,16 @@ "refs": { } }, + "UpdateStreamProcessorRequest": { + "base": null, + "refs": { + } + }, + "UpdateStreamProcessorResponse": { + "base": null, + "refs": { + } + }, "Url": { "base": null, "refs": { diff --git a/models/apis/sagemaker/2017-07-24/api-2.json b/models/apis/sagemaker/2017-07-24/api-2.json index c06ea00d4e3..7487b48e997 100644 --- a/models/apis/sagemaker/2017-07-24/api-2.json +++ b/models/apis/sagemaker/2017-07-24/api-2.json @@ -3487,9 +3487,17 @@ "DataSource":{"shape":"AutoMLDataSource"}, "CompressionType":{"shape":"CompressionType"}, "TargetAttributeName":{"shape":"TargetAttributeName"}, - "ContentType":{"shape":"ContentType"} + "ContentType":{"shape":"ContentType"}, + "ChannelType":{"shape":"AutoMLChannelType"} } }, + "AutoMLChannelType":{ + "type":"string", + "enum":[ + "training", + "validation" + ] + }, "AutoMLContainerDefinition":{ "type":"structure", "required":[ @@ -3514,6 +3522,12 @@ "S3DataSource":{"shape":"AutoMLS3DataSource"} } }, + "AutoMLDataSplitConfig":{ + "type":"structure", + "members":{ + "ValidationFraction":{"shape":"ValidationFraction"} + } + }, "AutoMLFailureReason":{ "type":"string", "max":1024 @@ -3549,7 +3563,8 @@ "type":"structure", "members":{ "CompletionCriteria":{"shape":"AutoMLJobCompletionCriteria"}, - "SecurityConfig":{"shape":"AutoMLSecurityConfig"} + "SecurityConfig":{"shape":"AutoMLSecurityConfig"}, + "DataSplitConfig":{"shape":"AutoMLDataSplitConfig"} } }, "AutoMLJobName":{ @@ -16521,6 +16536,11 @@ "RSessionAppSettings":{"shape":"RSessionAppSettings"} } }, + "ValidationFraction":{ + "type":"float", + "max":1, + "min":0 + }, "VariantName":{ "type":"string", "max":63, diff --git a/models/apis/sagemaker/2017-07-24/docs-2.json b/models/apis/sagemaker/2017-07-24/docs-2.json index 2136d495f66..a4295e69120 100644 --- a/models/apis/sagemaker/2017-07-24/docs-2.json +++ b/models/apis/sagemaker/2017-07-24/docs-2.json @@ -1,51 +1,51 @@ { "version": "2.0", - "service": "

Provides APIs for creating and managing Amazon SageMaker resources.

Other Resources:

", + "service": "

Provides APIs for creating and managing SageMaker resources.

Other Resources:

", "operations": { "AddAssociation": "

Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.

", - "AddTags": "

Adds or overwrites one or more tags for the specified Amazon SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.

", + "AddTags": "

Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.

Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

Tags that you add to a SageMaker Studio Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.

", "AssociateTrialComponent": "

Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

", "BatchDescribeModelPackage": "

This action batch describes a list of versioned model packages

", "CreateAction": "

Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.

", - "CreateAlgorithm": "

Create a machine learning algorithm that you can use in Amazon SageMaker and list in the Amazon Web Services Marketplace.

", + "CreateAlgorithm": "

Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.

", "CreateApp": "

Creates a running app for the specified UserProfile. Supported apps are JupyterServer and KernelGateway. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

", "CreateAppImageConfig": "

Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System (EFS) storage volume on the image, and a list of the kernels in the image.

", "CreateArtifact": "

Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.

", "CreateAutoMLJob": "

Creates an Autopilot job.

Find the best-performing model after you run an Autopilot job by calling .

For information about how to use Autopilot, see Automate Model Development with Amazon SageMaker Autopilot.

", - "CreateCodeRepository": "

Creates a Git repository as a resource in your Amazon SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your Amazon SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.

", + "CreateCodeRepository": "

Creates a Git repository as a resource in your SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.

", "CreateCompilationJob": "

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource.

In the request body, you provide the following:

You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.

To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

", "CreateContext": "

Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.

", "CreateDataQualityJobDefinition": "

Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.

", "CreateDeviceFleet": "

Creates a device fleet.

", "CreateDomain": "

Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. An Amazon Web Services account is limited to one domain per region. Users within a domain can share notebook files and other artifacts with each other.

EFS storage

When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.

SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.

VPC configuration

All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. The following options are available:

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a SageMaker Studio app successfully.

For more information, see Connect SageMaker Studio Notebooks to Resources in a VPC.

", "CreateEdgePackagingJob": "

Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.

", - "CreateEndpoint": "

Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.

Use this API to deploy models using Amazon SageMaker hosting services.

For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see the Create Endpoint example notebook.

You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

When Amazon SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. Amazon SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.

If any of the models hosted at this endpoint get model data from an Amazon S3 location, Amazon SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your IAM user account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.

", - "CreateEndpointConfig": "

Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want Amazon SageMaker to provision. Then you call the CreateEndpoint API.

Use this API if you want to use Amazon SageMaker hosting services to deploy models into production.

In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want Amazon SageMaker to provision. This includes the number and type of ML compute instances to deploy.

If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. Amazon SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

", + "CreateEndpoint": "

Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.

Use this API to deploy models using SageMaker hosting services.

For an example that calls this method when deploying a model to SageMaker hosting services, see the Create Endpoint example notebook.

You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.

When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.

If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your IAM user account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.

", + "CreateEndpointConfig": "

Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API.

Use this API if you want to use SageMaker hosting services to deploy models into production.

In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy.

If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.

When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.

", "CreateExperiment": "

Creates an SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.

The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.

To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.

To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.

", "CreateFeatureGroup": "

Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.

The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check Amazon Web Services service quotas to see the FeatureGroups quota for your Amazon Web Services account.

You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.

", "CreateFlowDefinition": "

Creates a flow definition.

", "CreateHumanTaskUi": "

Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.

", "CreateHyperParameterTuningJob": "

Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.

", - "CreateImage": "

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Container Registry (ECR). For more information, see Bring your own SageMaker image.

", - "CreateImageVersion": "

Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Container Registry (ECR) container image specified by BaseImage.

", + "CreateImage": "

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Elastic Container Registry (ECR). For more information, see Bring your own SageMaker image.

", + "CreateImageVersion": "

Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Elastic Container Registry (ECR) container image specified by BaseImage.

", "CreateInferenceRecommendationsJob": "

Starts a recommendation job. You can create either an instance recommendation or load test job.

", "CreateLabelingJob": "

Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.

You can select your workforce from one of three providers:

You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.

The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.

The output can be used as the manifest file for another labeling job or as training data for your machine learning models.

You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active (InProgress) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job.

", - "CreateModel": "

Creates a model in Amazon SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.

Use this API to create a model if you want to use Amazon SageMaker hosting services or run a batch transform job.

To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. Amazon SageMaker then deploys all of the containers that you defined for the model in the hosting environment.

For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (Amazon Web Services SDK for Python (Boto 3)).

To run a batch transform using your model, you start a job with the CreateTransformJob API. Amazon SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.

In the CreateModel request, you must define a container with the PrimaryContainer parameter.

In the request, you also provide an IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

", + "CreateModel": "

Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.

Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job.

To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment.

For an example that calls this method when deploying a model to SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (Amazon Web Services SDK for Python (Boto 3)).

To run a batch transform using your model, you start a job with the CreateTransformJob API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.

In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

", "CreateModelBiasJobDefinition": "

Creates the definition for a model bias job.

", "CreateModelExplainabilityJobDefinition": "

Creates the definition for a model explainability job.

", - "CreateModelPackage": "

Creates a model package that you can use to create Amazon SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in Amazon SageMaker.

To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification.

There are two types of model packages:

", + "CreateModelPackage": "

Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification.

There are two types of model packages:

", "CreateModelPackageGroup": "

Creates a model group. A model group contains a group of model versions.

", "CreateModelQualityJobDefinition": "

Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.

", "CreateMonitoringSchedule": "

Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endoint.

", - "CreateNotebookInstance": "

Creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.

In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. Amazon SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.

Amazon SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use Amazon SageMaker with a specific algorithm or with a machine learning framework.

After receiving the request, Amazon SageMaker does the following:

  1. Creates a network interface in the Amazon SageMaker VPC.

  2. (Option) If you specified SubnetId, Amazon SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, Amazon SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC.

  3. Launches an EC2 instance of the type specified in the request in the Amazon SageMaker VPC. If you specified SubnetId of your VPC, Amazon SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.

After creating the notebook instance, Amazon SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.

After Amazon SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating Amazon SageMaker endpoints, and validate hosted models.

For more information, see How It Works.

", + "CreateNotebookInstance": "

Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.

In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.

SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework.

After receiving the request, SageMaker does the following:

  1. Creates a network interface in the SageMaker VPC.

  2. (Option) If you specified SubnetId, SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC.

  3. Launches an EC2 instance of the type specified in the request in the SageMaker VPC. If you specified SubnetId of your VPC, SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.

After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.

After SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker endpoints, and validate hosted models.

For more information, see How It Works.

", "CreateNotebookInstanceLifecycleConfig": "

Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.

Each lifecycle configuration script has a limit of 16384 characters.

The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

", "CreatePipeline": "

Creates a pipeline using a JSON pipeline definition.

", "CreatePresignedDomainUrl": "

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to Amazon SageMaker Studio, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System (EFS) volume. This operation can only be called when the authentication mode equals IAM.

The IAM role or user used to call this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app.

You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to SageMaker Studio Through an Interface VPC Endpoint .

The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds. If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.

", - "CreatePresignedNotebookInstanceUrl": "

Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the Amazon SageMaker console, when you choose Open next to a notebook instance, Amazon SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.

The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.

You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.

", + "CreatePresignedNotebookInstanceUrl": "

Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker console, when you choose Open next to a notebook instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.

The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.

You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.

", "CreateProcessingJob": "

Creates a processing job.

", "CreateProject": "

Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

", "CreateStudioLifecycleConfig": "

Creates a new Studio Lifecycle Configuration.

", - "CreateTrainingJob": "

Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.

If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than Amazon SageMaker, provided that you know how to use them for inference.

In the request body, you provide the following:

For more information about Amazon SageMaker, see How It Works.

", + "CreateTrainingJob": "

Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.

If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference.

In the request body, you provide the following:

For more information about SageMaker, see How It Works.

", "CreateTransformJob": "

Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.

To perform batch transformations, you create a transform job and use the data that you have readily available.

In the request body, you provide the following:

For more information about how batch transformation works, see Batch Transform.

", "CreateTrial": "

Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial and then use the Search API to search for the tags.

To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.

", "CreateTrialComponent": "

Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.

Trial components include pre-processing jobs, training jobs, and batch transform jobs.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial component and then use the Search API to search for the tags.

", @@ -63,7 +63,7 @@ "DeleteDataQualityJobDefinition": "

Deletes a data quality monitoring job definition.

", "DeleteDeviceFleet": "

Deletes a fleet.

", "DeleteDomain": "

Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using SSO. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.

", - "DeleteEndpoint": "

Deletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the endpoint was created.

Amazon SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.

", + "DeleteEndpoint": "

Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created.

SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.

When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn , otherwise SageMaker cannot delete these resources.

", "DeleteEndpointConfig": "

Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

", "DeleteExperiment": "

Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.

", "DeleteFeatureGroup": "

Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called.

Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted.

", @@ -71,20 +71,20 @@ "DeleteHumanTaskUi": "

Use this operation to delete a human task user interface (worker task template).

To see a list of human task user interfaces (work task templates) in your account, use . When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

", "DeleteImage": "

Deletes a SageMaker image and all versions of the image. The container images aren't deleted.

", "DeleteImageVersion": "

Deletes a version of a SageMaker image. The container image the version represents isn't deleted.

", - "DeleteModel": "

Deletes a model. The DeleteModel API deletes only the model entry that was created in Amazon SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.

", + "DeleteModel": "

Deletes a model. The DeleteModel API deletes only the model entry that was created in SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.

", "DeleteModelBiasJobDefinition": "

Deletes an Amazon SageMaker model bias job definition.

", "DeleteModelExplainabilityJobDefinition": "

Deletes an Amazon SageMaker model explainability job definition.

", - "DeleteModelPackage": "

Deletes a model package.

A model package is used to create Amazon SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in Amazon SageMaker.

", + "DeleteModelPackage": "

Deletes a model package.

A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

", "DeleteModelPackageGroup": "

Deletes the specified model group.

", "DeleteModelPackageGroupPolicy": "

Deletes a model group resource policy.

", "DeleteModelQualityJobDefinition": "

Deletes the secified model quality monitoring job definition.

", "DeleteMonitoringSchedule": "

Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.

", - "DeleteNotebookInstance": "

Deletes an Amazon SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.

When you delete a notebook instance, you lose all of your data. Amazon SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.

", + "DeleteNotebookInstance": "

Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.

When you delete a notebook instance, you lose all of your data. SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.

", "DeleteNotebookInstanceLifecycleConfig": "

Deletes a notebook instance lifecycle configuration.

", "DeletePipeline": "

Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances of the pipeline are deleted.

", "DeleteProject": "

Delete the specified project.

", "DeleteStudioLifecycleConfig": "

Deletes the Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

", - "DeleteTags": "

Deletes the specified tags from an Amazon SageMaker resource.

To list a resource's tags, use the ListTags API.

When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.

When you call this API to delete tags from a SageMaker Studio Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain or User Profile launched before you called this API.

", + "DeleteTags": "

Deletes the specified tags from an SageMaker resource.

To list a resource's tags, use the ListTags API.

When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.

When you call this API to delete tags from a SageMaker Studio Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain or User Profile launched before you called this API.

", "DeleteTrial": "

Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.

", "DeleteTrialComponent": "

Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

", "DeleteUserProfile": "

Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.

", @@ -187,7 +187,7 @@ "ListMonitoringExecutions": "

Returns list of all monitoring job executions.

", "ListMonitoringSchedules": "

Returns list of all monitoring schedules.

", "ListNotebookInstanceLifecycleConfigs": "

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

", - "ListNotebookInstances": "

Returns a list of the Amazon SageMaker notebook instances in the requester's account in an Amazon Web Services Region.

", + "ListNotebookInstances": "

Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services Region.

", "ListPipelineExecutionSteps": "

Gets a list of PipeLineExecutionStep objects.

", "ListPipelineExecutions": "

Gets a list of the pipeline executions.

", "ListPipelineParametersForExecution": "

Gets a list of parameters for a pipeline execution.

", @@ -196,7 +196,7 @@ "ListProjects": "

Gets a list of the projects in an Amazon Web Services account.

", "ListStudioLifecycleConfigs": "

Lists the Studio Lifecycle Configurations in your Amazon Web Services Account.

", "ListSubscribedWorkteams": "

Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

", - "ListTags": "

Returns the tags for the specified Amazon SageMaker resource.

", + "ListTags": "

Returns the tags for the specified SageMaker resource.

", "ListTrainingJobs": "

Lists training jobs.

When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.

For example, if ListTrainingJobs is invoked with the following parameters:

{ ... MaxResults: 100, StatusEquals: InProgress ... }

First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.

You can quickly test the API using the following Amazon Web Services CLI code.

aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress

", "ListTrainingJobsForHyperParameterTuningJob": "

Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

", "ListTransformJobs": "

Lists transform jobs.

", @@ -214,7 +214,7 @@ "SendPipelineExecutionStepFailure": "

Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

", "SendPipelineExecutionStepSuccess": "

Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

", "StartMonitoringSchedule": "

Starts a previously stopped monitoring schedule.

By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled.

", - "StartNotebookInstance": "

Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, Amazon SageMaker sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook.

", + "StartNotebookInstance": "

Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook.

", "StartPipelineExecution": "

Starts a pipeline execution.

", "StopAutoMLJob": "

A method for forcing the termination of a running job.

", "StopCompilationJob": "

Stops a model compilation job.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal.

When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobSummary$CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped.

", @@ -223,10 +223,10 @@ "StopInferenceRecommendationsJob": "

Stops an Inference Recommender job.

", "StopLabelingJob": "

Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.

", "StopMonitoringSchedule": "

Stops a previously started monitoring schedule.

", - "StopNotebookInstance": "

Terminates the ML compute instance. Before terminating the instance, Amazon SageMaker disconnects the ML storage volume from it. Amazon SageMaker preserves the ML storage volume. Amazon SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance.

To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.

", + "StopNotebookInstance": "

Terminates the ML compute instance. Before terminating the instance, SageMaker disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance.

To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.

", "StopPipelineExecution": "

Stops a pipeline execution.

Callback Step

A pipeline execution won't stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a \"Status\" field which is set to \"Stopping\".

You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure.

Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.

Lambda Step

A pipeline execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped. If the timeout is hit the pipeline execution status is Failed.

", "StopProcessingJob": "

Stops a processing job.

", - "StopTrainingJob": "

Stops a training job. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost.

When it receives a StopTrainingJob request, Amazon SageMaker changes the status of the job to Stopping. After Amazon SageMaker stops the job, it sets the status to Stopped.

", + "StopTrainingJob": "

Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost.

When it receives a StopTrainingJob request, SageMaker changes the status of the job to Stopping. After SageMaker stops the job, it sets the status to Stopped.

", "StopTransformJob": "

Stops a batch transform job.

When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a batch transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.

", "UpdateAction": "

Updates an action.

", "UpdateAppImageConfig": "

Updates the properties of an AppImageConfig.

", @@ -236,8 +236,8 @@ "UpdateDeviceFleet": "

Updates a fleet of devices.

", "UpdateDevices": "

Updates one or more devices in a fleet.

", "UpdateDomain": "

Updates the default settings for new user profiles in the domain.

", - "UpdateEndpoint": "

Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).

When Amazon SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

", - "UpdateEndpointWeightsAndCapacities": "

Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, Amazon SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

", + "UpdateEndpoint": "

Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).

When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

", + "UpdateEndpointWeightsAndCapacities": "

Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

", "UpdateExperiment": "

Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.

", "UpdateImage": "

Updates the properties of a SageMaker image. To change the image's tags, use the AddTags and DeleteTags APIs.

", "UpdateModelPackage": "

Updates a versioned model.

", @@ -329,10 +329,10 @@ "AdditionalCodeRepositoryNamesOrUrls": { "base": null, "refs": { - "CreateNotebookInstanceInput$AdditionalCodeRepositories": "

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

", - "DescribeNotebookInstanceOutput$AdditionalCodeRepositories": "

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

", - "NotebookInstanceSummary$AdditionalCodeRepositories": "

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

", - "UpdateNotebookInstanceInput$AdditionalCodeRepositories": "

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

" + "CreateNotebookInstanceInput$AdditionalCodeRepositories": "

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

", + "DescribeNotebookInstanceOutput$AdditionalCodeRepositories": "

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

", + "NotebookInstanceSummary$AdditionalCodeRepositories": "

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

", + "UpdateNotebookInstanceInput$AdditionalCodeRepositories": "

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

" } }, "AdditionalInferenceSpecificationDefinition": { @@ -391,9 +391,9 @@ "AlgorithmImage": { "base": null, "refs": { - "AlgorithmSpecification$TrainingImage": "

The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

", + "AlgorithmSpecification$TrainingImage": "

The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

", "DebugRuleConfiguration$RuleEvaluatorImage": "

The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

", - "HyperParameterAlgorithmSpecification$TrainingImage": "

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

", + "HyperParameterAlgorithmSpecification$TrainingImage": "

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

", "ProfilerRuleConfiguration$RuleEvaluatorImage": "

The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

" } }, @@ -404,9 +404,9 @@ } }, "AlgorithmSpecification": { - "base": "

Specifies the training algorithm to use in a CreateTrainingJob request.

For more information about algorithms provided by Amazon SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

", + "base": "

Specifies the training algorithm to use in a CreateTrainingJob request.

For more information about algorithms provided by SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

", "refs": { - "CreateTrainingJobRequest$AlgorithmSpecification": "

The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by Amazon SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

", + "CreateTrainingJobRequest$AlgorithmSpecification": "

The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

", "DescribeTrainingJobResponse$AlgorithmSpecification": "

Information about the algorithm used for training, and algorithm metadata.

", "TrainingJob$AlgorithmSpecification": "

Information about the algorithm used for training, and algorithm metadata.

" } @@ -450,7 +450,7 @@ } }, "AlgorithmValidationProfile": { - "base": "

Defines a training job and a batch transform job that Amazon SageMaker runs to validate your algorithm.

The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.

", + "base": "

Defines a training job and a batch transform job that SageMaker runs to validate your algorithm.

The data provided in the validation profile is made available to your buyers on Amazon Web Services Marketplace.

", "refs": { "AlgorithmValidationProfiles$member": null } @@ -458,14 +458,14 @@ "AlgorithmValidationProfiles": { "base": null, "refs": { - "AlgorithmValidationSpecification$ValidationProfiles": "

An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that Amazon SageMaker runs to validate your algorithm.

" + "AlgorithmValidationSpecification$ValidationProfiles": "

An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that SageMaker runs to validate your algorithm.

" } }, "AlgorithmValidationSpecification": { - "base": "

Specifies configurations for one or more training jobs that Amazon SageMaker runs to test the algorithm.

", + "base": "

Specifies configurations for one or more training jobs that SageMaker runs to test the algorithm.

", "refs": { - "CreateAlgorithmInput$ValidationSpecification": "

Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker runs to test the algorithm's inference code.

", - "DescribeAlgorithmOutput$ValidationSpecification": "

Details about configurations for one or more training jobs that Amazon SageMaker runs to test the algorithm.

" + "CreateAlgorithmInput$ValidationSpecification": "

Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm's inference code.

", + "DescribeAlgorithmOutput$ValidationSpecification": "

Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.

" } }, "AnnotationConsolidationConfig": { @@ -530,7 +530,7 @@ "AppInstanceType": { "base": null, "refs": { - "ResourceSpec$InstanceType": "

The instance type that the image version runs on.

" + "ResourceSpec$InstanceType": "

The instance type that the image version runs on.

JupyterServer Apps only support the system value. KernelGateway Apps do not support the system value, but support all other values for available instance types.

" } }, "AppList": { @@ -616,10 +616,10 @@ "CreateModelPackageInput$ModelPackageGroupName": "

The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.

This parameter is required for versioned models, and does not apply to unversioned models.

", "DeleteModelPackageGroupInput$ModelPackageGroupName": "

The name of the model group to delete.

", "DescribeAlgorithmInput$AlgorithmName": "

The name of the algorithm to describe.

", - "DescribeModelPackageGroupInput$ModelPackageGroupName": "

The name of the model group to describe.

", + "DescribeModelPackageGroupInput$ModelPackageGroupName": "

The name of gthe model group to describe.

", "HyperParameterAlgorithmSpecification$AlgorithmName": "

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

", "ListModelPackagesInput$ModelPackageGroupName": "

A filter that returns only model versions that belong to the specified model group.

", - "SourceAlgorithm$AlgorithmName": "

The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

" + "SourceAlgorithm$AlgorithmName": "

The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

" } }, "ArtifactArn": { @@ -739,9 +739,9 @@ } }, "AsyncInferenceClientConfig": { - "base": "

Configures the behavior of the client used by Amazon SageMaker to interact with the model container during asynchronous inference.

", + "base": "

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

", "refs": { - "AsyncInferenceConfig$ClientConfig": "

Configures the behavior of the client used by Amazon SageMaker to interact with the model container during asynchronous inference.

" + "AsyncInferenceConfig$ClientConfig": "

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

" } }, "AsyncInferenceConfig": { @@ -851,11 +851,17 @@ } }, "AutoMLChannel": { - "base": "

A channel is a named input source that training algorithms can consume. For more information, see .

", + "base": "

A channel is a named input source that training algorithms can consume. The validation dataset size is limited to less than 2 GB. The training dataset size must be less than 100 GB. For more information, see .

A validation dataset must contain the same headers as the training dataset.

", "refs": { "AutoMLInputDataConfig$member": null } }, + "AutoMLChannelType": { + "base": null, + "refs": { + "AutoMLChannel$ChannelType": "

The channel type (optional) is an enum string. The default value is training. Channels for training and validation must share the same ContentType and TargetAttributeName.

" + } + }, "AutoMLContainerDefinition": { "base": "

A list of container definitions that describe the different containers that make up an AutoML candidate. For more information, see .

", "refs": { @@ -874,6 +880,12 @@ "AutoMLChannel$DataSource": "

The data source for an AutoML channel.

" } }, + "AutoMLDataSplitConfig": { + "base": "

This structure specifies how to split the data into train and test datasets. The validation and training datasets must contain the same headers. The validation dataset must be less than 2 GB in size.

", + "refs": { + "AutoMLJobConfig$DataSplitConfig": "

The configuration for splitting the input training dataset.

Type: AutoMLDataSplitConfig

" + } + }, "AutoMLFailureReason": { "base": null, "refs": { @@ -1106,7 +1118,7 @@ "BillableTimeInSeconds": { "base": null, "refs": { - "DescribeTrainingJobResponse$BillableTimeInSeconds": "

The billable time in seconds. Billable time refers to the absolute wall-clock time.

Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker will bill you if you run distributed training. The formula is as follows: BillableTimeInSeconds * InstanceCount .

You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.

", + "DescribeTrainingJobResponse$BillableTimeInSeconds": "

The billable time in seconds. Billable time refers to the absolute wall-clock time.

Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run distributed training. The formula is as follows: BillableTimeInSeconds * InstanceCount .

You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.

", "TrainingJob$BillableTimeInSeconds": "

The billable time in seconds.

" } }, @@ -1125,22 +1137,22 @@ "Boolean": { "base": null, "refs": { - "AlgorithmSpecification$EnableSageMakerMetricsTimeSeries": "

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

", + "AlgorithmSpecification$EnableSageMakerMetricsTimeSeries": "

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

", "AutoMLSecurityConfig$EnableInterContainerTrafficEncryption": "

Whether to use traffic encryption between the container layers.

", "ChannelSpecification$IsRequired": "

Indicates whether the channel is required by the algorithm.

", "ClarifyCheckStepMetadata$SkipCheck": "

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

", "ClarifyCheckStepMetadata$RegisterNewBaseline": "

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints property.

", "CreateModelInput$EnableNetworkIsolation": "

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

", - "CreateTrainingJobRequest$EnableNetworkIsolation": "

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

", + "CreateTrainingJobRequest$EnableNetworkIsolation": "

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

", "CreateTrainingJobRequest$EnableInterContainerTrafficEncryption": "

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.

", "CreateTrainingJobRequest$EnableManagedSpotTraining": "

To train models using managed spot training, choose True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.

The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.

", "DescribeModelOutput$EnableNetworkIsolation": "

If True, no inbound or outbound network calls can be made to or from the model container.

", - "DescribeTrainingJobResponse$EnableNetworkIsolation": "

If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

", + "DescribeTrainingJobResponse$EnableNetworkIsolation": "

If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

", "DescribeTrainingJobResponse$EnableInterContainerTrafficEncryption": "

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.

", "DescribeTrainingJobResponse$EnableManagedSpotTraining": "

A Boolean indicating whether managed spot training is enabled (True) or not (False).

", "HyperParameterSpecification$IsTunable": "

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

", "HyperParameterSpecification$IsRequired": "

Indicates whether this hyperparameter is required.

", - "HyperParameterTrainingJobDefinition$EnableNetworkIsolation": "

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

", + "HyperParameterTrainingJobDefinition$EnableNetworkIsolation": "

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

", "HyperParameterTrainingJobDefinition$EnableInterContainerTrafficEncryption": "

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

", "HyperParameterTrainingJobDefinition$EnableManagedSpotTraining": "

A Boolean indicating whether managed spot training is enabled (True) or not (False).

", "MonitoringNetworkConfig$EnableInterContainerTrafficEncryption": "

Whether to encrypt all communications between the instances used for the monitoring jobs. Choose True to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.

", @@ -1151,7 +1163,7 @@ "OnlineStoreConfig$EnableOnlineStore": "

Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

The default value is False.

", "QualityCheckStepMetadata$SkipCheck": "

This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.

", "QualityCheckStepMetadata$RegisterNewBaseline": "

This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics properties.

", - "QueryLineageRequest$IncludeEdges": "

Setting this value to True will retrieve not only the entities of interest but also the Associations and lineage entities on the path. Set to False to only return lineage entities that match your query.

", + "QueryLineageRequest$IncludeEdges": "

Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path. Set to False to only return lineage entities that match your query.

", "TrainingJob$EnableNetworkIsolation": "

If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can't communicate beyond the VPC they run in.

", "TrainingJob$EnableInterContainerTrafficEncryption": "

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

", "TrainingJob$EnableManagedSpotTraining": "

When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.

", @@ -1466,11 +1478,11 @@ "base": null, "refs": { "AdditionalCodeRepositoryNamesOrUrls$member": null, - "CreateNotebookInstanceInput$DefaultCodeRepository": "

A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

", - "DescribeNotebookInstanceOutput$DefaultCodeRepository": "

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

", + "CreateNotebookInstanceInput$DefaultCodeRepository": "

A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

", + "DescribeNotebookInstanceOutput$DefaultCodeRepository": "

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

", "ListNotebookInstancesInput$AdditionalCodeRepositoryEquals": "

A filter that returns only notebook instances with associated with the specified git repository.

", - "NotebookInstanceSummary$DefaultCodeRepository": "

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

", - "UpdateNotebookInstanceInput$DefaultCodeRepository": "

The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

" + "NotebookInstanceSummary$DefaultCodeRepository": "

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

", + "UpdateNotebookInstanceInput$DefaultCodeRepository": "

The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

" } }, "CodeRepositorySortBy": { @@ -1685,10 +1697,10 @@ "base": null, "refs": { "AutoMLContainerDefinition$Image": "

The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see .

", - "ContainerDefinition$Image": "

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker

", + "ContainerDefinition$Image": "

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker

", "DeployedImage$SpecifiedImage": "

The image path you specified when you created the model.

", "DeployedImage$ResolvedImage": "

The specific digest path of the image hosted in this ProductionVariant.

", - "ModelPackageContainerDefinition$Image": "

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

", + "ModelPackageContainerDefinition$Image": "

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

", "TrainingSpecification$TrainingImage": "

The Amazon ECR registry path of the Docker image that contains the training algorithm.

" } }, @@ -1707,7 +1719,7 @@ "ContentClassifiers": { "base": null, "refs": { - "LabelingJobDataAttributes$ContentClassifiers": "

Declares that your content is free of personally identifiable information or adult content. Amazon SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.

" + "LabelingJobDataAttributes$ContentClassifiers": "

Declares that your content is free of personally identifiable information or adult content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.

" } }, "ContentDigest": { @@ -3382,14 +3394,14 @@ "DirectInternetAccess": { "base": null, "refs": { - "CreateNotebookInstanceInput$DirectInternetAccess": "

Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance is able to access resources only in your VPC, and is not be able to connect to Amazon SageMaker training and endpoint services unless you configure a NAT Gateway in your VPC.

For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

", - "DescribeNotebookInstanceOutput$DirectInternetAccess": "

Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default.

" + "CreateNotebookInstanceInput$DirectInternetAccess": "

Sets whether SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker training and endpoint services unless you configure a NAT Gateway in your VPC.

For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

", + "DescribeNotebookInstanceOutput$DirectInternetAccess": "

Describes whether SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default.

" } }, "Direction": { "base": null, "refs": { - "QueryLineageRequest$Direction": "

Associations between lineage entities are directed. This parameter determines the direction from the StartArn(s) the query will look.

" + "QueryLineageRequest$Direction": "

Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.

" } }, "DirectoryPath": { @@ -3769,7 +3781,7 @@ "CreateEndpointInput$EndpointConfigName": "

The name of an endpoint configuration. For more information, see CreateEndpointConfig.

", "DeleteEndpointConfigInput$EndpointConfigName": "

The name of the endpoint configuration that you want to delete.

", "DescribeEndpointConfigInput$EndpointConfigName": "

The name of the endpoint configuration.

", - "DescribeEndpointConfigOutput$EndpointConfigName": "

Name of the Amazon SageMaker endpoint configuration.

", + "DescribeEndpointConfigOutput$EndpointConfigName": "

Name of the SageMaker endpoint configuration.

", "DescribeEndpointOutput$EndpointConfigName": "

The name of the endpoint configuration associated with this endpoint.

", "Endpoint$EndpointConfigName": "

The endpoint configuration associated with the endpoint.

", "EndpointConfigSummary$EndpointConfigName": "

The name of the endpoint configuration.

", @@ -3847,7 +3859,7 @@ "MonitoringSchedule$EndpointName": "

The endpoint that hosts the model being monitored.

", "MonitoringScheduleSummary$EndpointName": "

The name of the endpoint using the monitoring schedule.

", "UpdateEndpointInput$EndpointName": "

The name of the endpoint whose configuration you want to update.

", - "UpdateEndpointWeightsAndCapacitiesInput$EndpointName": "

The name of an existing Amazon SageMaker endpoint.

" + "UpdateEndpointWeightsAndCapacitiesInput$EndpointName": "

The name of an existing SageMaker endpoint.

" } }, "EndpointNameContains": { @@ -4743,8 +4755,8 @@ "HyperParameterScalingType": { "base": null, "refs": { - "ContinuousParameterRange$ScalingType": "

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

ReverseLogarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

", - "IntegerParameterRange$ScalingType": "

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

" + "ContinuousParameterRange$ScalingType": "

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

ReverseLogarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

", + "IntegerParameterRange$ScalingType": "

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

" } }, "HyperParameterSpecification": { @@ -4788,7 +4800,7 @@ } }, "HyperParameterTrainingJobSummary": { - "base": "

Specifies summary information about a training job.

", + "base": "

The container for the summary information about a training job.

", "refs": { "DescribeHyperParameterTuningJobResponse$BestTrainingJob": "

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

", "DescribeHyperParameterTuningJobResponse$OverallBestTrainingJob": "

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

", @@ -4798,7 +4810,7 @@ "HyperParameterTuningJobArn": { "base": null, "refs": { - "CreateHyperParameterTuningJobResponse$HyperParameterTuningJobArn": "

The Amazon Resource Name (ARN) of the tuning job. Amazon SageMaker assigns an ARN to a hyperparameter tuning job when you create it.

", + "CreateHyperParameterTuningJobResponse$HyperParameterTuningJobArn": "

The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a hyperparameter tuning job when you create it.

", "DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobArn": "

The Amazon Resource Name (ARN) of the tuning job.

", "DescribeTrainingJobResponse$TuningJobArn": "

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

", "HyperParameterTuningJobSummary$HyperParameterTuningJobArn": "

The Amazon Resource Name (ARN) of the tuning job.

", @@ -4903,7 +4915,7 @@ "HyperParameters": { "base": null, "refs": { - "CreateTrainingJobRequest$HyperParameters": "

Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms.

You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.

", + "CreateTrainingJobRequest$HyperParameters": "

Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.

You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.

", "DescribeTrainingJobResponse$HyperParameters": "

Algorithm-specific parameters.

", "HyperParameterTrainingJobDefinition$StaticHyperParameters": "

Specifies the values of hyperparameters that do not change for the tuning job.

", "HyperParameterTrainingJobSummary$TunedHyperParameters": "

A list of the hyperparameters for which you specified ranges to search.

", @@ -4944,7 +4956,7 @@ "ImageBaseImage": { "base": null, "refs": { - "CreateImageVersionRequest$BaseImage": "

The registry path of the container image to use as the starting point for this version. The path is an Amazon Container Registry (ECR) URI in the following format:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

", + "CreateImageVersionRequest$BaseImage": "

The registry path of the container image to use as the starting point for this version. The path is an Amazon Elastic Container Registry (ECR) URI in the following format:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

", "DescribeImageVersionResponse$BaseImage": "

The registry path of the container image on which this image version is based.

" } }, @@ -5189,7 +5201,7 @@ "InputDataConfig": { "base": null, "refs": { - "CreateTrainingJobRequest$InputDataConfig": "

An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location.

Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.

Depending on the input mode that the algorithm supports, Amazon SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files will be made available as input streams. They do not need to be downloaded.

", + "CreateTrainingJobRequest$InputDataConfig": "

An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location.

Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.

Depending on the input mode that the algorithm supports, SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files are available as input streams. They do not need to be downloaded.

", "DescribeTrainingJobResponse$InputDataConfig": "

An array of Channel objects that describes each data input channel.

", "HyperParameterTrainingJobDefinition$InputDataConfig": "

An array of Channel objects that specify the input for the training jobs that the tuning job launches.

", "TrainingJob$InputDataConfig": "

An array of Channel objects that describes each data input channel.

", @@ -5255,13 +5267,13 @@ "InvocationsMaxRetries": { "base": null, "refs": { - "ModelClientConfig$InvocationsMaxRetries": "

The maximum number of retries when invocation requests are failing.

" + "ModelClientConfig$InvocationsMaxRetries": "

The maximum number of retries when invocation requests are failing. The default value is 3.

" } }, "InvocationsTimeoutInSeconds": { "base": null, "refs": { - "ModelClientConfig$InvocationsTimeoutInSeconds": "

The timeout value in seconds for an invocation request.

" + "ModelClientConfig$InvocationsTimeoutInSeconds": "

The timeout value in seconds for an invocation request. The default value is 600.

" } }, "IotRoleAlias": { @@ -5310,8 +5322,8 @@ "JsonPath": { "base": null, "refs": { - "DataProcessing$InputFilter": "

A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want Amazon SageMaker to pass the entire input dataset to the algorithm, accept the default value $.

Examples: \"$\", \"$[1:]\", \"$.features\"

", - "DataProcessing$OutputFilter": "

A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want Amazon SageMaker to store the entire input dataset in the output file, leave the default value, $. If you specify indexes that aren't within the dimension size of the joined dataset, you get an error.

Examples: \"$\", \"$[0,5:]\", \"$['id','SageMakerOutput']\"

" + "DataProcessing$InputFilter": "

A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want SageMaker to pass the entire input dataset to the algorithm, accept the default value $.

Examples: \"$\", \"$[1:]\", \"$.features\"

", + "DataProcessing$OutputFilter": "

A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want SageMaker to store the entire input dataset in the output file, leave the default value, $. If you specify indexes that aren't within the dimension size of the joined dataset, you get an error.

Examples: \"$\", \"$[0,5:]\", \"$['id','SageMakerOutput']\"

" } }, "JupyterServerAppSettings": { @@ -5368,22 +5380,22 @@ "KmsKeyId": { "base": null, "refs": { - "AsyncInferenceOutputConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the asynchronous inference output in Amazon S3.

", + "AsyncInferenceOutputConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the asynchronous inference output in Amazon S3.

", "AthenaDatasetDefinition$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.

", "AutoMLOutputDataConfig$KmsKeyId": "

The Amazon Web Services KMS encryption key ID.

", "AutoMLSecurityConfig$VolumeKmsKeyId": "

The key used to encrypt stored data.

", "CreateDomainRequest$HomeEfsFileSystemKmsKeyId": "

Use KmsKeyId.

", "CreateDomainRequest$KmsKeyId": "

SageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

", "CreateEdgePackagingJobRequest$ResourceKey": "

The Amazon Web Services KMS key to use when encrypting the EBS volume the edge packaging job runs on.

", - "CreateEndpointConfigInput$KmsKeyId": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

The KmsKeyId can be any of the following formats:

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

", - "CreateNotebookInstanceInput$KmsKeyId": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the Amazon Web Services Key Management Service Developer Guide.

", + "CreateEndpointConfigInput$KmsKeyId": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

The KmsKeyId can be any of the following formats:

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

", + "CreateNotebookInstanceInput$KmsKeyId": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the Amazon Web Services Key Management Service Developer Guide.

", "DataCaptureConfig$KmsKeyId": "

", "DataCaptureConfigSummary$KmsKeyId": "

", "DescribeDomainResponse$HomeEfsFileSystemKmsKeyId": "

Use KmsKeyId.

", "DescribeDomainResponse$KmsKeyId": "

The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.

", "DescribeEdgePackagingJobResponse$ResourceKey": "

The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.

", "DescribeEndpointConfigOutput$KmsKeyId": "

Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

", - "DescribeNotebookInstanceOutput$KmsKeyId": "

The Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

", + "DescribeNotebookInstanceOutput$KmsKeyId": "

The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

", "EdgeOutputConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

", "FlowDefinitionOutputConfig$KmsKeyId": "

The Amazon Key Management Service (KMS) key ID for server-side encryption.

", "LabelingJobOutputConfig$KmsKeyId": "

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role's account to encrypt your output data.

If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

", @@ -5392,14 +5404,14 @@ "MonitoringOutputConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

", "OnlineStoreSecurityConfig$KmsKeyId": "

The ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

The caller (either IAM user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId:

The caller (either IAM user or IAM role) to all DataPlane operations (PutRecord, GetRecord, DeleteRecord) must have the following permissions to the KmsKeyId:

", "OutputConfig$KmsKeyId": "

The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker uses to encrypt your output models with Amazon S3 server-side encryption after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KmsKeyId can be any of the following formats:

", - "OutputDataConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

", + "OutputDataConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

", "ProcessingClusterConfig$VolumeKmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

", "ProcessingOutputConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.

", - "ProductionVariantCoreDumpConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

", + "ProductionVariantCoreDumpConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

", "RecommendationJobInputConfig$VolumeKmsKeyId": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.

The KmsKeyId can be any of the following formats:

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

", "RecommendationJobOutputConfig$KmsKeyId": "

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

The KmsKeyId can be any of the following formats:

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

", "RedshiftDatasetDefinition$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.

", - "ResourceConfig$VolumeKmsKeyId": "

The Amazon Web Services KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

The VolumeKmsKeyId can be in any of the following formats:

", + "ResourceConfig$VolumeKmsKeyId": "

The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

The VolumeKmsKeyId can be in any of the following formats:

", "S3StorageConfig$KmsKeyId": "

The Amazon Web Services Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.

The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId:

", "SharingSettings$S3KmsKeyId": "

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

", "TransformOutput$KmsKeyId": "

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateModel request. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

", @@ -5457,7 +5469,7 @@ "refs": { "CreateLabelingJobResponse$LabelingJobArn": "

The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.

", "DescribeLabelingJobResponse$LabelingJobArn": "

The Amazon Resource Name (ARN) of the labeling job.

", - "DescribeTrainingJobResponse$LabelingJobArn": "

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

", + "DescribeTrainingJobResponse$LabelingJobArn": "

The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the transform or training job.

", "DescribeTransformJobResponse$LabelingJobArn": "

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

", "LabelingJobSummary$LabelingJobArn": "

The Amazon Resource Name (ARN) assigned to the labeling job when it was created.

", "TrainingJob$LabelingJobArn": "

The Amazon Resource Name (ARN) of the labeling job.

", @@ -5611,8 +5623,8 @@ "LifecycleConfigArns": { "base": null, "refs": { - "JupyterServerAppSettings$LifecycleConfigArns": "

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp.

", - "KernelGatewayAppSettings$LifecycleConfigArns": "

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

" + "JupyterServerAppSettings$LifecycleConfigArns": "

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

", + "KernelGatewayAppSettings$LifecycleConfigArns": "

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

" } }, "LineageEntityParameters": { @@ -6336,7 +6348,7 @@ "MaxConcurrentInvocationsPerInstance": { "base": null, "refs": { - "AsyncInferenceClientConfig$MaxConcurrentInvocationsPerInstance": "

The maximum number of concurrent requests sent by the SageMaker client to the model container. If no value is provided, Amazon SageMaker will choose an optimal value for you.

" + "AsyncInferenceClientConfig$MaxConcurrentInvocationsPerInstance": "

The maximum number of concurrent requests sent by the SageMaker client to the model container. If no value is provided, SageMaker chooses an optimal value.

" } }, "MaxConcurrentTaskCount": { @@ -6393,7 +6405,7 @@ "MaxPayloadInMB": { "base": null, "refs": { - "CreateTransformJobRequest$MaxPayloadInMB": "

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.

", + "CreateTransformJobRequest$MaxPayloadInMB": "

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB.

The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify the MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.

", "DescribeTransformJobResponse$MaxPayloadInMB": "

The maximum payload size, in MB, used in the transform job.

", "TransformJob$MaxPayloadInMB": "

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in algorithms do not support HTTP chunked encoding.

", "TransformJobDefinition$MaxPayloadInMB": "

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

" @@ -6464,7 +6476,7 @@ "MaxRuntimeInSeconds": { "base": null, "refs": { - "StoppingCondition$MaxRuntimeInSeconds": "

The maximum length of time, in seconds, that a training or compilation job can run.

For compilation jobs, if the job does not complete during this time, you will receive a TimeOut error. We recommend starting with 900 seconds and increase as necessary based on your model.

For all other jobs, if the job does not complete during this time, Amazon SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

" + "StoppingCondition$MaxRuntimeInSeconds": "

The maximum length of time, in seconds, that a training or compilation job can run.

For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.

For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

" } }, "MaxRuntimePerTrainingJobInSeconds": { @@ -6476,7 +6488,7 @@ "MaxWaitTimeInSeconds": { "base": null, "refs": { - "StoppingCondition$MaxWaitTimeInSeconds": "

The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, Amazon SageMaker ends the job.

When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.

" + "StoppingCondition$MaxWaitTimeInSeconds": "

The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job.

When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.

" } }, "MaximumExecutionTimeoutInSeconds": { @@ -6557,7 +6569,7 @@ } }, "MetricDefinition": { - "base": "

Specifies a metric that the training algorithm writes to stderr or stdout. Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.

", + "base": "

Specifies a metric that the training algorithm writes to stderr or stdout. SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.

", "refs": { "MetricDefinitionList$member": null } @@ -6565,7 +6577,7 @@ "MetricDefinitionList": { "base": null, "refs": { - "AlgorithmSpecification$MetricDefinitions": "

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

", + "AlgorithmSpecification$MetricDefinitions": "

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.

", "HyperParameterAlgorithmSpecification$MetricDefinitions": "

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

", "TrainingSpecification$MetricDefinitions": "

A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

" } @@ -6634,10 +6646,10 @@ "ModelArn": { "base": null, "refs": { - "CreateModelOutput$ModelArn": "

The ARN of the model created in Amazon SageMaker.

", + "CreateModelOutput$ModelArn": "

The ARN of the model created in SageMaker.

", "DescribeModelOutput$ModelArn": "

The Amazon Resource Name (ARN) of the model.

", "LabelingJobAlgorithmsConfig$InitialActiveLearningModelArn": "

At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here.

", - "LabelingJobOutput$FinalActiveLearningModelArn": "

The Amazon Resource Name (ARN) for the most recent Amazon SageMaker model trained as part of automated data labeling.

", + "LabelingJobOutput$FinalActiveLearningModelArn": "

The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of automated data labeling.

", "ModelSummary$ModelArn": "

The Amazon Resource Name (ARN) of the model.

" } }, @@ -6811,7 +6823,7 @@ "CreateTransformJobRequest$ModelName": "

The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account.

", "DeleteModelInput$ModelName": "

The name of the model to delete.

", "DescribeModelInput$ModelName": "

The name of the model.

", - "DescribeModelOutput$ModelName": "

Name of the Amazon SageMaker model.

", + "DescribeModelOutput$ModelName": "

Name of the SageMaker model.

", "DescribeTransformJobResponse$ModelName": "

The name of the model used in the transform job.

", "ModelSummary$ModelName": "

The name of the model that you want a summary for.

", "ProductionVariant$ModelName": "

The name of the model that you want to host. This is the name that you specified when creating the model.

", @@ -6977,13 +6989,13 @@ "ModelPackageValidationProfiles": { "base": null, "refs": { - "ModelPackageValidationSpecification$ValidationProfiles": "

An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that Amazon SageMaker runs to validate your model package.

" + "ModelPackageValidationSpecification$ValidationProfiles": "

An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that SageMaker runs to validate your model package.

" } }, "ModelPackageValidationSpecification": { - "base": "

Specifies batch transform jobs that Amazon SageMaker runs to validate your model package.

", + "base": "

Specifies batch transform jobs that SageMaker runs to validate your model package.

", "refs": { - "CreateModelPackageInput$ValidationSpecification": "

Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.

", + "CreateModelPackageInput$ValidationSpecification": "

Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.

", "DescribeModelPackageOutput$ValidationSpecification": "

Configurations for one or more transform jobs that SageMaker runs to test the model package.

", "ModelPackage$ValidationSpecification": null } @@ -7478,7 +7490,7 @@ "NetworkInterfaceId": { "base": null, "refs": { - "DescribeNotebookInstanceOutput$NetworkInterfaceId": "

The network interface IDs that Amazon SageMaker created at the time of creating the instance.

" + "DescribeNotebookInstanceOutput$NetworkInterfaceId": "

The network interface IDs that SageMaker created at the time of creating the instance.

" } }, "NextToken": { @@ -7491,7 +7503,7 @@ "ListActionsRequest$NextToken": "

If the previous call to ListActions didn't return the full set of actions, the call returns a token for getting the next set of actions.

", "ListActionsResponse$NextToken": "

A token for getting the next set of actions, if there are any.

", "ListAlgorithmsInput$NextToken": "

If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request.

", - "ListAlgorithmsOutput$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

", + "ListAlgorithmsOutput$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

", "ListAppImageConfigsRequest$NextToken": "

If the previous call to ListImages didn't return the full set of AppImageConfigs, the call returns a token for getting the next set of AppImageConfigs.

", "ListAppImageConfigsResponse$NextToken": "

A token for getting the next set of AppImageConfigs, if there are any.

", "ListAppsRequest$NextToken": "

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

", @@ -7537,9 +7549,9 @@ "ListInferenceRecommendationsJobsRequest$NextToken": "

If the response to a previous ListInferenceRecommendationsJobsRequest request was truncated, the response includes a NextToken. To retrieve the next set of recommendations, use the token in the next request.

", "ListInferenceRecommendationsJobsResponse$NextToken": "

A token for getting the next set of recommendations, if there are any.

", "ListLabelingJobsForWorkteamRequest$NextToken": "

If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

", - "ListLabelingJobsForWorkteamResponse$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

", + "ListLabelingJobsForWorkteamResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

", "ListLabelingJobsRequest$NextToken": "

If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

", - "ListLabelingJobsResponse$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

", + "ListLabelingJobsResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

", "ListLineageGroupsRequest$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

", "ListLineageGroupsResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

", "ListModelBiasJobDefinitionsRequest$NextToken": "

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

", @@ -7551,7 +7563,7 @@ "ListModelPackageGroupsInput$NextToken": "

If the result of the previous ListModelPackageGroups request was truncated, the response includes a NextToken. To retrieve the next set of model groups, use the token in the next request.

", "ListModelPackageGroupsOutput$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.

", "ListModelPackagesInput$NextToken": "

If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.

", - "ListModelPackagesOutput$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.

", + "ListModelPackagesOutput$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.

", "ListModelQualityJobDefinitionsRequest$NextToken": "

If the result of the previous ListModelQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of model quality monitoring job definitions, use the token in the next request.

", "ListModelQualityJobDefinitionsResponse$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request.

", "ListMonitoringExecutionsRequest$NextToken": "

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

", @@ -7559,9 +7571,9 @@ "ListMonitoringSchedulesRequest$NextToken": "

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

", "ListMonitoringSchedulesResponse$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.

", "ListNotebookInstanceLifecycleConfigsInput$NextToken": "

If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, the response includes a NextToken. To get the next set of lifecycle configurations, use the token in the next request.

", - "ListNotebookInstanceLifecycleConfigsOutput$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.

", + "ListNotebookInstanceLifecycleConfigsOutput$NextToken": "

If the response is truncated, SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.

", "ListNotebookInstancesInput$NextToken": "

If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

", - "ListNotebookInstancesOutput$NextToken": "

If the response to the previous ListNotebookInstances request was truncated, Amazon SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.

", + "ListNotebookInstancesOutput$NextToken": "

If the response to the previous ListNotebookInstances request was truncated, SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.

", "ListPipelineExecutionStepsRequest$NextToken": "

If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

", "ListPipelineExecutionStepsResponse$NextToken": "

If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request.

", "ListPipelineExecutionsRequest$NextToken": "

If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

", @@ -7578,12 +7590,12 @@ "ListStudioLifecycleConfigsResponse$NextToken": "

A token for getting the next set of actions, if there are any.

", "ListSubscribedWorkteamsRequest$NextToken": "

If the result of the previous ListSubscribedWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

", "ListSubscribedWorkteamsResponse$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

", - "ListTagsInput$NextToken": "

If the response to the previous ListTags request is truncated, Amazon SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.

", - "ListTagsOutput$NextToken": "

If response is truncated, Amazon SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.

", + "ListTagsInput$NextToken": "

If the response to the previous ListTags request is truncated, SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.

", + "ListTagsOutput$NextToken": "

If response is truncated, SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.

", "ListTrainingJobsForHyperParameterTuningJobRequest$NextToken": "

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

", "ListTrainingJobsForHyperParameterTuningJobResponse$NextToken": "

If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

", "ListTrainingJobsRequest$NextToken": "

If the result of the previous ListTrainingJobs request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

", - "ListTrainingJobsResponse$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

", + "ListTrainingJobsResponse$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

", "ListTransformJobsRequest$NextToken": "

If the result of the previous ListTransformJobs request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.

", "ListTransformJobsResponse$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.

", "ListTrialComponentsRequest$NextToken": "

If the previous call to ListTrialComponents didn't return the full set of components, the call returns a token for getting the next set of components.

", @@ -7704,9 +7716,9 @@ "refs": { "CreateNotebookInstanceInput$NotebookInstanceName": "

The name of the new notebook instance.

", "CreatePresignedNotebookInstanceUrlInput$NotebookInstanceName": "

The name of the notebook instance.

", - "DeleteNotebookInstanceInput$NotebookInstanceName": "

The name of the Amazon SageMaker notebook instance to delete.

", + "DeleteNotebookInstanceInput$NotebookInstanceName": "

The name of the SageMaker notebook instance to delete.

", "DescribeNotebookInstanceInput$NotebookInstanceName": "

The name of the notebook instance that you want information about.

", - "DescribeNotebookInstanceOutput$NotebookInstanceName": "

The name of the Amazon SageMaker notebook instance.

", + "DescribeNotebookInstanceOutput$NotebookInstanceName": "

The name of the SageMaker notebook instance.

", "NotebookInstanceSummary$NotebookInstanceName": "

The name of the notebook instance that you want a summary for.

", "StartNotebookInstanceInput$NotebookInstanceName": "

The name of the notebook instance to start.

", "StopNotebookInstanceInput$NotebookInstanceName": "

The name of the notebook instance to terminate.

", @@ -7740,7 +7752,7 @@ } }, "NotebookInstanceSummary": { - "base": "

Provides summary information for an Amazon SageMaker notebook instance.

", + "base": "

Provides summary information for an SageMaker notebook instance.

", "refs": { "NotebookInstanceSummaryList$member": null } @@ -7756,7 +7768,7 @@ "refs": { "CreatePresignedNotebookInstanceUrlOutput$AuthorizedUrl": "

A JSON object that contains the URL string.

", "DescribeNotebookInstanceOutput$Url": "

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

", - "NotebookInstanceSummary$Url": "

The URL that you use to connect to the Jupyter instance running in your notebook instance.

" + "NotebookInstanceSummary$Url": "

The URL that you use to connect to the Jupyter notebook running in your notebook instance.

" } }, "NotebookInstanceVolumeSizeInGB": { @@ -7764,7 +7776,7 @@ "refs": { "CreateNotebookInstanceInput$VolumeSizeInGB": "

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

", "DescribeNotebookInstanceOutput$VolumeSizeInGB": "

The size, in GB, of the ML storage volume attached to the notebook instance.

", - "UpdateNotebookInstanceInput$VolumeSizeInGB": "

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so Amazon SageMaker can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.

" + "UpdateNotebookInstanceInput$VolumeSizeInGB": "

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.

" } }, "NotebookOutputOption": { @@ -7936,11 +7948,11 @@ "OutputDataConfig": { "base": "

Provides information about how to store model training results (model artifacts).

", "refs": { - "CreateTrainingJobRequest$OutputDataConfig": "

Specifies the path to the S3 location where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.

", - "DescribeTrainingJobResponse$OutputDataConfig": "

The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.

", + "CreateTrainingJobRequest$OutputDataConfig": "

Specifies the path to the S3 location where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

", + "DescribeTrainingJobResponse$OutputDataConfig": "

The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.

", "HyperParameterTrainingJobDefinition$OutputDataConfig": "

Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.

", - "TrainingJob$OutputDataConfig": "

The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.

", - "TrainingJobDefinition$OutputDataConfig": "

the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.

" + "TrainingJob$OutputDataConfig": "

The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.

", + "TrainingJobDefinition$OutputDataConfig": "

the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

" } }, "OutputParameter": { @@ -7961,11 +7973,11 @@ "base": null, "refs": { "ListEndpointConfigsInput$NextToken": "

If the result of the previous ListEndpointConfig request was truncated, the response includes a NextToken. To retrieve the next set of endpoint configurations, use the token in the next request.

", - "ListEndpointConfigsOutput$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request

", + "ListEndpointConfigsOutput$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request

", "ListEndpointsInput$NextToken": "

If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.

", - "ListEndpointsOutput$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

", + "ListEndpointsOutput$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

", "ListModelsInput$NextToken": "

If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.

", - "ListModelsOutput$NextToken": "

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.

" + "ListModelsOutput$NextToken": "

If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.

" } }, "ParallelismConfiguration": { @@ -8572,7 +8584,7 @@ } }, "ProductionVariant": { - "base": "

Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying variant weights.

", + "base": "

Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic among the models by specifying variant weights.

", "refs": { "ProductionVariantList$member": null } @@ -8608,13 +8620,13 @@ } }, "ProductionVariantServerlessConfig": { - "base": "

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

Specifies the serverless configuration for an endpoint variant.

", + "base": "

Specifies the serverless configuration for an endpoint variant.

", "refs": { - "PendingProductionVariantSummary$CurrentServerlessConfig": "

The serverless configuration for the endpoint.

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

", - "PendingProductionVariantSummary$DesiredServerlessConfig": "

The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

", - "ProductionVariant$ServerlessConfig": "

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

", - "ProductionVariantSummary$CurrentServerlessConfig": "

The serverless configuration for the endpoint.

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

", - "ProductionVariantSummary$DesiredServerlessConfig": "

The serverless configuration requested for the endpoint update.

Serverless Inference is in preview release for Amazon SageMaker and is subject to change. We do not recommend using this feature in production environments.

" + "PendingProductionVariantSummary$CurrentServerlessConfig": "

The serverless configuration for the endpoint.

", + "PendingProductionVariantSummary$DesiredServerlessConfig": "

The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

", + "ProductionVariant$ServerlessConfig": "

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

", + "ProductionVariantSummary$CurrentServerlessConfig": "

The serverless configuration for the endpoint.

", + "ProductionVariantSummary$DesiredServerlessConfig": "

The serverless configuration requested for the endpoint update.

" } }, "ProductionVariantStatus": { @@ -8859,7 +8871,7 @@ "QueryLineageMaxDepth": { "base": null, "refs": { - "QueryLineageRequest$MaxDepth": "

The maximum depth in lineage relationships from the StartArns that will be traversed. Depth is a measure of the number of Associations from the StartArn entity to the matched results.

" + "QueryLineageRequest$MaxDepth": "

The maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number of Associations from the StartArn entity to the matched results.

" } }, "QueryLineageMaxResults": { @@ -8893,7 +8905,7 @@ "QueryProperties": { "base": null, "refs": { - "QueryFilters$Properties": "

Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. If multiple pairs are provided, an entity will be included in the results if it matches any of the provided pairs.

" + "QueryFilters$Properties": "

Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.

" } }, "QueryTypes": { @@ -9028,7 +9040,7 @@ "RecordWrapper": { "base": null, "refs": { - "Channel$RecordWrapperType": "

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.

In File mode, leave this field unset or set it to None.

" + "Channel$RecordWrapperType": "

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.

In File mode, leave this field unset or set it to None.

" } }, "RedshiftClusterId": { @@ -9147,9 +9159,9 @@ "ResourceConfig": { "base": "

Describes the resources, including ML compute instances and ML storage volumes, to use for model training.

", "refs": { - "CreateTrainingJobRequest$ResourceConfig": "

The resources, including the ML compute instances and ML storage volumes, to use for model training.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want Amazon SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

", + "CreateTrainingJobRequest$ResourceConfig": "

The resources, including the ML compute instances and ML storage volumes, to use for model training.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

", "DescribeTrainingJobResponse$ResourceConfig": "

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

", - "HyperParameterTrainingJobDefinition$ResourceConfig": "

The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.

Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want Amazon SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

", + "HyperParameterTrainingJobDefinition$ResourceConfig": "

The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.

Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

", "TrainingJob$ResourceConfig": "

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

", "TrainingJobDefinition$ResourceConfig": "

The resources, including the ML compute instances and ML storage volumes, to use for model training.

" } @@ -9166,7 +9178,7 @@ } }, "ResourceLimitExceeded": { - "base": "

You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.

", + "base": "

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

", "refs": { } }, @@ -9202,8 +9214,8 @@ "refs": { "CreateAppRequest$ResourceSpec": "

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

", "DescribeAppResponse$ResourceSpec": "

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

", - "JupyterServerAppSettings$DefaultResourceSpec": "

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app.

", - "KernelGatewayAppSettings$DefaultResourceSpec": "

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

", + "JupyterServerAppSettings$DefaultResourceSpec": "

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

", + "KernelGatewayAppSettings$DefaultResourceSpec": "

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

", "RStudioServerProDomainSettings$DefaultResourceSpec": null, "RStudioServerProDomainSettingsForUpdate$DefaultResourceSpec": null, "TensorBoardAppSettings$DefaultResourceSpec": "

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

" @@ -9263,7 +9275,7 @@ "RoleArn": { "base": null, "refs": { - "AlgorithmValidationSpecification$ValidationRole": "

The IAM roles that Amazon SageMaker uses to run the training jobs.

", + "AlgorithmValidationSpecification$ValidationRole": "

The IAM roles that SageMaker uses to run the training jobs.

", "CreateAutoMLJobRequest$RoleArn": "

The ARN of the role that is used to access the data.

", "CreateCompilationJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model compilation, Amazon SageMaker needs your permission to:

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

", "CreateDataQualityJobDefinitionRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

", @@ -9276,12 +9288,12 @@ "CreateLabelingJobRequest$RoleArn": "

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

", "CreateModelBiasJobDefinitionRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

", "CreateModelExplainabilityJobDefinitionRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

", - "CreateModelInput$ExecutionRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see Amazon SageMaker Roles.

To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.

", + "CreateModelInput$ExecutionRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

", "CreateModelQualityJobDefinitionRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

", - "CreateNotebookInstanceInput$RoleArn": "

When you send any requests to Amazon Web Services resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see Amazon SageMaker Roles.

To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.

", + "CreateNotebookInstanceInput$RoleArn": "

When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

", "CreatePipelineRequest$RoleArn": "

The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

", "CreateProcessingJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

", - "CreateTrainingJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

During model training, Amazon SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see Amazon SageMaker Roles.

To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.

", + "CreateTrainingJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf.

During model training, SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

", "DescribeAutoMLJobResponse$RoleArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.

", "DescribeCompilationJobResponse$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

", "DescribeDataQualityJobDefinitionResponse$RoleArn": "

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

", @@ -9291,7 +9303,7 @@ "DescribeFlowDefinitionResponse$RoleArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

", "DescribeImageResponse$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

", "DescribeInferenceRecommendationsJobResponse$RoleArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.

", - "DescribeLabelingJobResponse$RoleArn": "

The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.

", + "DescribeLabelingJobResponse$RoleArn": "

The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.

", "DescribeModelBiasJobDefinitionResponse$RoleArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.

", "DescribeModelExplainabilityJobDefinitionResponse$RoleArn": "

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.

", "DescribeModelOutput$ExecutionRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

", @@ -9315,7 +9327,7 @@ "TrainingJob$RoleArn": "

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

", "UpdateDeviceFleetRequest$RoleArn": "

The Amazon Resource Name (ARN) of the device.

", "UpdateImageRequest$RoleArn": "

The new Amazon Resource Name (ARN) for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

", - "UpdateNotebookInstanceInput$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the notebook instance. For more information, see Amazon SageMaker Roles.

To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.

", + "UpdateNotebookInstanceInput$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

", "UpdatePipelineRequest$RoleArn": "

The Amazon Resource Name (ARN) that the pipeline uses to execute.

", "UserSettings$ExecutionRole": "

The execution role for the user.

" } @@ -9354,7 +9366,7 @@ "S3DataDistribution": { "base": null, "refs": { - "S3DataSource$S3DataDistributionType": "

If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

" + "S3DataSource$S3DataDistributionType": "

If you want SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

If you want SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

" } }, "S3DataSource": { @@ -9366,7 +9378,7 @@ "S3DataType": { "base": null, "refs": { - "S3DataSource$S3DataType": "

If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.

If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.

", + "S3DataSource$S3DataType": "

If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training.

If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.

", "TransformS3DataSource$S3DataType": "

If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.

The following values are compatible: ManifestFile, S3Prefix

The following value is not compatible: AugmentedManifestFile

" } }, @@ -9382,7 +9394,7 @@ "AthenaDatasetDefinition$OutputS3Uri": "

The location in Amazon S3 where Athena query results are stored.

", "AutoMLOutputDataConfig$S3OutputPath": "

The Amazon S3 output path. Must be 128 characters or less.

", "AutoMLS3DataSource$S3Uri": "

The URL to the Amazon S3 data source.

", - "CheckpointConfig$S3Uri": "

Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.

", + "CheckpointConfig$S3Uri": "

Identifies the S3 path where you want SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.

", "CreateLabelingJobRequest$LabelCategoryConfigS3Uri": "

The S3 URI of the file, referred to as a label category configuration file, that defines the categories used to label the data objects.

For 3D point cloud and video frame task types, you can add label category attributes and frame attributes to your label category configuration file. To learn how, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

For named entity recognition jobs, in addition to \"labels\", you must provide worker instructions in the label category configuration file using the \"instructions\" parameter: \"instructions\": {\"shortInstruction\":\"<h1>Add header</h1><p>Add Instructions</p>\", \"fullInstruction\":\"<p>Add additional instructions.</p>\"}. For details and an example, see Create a Named Entity Recognition Labeling Job (API) .

For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,...,label_n with your label categories.

{

\"document-version\": \"2018-11-28\",

\"labels\": [{\"label\": \"label_1\"},{\"label\": \"label_2\"},...{\"label\": \"label_n\"}]

}

Note the following about the label category configuration file:

", "CreateModelPackageInput$SamplePayloadUrl": "

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

", "DataQualityAppSpecification$RecordPreprocessorSourceUri": "

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

", @@ -9409,7 +9421,7 @@ "MonitoringConstraintsResource$S3Uri": "

The Amazon S3 URI for the constraints resource.

", "MonitoringStatisticsResource$S3Uri": "

The Amazon S3 URI for the statistics resource.

", "OutputConfig$S3OutputLocation": "

Identifies the S3 bucket where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

", - "OutputDataConfig$S3OutputPath": "

Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

", + "OutputDataConfig$S3OutputPath": "

Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

", "ProcessingS3Input$S3Uri": "

The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

", "ProcessingS3Output$S3Uri": "

A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.

", "ProfilerConfig$S3OutputPath": "

Path to Amazon S3 storage location for system and framework metrics.

", @@ -9417,7 +9429,7 @@ "ProfilerRuleConfiguration$S3OutputPath": "

Path to Amazon S3 storage location for rules.

", "RecommendationJobCompiledOutputConfig$S3OutputUri": "

Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.

", "RedshiftDatasetDefinition$OutputS3Uri": "

The location in Amazon S3 where the Redshift query results are stored.

", - "S3DataSource$S3Uri": "

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

", + "S3DataSource$S3Uri": "

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

", "S3StorageConfig$S3Uri": "

The S3 URI, or location in Amazon S3, of OfflineStore.

S3 URIs have a format similar to the following: s3://example-bucket/prefix/.

", "S3StorageConfig$ResolvedOutputS3Uri": "

The S3 path where offline records are written.

", "SharingSettings$S3OutputPath": "

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

", @@ -9505,13 +9517,13 @@ "SecondaryStatus": { "base": null, "refs": { - "DescribeTrainingJobResponse$SecondaryStatus": "

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress
Completed
Failed
Stopped
Stopping

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

", + "DescribeTrainingJobResponse$SecondaryStatus": "

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress
Completed
Failed
Stopped
Stopping

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

", "SecondaryStatusTransition$Status": "

Contains a secondary status information from a training job.

Status might be one of the following secondary statuses:

InProgress
Completed
Failed
Stopped
Stopping

We no longer support the following secondary statuses:

", - "TrainingJob$SecondaryStatus": "

Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress
Completed
Failed
Stopped
Stopping

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

" + "TrainingJob$SecondaryStatus": "

Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress
Completed
Failed
Stopped
Stopping

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

" } }, "SecondaryStatusTransition": { - "base": "

An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, Amazon SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.

", + "base": "

An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.

", "refs": { "SecondaryStatusTransitions$member": null } @@ -9765,7 +9777,7 @@ } }, "SourceAlgorithm": { - "base": "

Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

", + "base": "

Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

", "refs": { "SourceAlgorithmList$member": null } @@ -9850,7 +9862,7 @@ "StatusMessage": { "base": null, "refs": { - "SecondaryStatusTransition$StatusMessage": "

A detailed description of the progress within a secondary status.

Amazon SageMaker provides secondary statuses and status messages that apply to each of them:

Starting
Training

Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.

To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

" + "SecondaryStatusTransition$StatusMessage": "

A detailed description of the progress within a secondary status.

SageMaker provides secondary statuses and status messages that apply to each of them:

Starting
Training

Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.

To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

" } }, "StepDescription": { @@ -9943,15 +9955,15 @@ } }, "StoppingCondition": { - "base": "

Specifies a limit to how long a model training job or model compilation job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training or compilation job. Use this API to cap model training costs.

To stop a training job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by Amazon SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.

The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

", + "base": "

Specifies a limit to how long a model training job or model compilation job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training or compilation job. Use this API to cap model training costs.

To stop a training job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

The training algorithms provided by SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.

The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

", "refs": { "CreateCompilationJobRequest$StoppingCondition": "

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

", - "CreateTrainingJobRequest$StoppingCondition": "

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

", + "CreateTrainingJobRequest$StoppingCondition": "

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

", "DescribeCompilationJobResponse$StoppingCondition": "

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

", - "DescribeTrainingJobResponse$StoppingCondition": "

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

", - "HyperParameterTrainingJobDefinition$StoppingCondition": "

Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

", - "TrainingJob$StoppingCondition": "

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

", - "TrainingJobDefinition$StoppingCondition": "

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.

" + "DescribeTrainingJobResponse$StoppingCondition": "

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

", + "HyperParameterTrainingJobDefinition$StoppingCondition": "

Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

", + "TrainingJob$StoppingCondition": "

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

", + "TrainingJobDefinition$StoppingCondition": "

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.

" } }, "String": { @@ -10259,7 +10271,7 @@ "base": null, "refs": { "AddTagsInput$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", - "AddTagsOutput$Tags": "

A list of tags associated with the Amazon SageMaker resource.

", + "AddTagsOutput$Tags": "

A list of tags associated with the SageMaker resource.

", "CreateActionRequest$Tags": "

A list of tags to apply to the action.

", "CreateAlgorithmInput$Tags": "

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

", "CreateAppImageConfigRequest$Tags": "

A list of tags to apply to the AppImageConfig.

", @@ -10545,7 +10557,7 @@ "DescribeModelBiasJobDefinitionResponse$CreationTime": "

The time at which the model bias job was created.

", "DescribeModelExplainabilityJobDefinitionResponse$CreationTime": "

The time at which the model explainability job was created.

", "DescribeModelOutput$CreationTime": "

A timestamp that shows when the model was created.

", - "DescribeModelPackageOutput$LastModifiedTime": "

The last time the model package was modified.

", + "DescribeModelPackageOutput$LastModifiedTime": "

The last time that the model package was modified.

", "DescribeModelQualityJobDefinitionResponse$CreationTime": "

The time at which the model quality job was created.

", "DescribeMonitoringScheduleResponse$CreationTime": "

The time at which the monitoring job was created.

", "DescribeMonitoringScheduleResponse$LastModifiedTime": "

The time at which the monitoring job was last modified.

", @@ -10565,7 +10577,7 @@ "DescribeStudioLifecycleConfigResponse$LastModifiedTime": "

This value is equivalent to CreationTime because Studio Lifecycle Configurations are immutable.

", "DescribeTrainingJobResponse$CreationTime": "

A timestamp that indicates when the training job was created.

", "DescribeTrainingJobResponse$TrainingStartTime": "

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

", - "DescribeTrainingJobResponse$TrainingEndTime": "

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

", + "DescribeTrainingJobResponse$TrainingEndTime": "

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

", "DescribeTrainingJobResponse$LastModifiedTime": "

A timestamp that indicates when the status of the training job was last modified.

", "DescribeTransformJobResponse$CreationTime": "

A timestamp that shows when the transform Job was created.

", "DescribeTransformJobResponse$TransformStartTime": "

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

", @@ -10599,7 +10611,7 @@ "HumanTaskUiSummary$CreationTime": "

A timestamp when SageMaker created the human task user interface.

", "HyperParameterTrainingJobSummary$CreationTime": "

The date and time that the training job was created.

", "HyperParameterTrainingJobSummary$TrainingStartTime": "

The date and time that the training job started.

", - "HyperParameterTrainingJobSummary$TrainingEndTime": "

Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

", + "HyperParameterTrainingJobSummary$TrainingEndTime": "

Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

", "HyperParameterTuningJobSummary$CreationTime": "

The date and time that the tuning job was created.

", "HyperParameterTuningJobSummary$HyperParameterTuningEndTime": "

The date and time that the tuning job ended.

", "HyperParameterTuningJobSummary$LastModifiedTime": "

The date and time that the tuning job was modified.

", @@ -10763,7 +10775,7 @@ "StudioLifecycleConfigDetails$LastModifiedTime": "

This value is equivalent to CreationTime because Studio Lifecycle Configurations are immutable.

", "TrainingJob$CreationTime": "

A timestamp that indicates when the training job was created.

", "TrainingJob$TrainingStartTime": "

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

", - "TrainingJob$TrainingEndTime": "

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

", + "TrainingJob$TrainingEndTime": "

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

", "TrainingJob$LastModifiedTime": "

A timestamp that indicates when the status of the training job was last modified.

", "TrainingJobSummary$CreationTime": "

A timestamp that shows when the training job was created.

", "TrainingJobSummary$TrainingEndTime": "

A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).

", @@ -10850,7 +10862,7 @@ "base": "

The training input mode that the algorithm supports. For more information about input modes, see Algorithms.

Pipe mode

If an algorithm supports Pipe mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

File mode

If an algorithm supports File mode, SageMaker downloads the training data from S3 to the provisioned ML storage volume, and mounts the directory to the Docker volume for the training container.

You must provision the ML storage volume with sufficient capacity to accommodate the data downloaded from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container uses the ML storage volume to also store intermediate information, if any.

For distributed algorithms, training data is distributed uniformly. Your training duration is predictable if the input data objects sizes are approximately the same. SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed when one host in a training cluster is overloaded, thus becoming a bottleneck in training.

FastFile mode

If an algorithm supports FastFile mode, SageMaker streams data directly from S3 to the container with no code changes, and provides file system access to the data. Users can author their training script to interact with these files as if they were stored on disk.

FastFile mode works best when the data is read sequentially. Augmented manifest files aren't supported. The startup time is lower when there are fewer files in the S3 bucket provided.

", "refs": { "AlgorithmSpecification$TrainingInputMode": null, - "Channel$InputMode": "

(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

", + "Channel$InputMode": "

(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

", "HyperParameterAlgorithmSpecification$TrainingInputMode": null, "InputModes$member": null, "TrainingJobDefinition$TrainingInputMode": null @@ -10899,13 +10911,13 @@ "TrainingJobDefinition": { "base": "

Defines the input needed to run a training job using the algorithm.

", "refs": { - "AlgorithmValidationProfile$TrainingJobDefinition": "

The TrainingJobDefinition object that describes the training job that Amazon SageMaker runs to validate your algorithm.

" + "AlgorithmValidationProfile$TrainingJobDefinition": "

The TrainingJobDefinition object that describes the training job that SageMaker runs to validate your algorithm.

" } }, "TrainingJobEarlyStoppingType": { "base": null, "refs": { - "HyperParameterTuningJobConfig$TrainingJobEarlyStoppingType": "

Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. This can be one of the following values (the default value is OFF):

OFF

Training jobs launched by the hyperparameter tuning job do not use early stopping.

AUTO

Amazon SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

" + "HyperParameterTuningJobConfig$TrainingJobEarlyStoppingType": "

Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. This can be one of the following values (the default value is OFF):

OFF

Training jobs launched by the hyperparameter tuning job do not use early stopping.

AUTO

SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

" } }, "TrainingJobName": { @@ -10930,7 +10942,7 @@ "TrainingJobStatus": { "base": null, "refs": { - "DescribeTrainingJobResponse$TrainingJobStatus": "

The status of the training job.

Amazon SageMaker provides the following training job statuses:

For more detailed information, see SecondaryStatus.

", + "DescribeTrainingJobResponse$TrainingJobStatus": "

The status of the training job.

SageMaker provides the following training job statuses:

For more detailed information, see SecondaryStatus.

", "HyperParameterTrainingJobSummary$TrainingJobStatus": "

The status of the training job.

", "ListTrainingJobsForHyperParameterTuningJobRequest$StatusEquals": "

A filter that returns only training jobs with the specified status.

", "ListTrainingJobsRequest$StatusEquals": "

A filter that retrieves only training jobs with a specific status.

", @@ -11062,7 +11074,7 @@ "TransformJobDefinition": { "base": "

Defines the input needed to run a transform job using the inference specification specified in the algorithm.

", "refs": { - "AlgorithmValidationProfile$TransformJobDefinition": "

The TransformJobDefinition object that describes the transform job that Amazon SageMaker runs to validate your algorithm.

", + "AlgorithmValidationProfile$TransformJobDefinition": "

The TransformJobDefinition object that describes the transform job that SageMaker runs to validate your algorithm.

", "ModelPackageValidationProfile$TransformJobDefinition": "

The TransformJobDefinition object that describes the transform job used for the validation of the model package.

" } }, @@ -11609,7 +11621,7 @@ "base": null, "refs": { "AutoMLContainerDefinition$ModelDataUrl": "

The location of the model artifacts. For more information, see .

", - "ContainerDefinition$ModelDataUrl": "

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.

If you provide a value for this parameter, Amazon SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your IAM user account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

", + "ContainerDefinition$ModelDataUrl": "

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.

If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your IAM user account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

", "ModelPackageContainerDefinition$ModelDataUrl": "

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same region as the model package.

", "SourceAlgorithm$ModelDataUrl": "

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same region as the algorithm.

" } @@ -11724,6 +11736,12 @@ "UpdateUserProfileRequest$UserSettings": "

A collection of settings.

" } }, + "ValidationFraction": { + "base": null, + "refs": { + "AutoMLDataSplitConfig$ValidationFraction": "

The validation fraction (optional) is a float that specifies the portion of the training dataset to be used for validation. The default value is 0.2, and values can range from 0 to 1. We recommend setting this value to be less than 0.5.

" + } + }, "VariantName": { "base": null, "refs": { @@ -11803,7 +11821,7 @@ "VolumeSizeInGB": { "base": null, "refs": { - "ResourceConfig$VolumeSizeInGB": "

The size of the ML storage volume that you want to provision.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

You must specify sufficient ML storage for your scenario.

Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.

Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.

For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.

" + "ResourceConfig$VolumeSizeInGB": "

The size of the ML storage volume that you want to provision.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

You must specify sufficient ML storage for your scenario.

SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.

Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.

For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.

" } }, "VpcConfig": { diff --git a/service/amplify/api.go b/service/amplify/api.go index a3047212e8c..5d464e44d71 100644 --- a/service/amplify/api.go +++ b/service/amplify/api.go @@ -3426,10 +3426,13 @@ type App struct { // Repository is a required field Repository *string `locationName:"repository" type:"string" required:"true"` - // The authentication protocol to use to access the Git repository for an Amplify - // app. For a GitHub repository, specify TOKEN. For an Amazon Web Services CodeCommit - // repository, specify SIGV4. For GitLab and Bitbucket repositories, specify - // SSH. + // + // This is for internal use. + // + // The Amplify service uses this parameter to specify the authentication protocol + // to use to access the Git repository for an Amplify app. Amplify specifies + // TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit + // repository, and SSH for GitLab and Bitbucket repositories. RepositoryCloneMethod *string `locationName:"repositoryCloneMethod" type:"string" enum:"RepositoryCloneMethod"` // The tag for the Amplify app. @@ -4260,9 +4263,20 @@ func (s *Branch) SetUpdateTime(v time.Time) *Branch { type CreateAppInput struct { _ struct{} `type:"structure"` - // The personal access token for a third-party source control system for an - // Amplify app. The personal access token is used to create a webhook and a - // read-only deploy key. The token is not stored. + // The personal access token for a GitHub repository for an Amplify app. The + // personal access token is used to authorize access to a GitHub repository + // using the Amplify GitHub App. The token is not stored. + // + // Use accessToken for GitHub repositories only. To authorize access to a repository + // provider such as Bitbucket or CodeCommit, use oauthToken. + // + // You must specify either accessToken or oauthToken when you create a new app. + // + // Existing Amplify apps deployed from a GitHub repository using OAuth continue + // to work with CI/CD. However, we strongly recommend that you migrate these + // apps to use the GitHub App. For more information, see Migrating an existing + // OAuth app to the Amplify GitHub App (https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth) + // in the Amplify User Guide . // // AccessToken is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CreateAppInput's @@ -4326,8 +4340,20 @@ type CreateAppInput struct { Name *string `locationName:"name" min:"1" type:"string" required:"true"` // The OAuth token for a third-party source control system for an Amplify app. - // The OAuth token is used to create a webhook and a read-only deploy key. The - // OAuth token is not stored. + // The OAuth token is used to create a webhook and a read-only deploy key using + // SSH cloning. The OAuth token is not stored. + // + // Use oauthToken for repository providers other than GitHub, such as Bitbucket + // or CodeCommit. To authorize access to GitHub as your repository provider, + // use accessToken. + // + // You must specify either oauthToken or accessToken when you create a new app. + // + // Existing Amplify apps deployed from a GitHub repository using OAuth continue + // to work with CI/CD. However, we strongly recommend that you migrate these + // apps to use the GitHub App. For more information, see Migrating an existing + // OAuth app to the Amplify GitHub App (https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth) + // in the Amplify User Guide . // // OauthToken is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CreateAppInput's @@ -9310,9 +9336,20 @@ func (s UntagResourceOutput) GoString() string { type UpdateAppInput struct { _ struct{} `type:"structure"` - // The personal access token for a third-party source control system for an - // Amplify app. The token is used to create webhook and a read-only deploy key. - // The token is not stored. + // The personal access token for a GitHub repository for an Amplify app. The + // personal access token is used to authorize access to a GitHub repository + // using the Amplify GitHub App. The token is not stored. + // + // Use accessToken for GitHub repositories only. To authorize access to a repository + // provider such as Bitbucket or CodeCommit, use oauthToken. + // + // You must specify either accessToken or oauthToken when you update an app. + // + // Existing Amplify apps deployed from a GitHub repository using OAuth continue + // to work with CI/CD. However, we strongly recommend that you migrate these + // apps to use the GitHub App. For more information, see Migrating an existing + // OAuth app to the Amplify GitHub App (https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth) + // in the Amplify User Guide . // // AccessToken is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by UpdateAppInput's @@ -9378,8 +9415,21 @@ type UpdateAppInput struct { Name *string `locationName:"name" min:"1" type:"string"` // The OAuth token for a third-party source control system for an Amplify app. - // The token is used to create a webhook and a read-only deploy key. The OAuth - // token is not stored. + // The OAuth token is used to create a webhook and a read-only deploy key using + // SSH cloning. The OAuth token is not stored. + // + // Use oauthToken for repository providers other than GitHub, such as Bitbucket + // or CodeCommit. + // + // To authorize access to GitHub as your repository provider, use accessToken. + // + // You must specify either oauthToken or accessToken when you update an app. + // + // Existing Amplify apps deployed from a GitHub repository using OAuth continue + // to work with CI/CD. However, we strongly recommend that you migrate these + // apps to use the GitHub App. For more information, see Migrating an existing + // OAuth app to the Amplify GitHub App (https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth) + // in the Amplify User Guide . // // OauthToken is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by UpdateAppInput's diff --git a/service/chimesdkmediapipelines/api.go b/service/chimesdkmediapipelines/api.go new file mode 100644 index 00000000000..359b7d67ec2 --- /dev/null +++ b/service/chimesdkmediapipelines/api.go @@ -0,0 +1,2798 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package chimesdkmediapipelines + +import ( + "fmt" + "time" + + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/awsutil" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/restjson" +) + +const opCreateMediaCapturePipeline = "CreateMediaCapturePipeline" + +// CreateMediaCapturePipelineRequest generates a "aws/request.Request" representing the +// client's request for the CreateMediaCapturePipeline operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateMediaCapturePipeline for more information on using the CreateMediaCapturePipeline +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateMediaCapturePipelineRequest method. +// req, resp := client.CreateMediaCapturePipelineRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaCapturePipeline +func (c *ChimeSDKMediaPipelines) CreateMediaCapturePipelineRequest(input *CreateMediaCapturePipelineInput) (req *request.Request, output *CreateMediaCapturePipelineOutput) { + op := &request.Operation{ + Name: opCreateMediaCapturePipeline, + HTTPMethod: "POST", + HTTPPath: "/sdk-media-capture-pipelines", + } + + if input == nil { + input = &CreateMediaCapturePipelineInput{} + } + + output = &CreateMediaCapturePipelineOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateMediaCapturePipeline API operation for Amazon Chime SDK Media Pipelines. +// +// Creates a media capture pipeline. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Chime SDK Media Pipelines's +// API operation CreateMediaCapturePipeline for usage and error information. +// +// Returned Error Types: +// * BadRequestException +// The input parameters don't match the service's restrictions. +// +// * ForbiddenException +// The client is permanently forbidden from making the request. +// +// * UnauthorizedClientException +// The client is not currently authorized to make the request. +// +// * ThrottledClientException +// The client exceeded its request rate limit. +// +// * ResourceLimitExceededException +// The request exceeds the resource limit. +// +// * ServiceUnavailableException +// The service is currently unavailable. +// +// * ServiceFailureException +// The service encountered an unexpected error. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/CreateMediaCapturePipeline +func (c *ChimeSDKMediaPipelines) CreateMediaCapturePipeline(input *CreateMediaCapturePipelineInput) (*CreateMediaCapturePipelineOutput, error) { + req, out := c.CreateMediaCapturePipelineRequest(input) + return out, req.Send() +} + +// CreateMediaCapturePipelineWithContext is the same as CreateMediaCapturePipeline with the addition of +// the ability to pass a context and additional request options. +// +// See CreateMediaCapturePipeline for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ChimeSDKMediaPipelines) CreateMediaCapturePipelineWithContext(ctx aws.Context, input *CreateMediaCapturePipelineInput, opts ...request.Option) (*CreateMediaCapturePipelineOutput, error) { + req, out := c.CreateMediaCapturePipelineRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteMediaCapturePipeline = "DeleteMediaCapturePipeline" + +// DeleteMediaCapturePipelineRequest generates a "aws/request.Request" representing the +// client's request for the DeleteMediaCapturePipeline operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteMediaCapturePipeline for more information on using the DeleteMediaCapturePipeline +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteMediaCapturePipelineRequest method. +// req, resp := client.DeleteMediaCapturePipelineRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/DeleteMediaCapturePipeline +func (c *ChimeSDKMediaPipelines) DeleteMediaCapturePipelineRequest(input *DeleteMediaCapturePipelineInput) (req *request.Request, output *DeleteMediaCapturePipelineOutput) { + op := &request.Operation{ + Name: opDeleteMediaCapturePipeline, + HTTPMethod: "DELETE", + HTTPPath: "/sdk-media-capture-pipelines/{mediaPipelineId}", + } + + if input == nil { + input = &DeleteMediaCapturePipelineInput{} + } + + output = &DeleteMediaCapturePipelineOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteMediaCapturePipeline API operation for Amazon Chime SDK Media Pipelines. +// +// Deletes the media capture pipeline. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Chime SDK Media Pipelines's +// API operation DeleteMediaCapturePipeline for usage and error information. +// +// Returned Error Types: +// * BadRequestException +// The input parameters don't match the service's restrictions. +// +// * ForbiddenException +// The client is permanently forbidden from making the request. +// +// * ThrottledClientException +// The client exceeded its request rate limit. +// +// * NotFoundException +// One or more of the resources in the request does not exist in the system. +// +// * UnauthorizedClientException +// The client is not currently authorized to make the request. +// +// * ServiceUnavailableException +// The service is currently unavailable. +// +// * ServiceFailureException +// The service encountered an unexpected error. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/DeleteMediaCapturePipeline +func (c *ChimeSDKMediaPipelines) DeleteMediaCapturePipeline(input *DeleteMediaCapturePipelineInput) (*DeleteMediaCapturePipelineOutput, error) { + req, out := c.DeleteMediaCapturePipelineRequest(input) + return out, req.Send() +} + +// DeleteMediaCapturePipelineWithContext is the same as DeleteMediaCapturePipeline with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteMediaCapturePipeline for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ChimeSDKMediaPipelines) DeleteMediaCapturePipelineWithContext(ctx aws.Context, input *DeleteMediaCapturePipelineInput, opts ...request.Option) (*DeleteMediaCapturePipelineOutput, error) { + req, out := c.DeleteMediaCapturePipelineRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetMediaCapturePipeline = "GetMediaCapturePipeline" + +// GetMediaCapturePipelineRequest generates a "aws/request.Request" representing the +// client's request for the GetMediaCapturePipeline operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetMediaCapturePipeline for more information on using the GetMediaCapturePipeline +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetMediaCapturePipelineRequest method. +// req, resp := client.GetMediaCapturePipelineRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/GetMediaCapturePipeline +func (c *ChimeSDKMediaPipelines) GetMediaCapturePipelineRequest(input *GetMediaCapturePipelineInput) (req *request.Request, output *GetMediaCapturePipelineOutput) { + op := &request.Operation{ + Name: opGetMediaCapturePipeline, + HTTPMethod: "GET", + HTTPPath: "/sdk-media-capture-pipelines/{mediaPipelineId}", + } + + if input == nil { + input = &GetMediaCapturePipelineInput{} + } + + output = &GetMediaCapturePipelineOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetMediaCapturePipeline API operation for Amazon Chime SDK Media Pipelines. +// +// Gets an existing media capture pipeline. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Chime SDK Media Pipelines's +// API operation GetMediaCapturePipeline for usage and error information. +// +// Returned Error Types: +// * BadRequestException +// The input parameters don't match the service's restrictions. +// +// * ForbiddenException +// The client is permanently forbidden from making the request. +// +// * UnauthorizedClientException +// The client is not currently authorized to make the request. +// +// * ThrottledClientException +// The client exceeded its request rate limit. +// +// * NotFoundException +// One or more of the resources in the request does not exist in the system. +// +// * ServiceUnavailableException +// The service is currently unavailable. +// +// * ServiceFailureException +// The service encountered an unexpected error. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/GetMediaCapturePipeline +func (c *ChimeSDKMediaPipelines) GetMediaCapturePipeline(input *GetMediaCapturePipelineInput) (*GetMediaCapturePipelineOutput, error) { + req, out := c.GetMediaCapturePipelineRequest(input) + return out, req.Send() +} + +// GetMediaCapturePipelineWithContext is the same as GetMediaCapturePipeline with the addition of +// the ability to pass a context and additional request options. +// +// See GetMediaCapturePipeline for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ChimeSDKMediaPipelines) GetMediaCapturePipelineWithContext(ctx aws.Context, input *GetMediaCapturePipelineInput, opts ...request.Option) (*GetMediaCapturePipelineOutput, error) { + req, out := c.GetMediaCapturePipelineRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opListMediaCapturePipelines = "ListMediaCapturePipelines" + +// ListMediaCapturePipelinesRequest generates a "aws/request.Request" representing the +// client's request for the ListMediaCapturePipelines operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListMediaCapturePipelines for more information on using the ListMediaCapturePipelines +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListMediaCapturePipelinesRequest method. +// req, resp := client.ListMediaCapturePipelinesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListMediaCapturePipelines +func (c *ChimeSDKMediaPipelines) ListMediaCapturePipelinesRequest(input *ListMediaCapturePipelinesInput) (req *request.Request, output *ListMediaCapturePipelinesOutput) { + op := &request.Operation{ + Name: opListMediaCapturePipelines, + HTTPMethod: "GET", + HTTPPath: "/sdk-media-capture-pipelines", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListMediaCapturePipelinesInput{} + } + + output = &ListMediaCapturePipelinesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListMediaCapturePipelines API operation for Amazon Chime SDK Media Pipelines. +// +// Returns a list of media capture pipelines. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Chime SDK Media Pipelines's +// API operation ListMediaCapturePipelines for usage and error information. +// +// Returned Error Types: +// * BadRequestException +// The input parameters don't match the service's restrictions. +// +// * ForbiddenException +// The client is permanently forbidden from making the request. +// +// * UnauthorizedClientException +// The client is not currently authorized to make the request. +// +// * ThrottledClientException +// The client exceeded its request rate limit. +// +// * ResourceLimitExceededException +// The request exceeds the resource limit. +// +// * ServiceUnavailableException +// The service is currently unavailable. +// +// * ServiceFailureException +// The service encountered an unexpected error. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListMediaCapturePipelines +func (c *ChimeSDKMediaPipelines) ListMediaCapturePipelines(input *ListMediaCapturePipelinesInput) (*ListMediaCapturePipelinesOutput, error) { + req, out := c.ListMediaCapturePipelinesRequest(input) + return out, req.Send() +} + +// ListMediaCapturePipelinesWithContext is the same as ListMediaCapturePipelines with the addition of +// the ability to pass a context and additional request options. +// +// See ListMediaCapturePipelines for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ChimeSDKMediaPipelines) ListMediaCapturePipelinesWithContext(ctx aws.Context, input *ListMediaCapturePipelinesInput, opts ...request.Option) (*ListMediaCapturePipelinesOutput, error) { + req, out := c.ListMediaCapturePipelinesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListMediaCapturePipelinesPages iterates over the pages of a ListMediaCapturePipelines operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListMediaCapturePipelines method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListMediaCapturePipelines operation. +// pageNum := 0 +// err := client.ListMediaCapturePipelinesPages(params, +// func(page *chimesdkmediapipelines.ListMediaCapturePipelinesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ChimeSDKMediaPipelines) ListMediaCapturePipelinesPages(input *ListMediaCapturePipelinesInput, fn func(*ListMediaCapturePipelinesOutput, bool) bool) error { + return c.ListMediaCapturePipelinesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListMediaCapturePipelinesPagesWithContext same as ListMediaCapturePipelinesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ChimeSDKMediaPipelines) ListMediaCapturePipelinesPagesWithContext(ctx aws.Context, input *ListMediaCapturePipelinesInput, fn func(*ListMediaCapturePipelinesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListMediaCapturePipelinesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListMediaCapturePipelinesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListMediaCapturePipelinesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListTagsForResource = "ListTagsForResource" + +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListTagsForResource for more information on using the ListTagsForResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListTagsForResource +func (c *ChimeSDKMediaPipelines) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { + op := &request.Operation{ + Name: opListTagsForResource, + HTTPMethod: "GET", + HTTPPath: "/tags", + } + + if input == nil { + input = &ListTagsForResourceInput{} + } + + output = &ListTagsForResourceOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListTagsForResource API operation for Amazon Chime SDK Media Pipelines. +// +// Lists the tags applied to an Amazon Chime SDK media capture pipeline. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Chime SDK Media Pipelines's +// API operation ListTagsForResource for usage and error information. +// +// Returned Error Types: +// * NotFoundException +// One or more of the resources in the request does not exist in the system. +// +// * BadRequestException +// The input parameters don't match the service's restrictions. +// +// * ForbiddenException +// The client is permanently forbidden from making the request. +// +// * UnauthorizedClientException +// The client is not currently authorized to make the request. +// +// * ThrottledClientException +// The client exceeded its request rate limit. +// +// * ServiceUnavailableException +// The service is currently unavailable. +// +// * ServiceFailureException +// The service encountered an unexpected error. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/ListTagsForResource +func (c *ChimeSDKMediaPipelines) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + return out, req.Send() +} + +// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of +// the ability to pass a context and additional request options. +// +// See ListTagsForResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ChimeSDKMediaPipelines) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opTagResource = "TagResource" + +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See TagResource for more information on using the TagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the TagResourceRequest method. +// req, resp := client.TagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/TagResource +func (c *ChimeSDKMediaPipelines) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { + op := &request.Operation{ + Name: opTagResource, + HTTPMethod: "POST", + HTTPPath: "/tags?operation=tag-resource", + } + + if input == nil { + input = &TagResourceInput{} + } + + output = &TagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// TagResource API operation for Amazon Chime SDK Media Pipelines. +// +// Applies the specified tags to the specified Amazon Chime SDK media capture +// pipeline. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Chime SDK Media Pipelines's +// API operation TagResource for usage and error information. +// +// Returned Error Types: +// * NotFoundException +// One or more of the resources in the request does not exist in the system. +// +// * BadRequestException +// The input parameters don't match the service's restrictions. +// +// * ForbiddenException +// The client is permanently forbidden from making the request. +// +// * UnauthorizedClientException +// The client is not currently authorized to make the request. +// +// * ThrottledClientException +// The client exceeded its request rate limit. +// +// * ServiceUnavailableException +// The service is currently unavailable. +// +// * ServiceFailureException +// The service encountered an unexpected error. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/TagResource +func (c *ChimeSDKMediaPipelines) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + return out, req.Send() +} + +// TagResourceWithContext is the same as TagResource with the addition of +// the ability to pass a context and additional request options. +// +// See TagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ChimeSDKMediaPipelines) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUntagResource = "UntagResource" + +// UntagResourceRequest generates a "aws/request.Request" representing the +// client's request for the UntagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UntagResource for more information on using the UntagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UntagResourceRequest method. +// req, resp := client.UntagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/UntagResource +func (c *ChimeSDKMediaPipelines) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "POST", + HTTPPath: "/tags?operation=untag-resource", + } + + if input == nil { + input = &UntagResourceInput{} + } + + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UntagResource API operation for Amazon Chime SDK Media Pipelines. +// +// Removes the specified tags from the specified Amazon Chime SDK media capture +// pipeline. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Chime SDK Media Pipelines's +// API operation UntagResource for usage and error information. +// +// Returned Error Types: +// * NotFoundException +// One or more of the resources in the request does not exist in the system. +// +// * BadRequestException +// The input parameters don't match the service's restrictions. +// +// * ForbiddenException +// The client is permanently forbidden from making the request. +// +// * UnauthorizedClientException +// The client is not currently authorized to make the request. +// +// * ThrottledClientException +// The client exceeded its request rate limit. +// +// * ServiceUnavailableException +// The service is currently unavailable. +// +// * ServiceFailureException +// The service encountered an unexpected error. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15/UntagResource +func (c *ChimeSDKMediaPipelines) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() +} + +// UntagResourceWithContext is the same as UntagResource with the addition of +// the ability to pass a context and additional request options. +// +// See UntagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ChimeSDKMediaPipelines) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// The configuration for the artifacts. +type ArtifactsConfiguration struct { + _ struct{} `type:"structure"` + + // The configuration for the audio artifacts. + // + // Audio is a required field + Audio *AudioArtifactsConfiguration `type:"structure" required:"true"` + + // The configuration for the content artifacts. + // + // Content is a required field + Content *ContentArtifactsConfiguration `type:"structure" required:"true"` + + // The configuration for the video artifacts. + // + // Video is a required field + Video *VideoArtifactsConfiguration `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ArtifactsConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ArtifactsConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ArtifactsConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ArtifactsConfiguration"} + if s.Audio == nil { + invalidParams.Add(request.NewErrParamRequired("Audio")) + } + if s.Content == nil { + invalidParams.Add(request.NewErrParamRequired("Content")) + } + if s.Video == nil { + invalidParams.Add(request.NewErrParamRequired("Video")) + } + if s.Audio != nil { + if err := s.Audio.Validate(); err != nil { + invalidParams.AddNested("Audio", err.(request.ErrInvalidParams)) + } + } + if s.Content != nil { + if err := s.Content.Validate(); err != nil { + invalidParams.AddNested("Content", err.(request.ErrInvalidParams)) + } + } + if s.Video != nil { + if err := s.Video.Validate(); err != nil { + invalidParams.AddNested("Video", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAudio sets the Audio field's value. +func (s *ArtifactsConfiguration) SetAudio(v *AudioArtifactsConfiguration) *ArtifactsConfiguration { + s.Audio = v + return s +} + +// SetContent sets the Content field's value. +func (s *ArtifactsConfiguration) SetContent(v *ContentArtifactsConfiguration) *ArtifactsConfiguration { + s.Content = v + return s +} + +// SetVideo sets the Video field's value. +func (s *ArtifactsConfiguration) SetVideo(v *VideoArtifactsConfiguration) *ArtifactsConfiguration { + s.Video = v + return s +} + +// The audio artifact configuration object. +type AudioArtifactsConfiguration struct { + _ struct{} `type:"structure"` + + // The MUX type of the audio artifact configuration object. + // + // MuxType is a required field + MuxType *string `type:"string" required:"true" enum:"AudioMuxType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AudioArtifactsConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AudioArtifactsConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AudioArtifactsConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AudioArtifactsConfiguration"} + if s.MuxType == nil { + invalidParams.Add(request.NewErrParamRequired("MuxType")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMuxType sets the MuxType field's value. +func (s *AudioArtifactsConfiguration) SetMuxType(v string) *AudioArtifactsConfiguration { + s.MuxType = &v + return s +} + +// The input parameters don't match the service's restrictions. +type BadRequestException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"` + + Message_ *string `locationName:"Message" type:"string"` + + // The request id associated with the call responsible for the exception. + RequestId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BadRequestException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BadRequestException) GoString() string { + return s.String() +} + +func newErrorBadRequestException(v protocol.ResponseMetadata) error { + return &BadRequestException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *BadRequestException) Code() string { + return "BadRequestException" +} + +// Message returns the exception's message. +func (s *BadRequestException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *BadRequestException) OrigErr() error { + return nil +} + +func (s *BadRequestException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *BadRequestException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *BadRequestException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The configuration object of the Amazon Chime SDK meeting for a specified +// media capture pipeline. SourceType must be ChimeSdkMeeting. +type ChimeSdkMeetingConfiguration struct { + _ struct{} `type:"structure"` + + // The configuration for the artifacts in an Amazon Chime SDK meeting. + ArtifactsConfiguration *ArtifactsConfiguration `type:"structure"` + + // The source configuration for a specified media capture pipline. + SourceConfiguration *SourceConfiguration `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ChimeSdkMeetingConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ChimeSdkMeetingConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ChimeSdkMeetingConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ChimeSdkMeetingConfiguration"} + if s.ArtifactsConfiguration != nil { + if err := s.ArtifactsConfiguration.Validate(); err != nil { + invalidParams.AddNested("ArtifactsConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.SourceConfiguration != nil { + if err := s.SourceConfiguration.Validate(); err != nil { + invalidParams.AddNested("SourceConfiguration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetArtifactsConfiguration sets the ArtifactsConfiguration field's value. +func (s *ChimeSdkMeetingConfiguration) SetArtifactsConfiguration(v *ArtifactsConfiguration) *ChimeSdkMeetingConfiguration { + s.ArtifactsConfiguration = v + return s +} + +// SetSourceConfiguration sets the SourceConfiguration field's value. +func (s *ChimeSdkMeetingConfiguration) SetSourceConfiguration(v *SourceConfiguration) *ChimeSdkMeetingConfiguration { + s.SourceConfiguration = v + return s +} + +// The content artifact object. +type ContentArtifactsConfiguration struct { + _ struct{} `type:"structure"` + + // The MUX type of the artifact configuration. + MuxType *string `type:"string" enum:"ContentMuxType"` + + // Indicates whether the content artifact is enabled or disabled. + // + // State is a required field + State *string `type:"string" required:"true" enum:"ArtifactsState"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ContentArtifactsConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ContentArtifactsConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ContentArtifactsConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ContentArtifactsConfiguration"} + if s.State == nil { + invalidParams.Add(request.NewErrParamRequired("State")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMuxType sets the MuxType field's value. +func (s *ContentArtifactsConfiguration) SetMuxType(v string) *ContentArtifactsConfiguration { + s.MuxType = &v + return s +} + +// SetState sets the State field's value. +func (s *ContentArtifactsConfiguration) SetState(v string) *ContentArtifactsConfiguration { + s.State = &v + return s +} + +type CreateMediaCapturePipelineInput struct { + _ struct{} `type:"structure"` + + // The configuration for a specified media capture pipeline. SourceType must + // be ChimeSdkMeeting. + ChimeSdkMeetingConfiguration *ChimeSdkMeetingConfiguration `type:"structure"` + + // The token assigned to the client making the pipeline request. + // + // ClientRequestToken is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateMediaCapturePipelineInput's + // String and GoString methods. + ClientRequestToken *string `min:"2" type:"string" idempotencyToken:"true" sensitive:"true"` + + // The ARN of the sink type. + // + // SinkArn is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateMediaCapturePipelineInput's + // String and GoString methods. + // + // SinkArn is a required field + SinkArn *string `min:"1" type:"string" required:"true" sensitive:"true"` + + // Destination type to which the media artifacts are saved. You must use an + // S3 bucket. + // + // SinkType is a required field + SinkType *string `type:"string" required:"true" enum:"MediaPipelineSinkType"` + + // ARN of the source from which the media artifacts are captured. + // + // SourceArn is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateMediaCapturePipelineInput's + // String and GoString methods. + // + // SourceArn is a required field + SourceArn *string `min:"1" type:"string" required:"true" sensitive:"true"` + + // Source type from which the media artifacts are captured. A Chime SDK Meeting + // is the only supported source. + // + // SourceType is a required field + SourceType *string `type:"string" required:"true" enum:"MediaPipelineSourceType"` + + // The list of tags. + Tags []*Tag `min:"1" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateMediaCapturePipelineInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateMediaCapturePipelineInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateMediaCapturePipelineInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateMediaCapturePipelineInput"} + if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 2 { + invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 2)) + } + if s.SinkArn == nil { + invalidParams.Add(request.NewErrParamRequired("SinkArn")) + } + if s.SinkArn != nil && len(*s.SinkArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SinkArn", 1)) + } + if s.SinkType == nil { + invalidParams.Add(request.NewErrParamRequired("SinkType")) + } + if s.SourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("SourceArn")) + } + if s.SourceArn != nil && len(*s.SourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SourceArn", 1)) + } + if s.SourceType == nil { + invalidParams.Add(request.NewErrParamRequired("SourceType")) + } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.ChimeSdkMeetingConfiguration != nil { + if err := s.ChimeSdkMeetingConfiguration.Validate(); err != nil { + invalidParams.AddNested("ChimeSdkMeetingConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetChimeSdkMeetingConfiguration sets the ChimeSdkMeetingConfiguration field's value. +func (s *CreateMediaCapturePipelineInput) SetChimeSdkMeetingConfiguration(v *ChimeSdkMeetingConfiguration) *CreateMediaCapturePipelineInput { + s.ChimeSdkMeetingConfiguration = v + return s +} + +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *CreateMediaCapturePipelineInput) SetClientRequestToken(v string) *CreateMediaCapturePipelineInput { + s.ClientRequestToken = &v + return s +} + +// SetSinkArn sets the SinkArn field's value. +func (s *CreateMediaCapturePipelineInput) SetSinkArn(v string) *CreateMediaCapturePipelineInput { + s.SinkArn = &v + return s +} + +// SetSinkType sets the SinkType field's value. +func (s *CreateMediaCapturePipelineInput) SetSinkType(v string) *CreateMediaCapturePipelineInput { + s.SinkType = &v + return s +} + +// SetSourceArn sets the SourceArn field's value. +func (s *CreateMediaCapturePipelineInput) SetSourceArn(v string) *CreateMediaCapturePipelineInput { + s.SourceArn = &v + return s +} + +// SetSourceType sets the SourceType field's value. +func (s *CreateMediaCapturePipelineInput) SetSourceType(v string) *CreateMediaCapturePipelineInput { + s.SourceType = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateMediaCapturePipelineInput) SetTags(v []*Tag) *CreateMediaCapturePipelineInput { + s.Tags = v + return s +} + +type CreateMediaCapturePipelineOutput struct { + _ struct{} `type:"structure"` + + // A media capture pipeline object, the ID, source type, source ARN, sink type, + // and sink ARN of a media capture pipeline object. + MediaCapturePipeline *MediaCapturePipeline `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateMediaCapturePipelineOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateMediaCapturePipelineOutput) GoString() string { + return s.String() +} + +// SetMediaCapturePipeline sets the MediaCapturePipeline field's value. +func (s *CreateMediaCapturePipelineOutput) SetMediaCapturePipeline(v *MediaCapturePipeline) *CreateMediaCapturePipelineOutput { + s.MediaCapturePipeline = v + return s +} + +type DeleteMediaCapturePipelineInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ID of the media capture pipeline being deleted. + // + // MediaPipelineId is a required field + MediaPipelineId *string `location:"uri" locationName:"mediaPipelineId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteMediaCapturePipelineInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteMediaCapturePipelineInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteMediaCapturePipelineInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteMediaCapturePipelineInput"} + if s.MediaPipelineId == nil { + invalidParams.Add(request.NewErrParamRequired("MediaPipelineId")) + } + if s.MediaPipelineId != nil && len(*s.MediaPipelineId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("MediaPipelineId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMediaPipelineId sets the MediaPipelineId field's value. +func (s *DeleteMediaCapturePipelineInput) SetMediaPipelineId(v string) *DeleteMediaCapturePipelineInput { + s.MediaPipelineId = &v + return s +} + +type DeleteMediaCapturePipelineOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteMediaCapturePipelineOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteMediaCapturePipelineOutput) GoString() string { + return s.String() +} + +// The client is permanently forbidden from making the request. +type ForbiddenException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"` + + Message_ *string `locationName:"Message" type:"string"` + + // The request id associated with the call responsible for the exception. + RequestId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ForbiddenException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ForbiddenException) GoString() string { + return s.String() +} + +func newErrorForbiddenException(v protocol.ResponseMetadata) error { + return &ForbiddenException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ForbiddenException) Code() string { + return "ForbiddenException" +} + +// Message returns the exception's message. +func (s *ForbiddenException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ForbiddenException) OrigErr() error { + return nil +} + +func (s *ForbiddenException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ForbiddenException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ForbiddenException) RequestID() string { + return s.RespMetadata.RequestID +} + +type GetMediaCapturePipelineInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The ID of the pipeline that you want to get. + // + // MediaPipelineId is a required field + MediaPipelineId *string `location:"uri" locationName:"mediaPipelineId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetMediaCapturePipelineInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetMediaCapturePipelineInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetMediaCapturePipelineInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetMediaCapturePipelineInput"} + if s.MediaPipelineId == nil { + invalidParams.Add(request.NewErrParamRequired("MediaPipelineId")) + } + if s.MediaPipelineId != nil && len(*s.MediaPipelineId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("MediaPipelineId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMediaPipelineId sets the MediaPipelineId field's value. +func (s *GetMediaCapturePipelineInput) SetMediaPipelineId(v string) *GetMediaCapturePipelineInput { + s.MediaPipelineId = &v + return s +} + +type GetMediaCapturePipelineOutput struct { + _ struct{} `type:"structure"` + + // The media capture pipeline object. + MediaCapturePipeline *MediaCapturePipeline `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetMediaCapturePipelineOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetMediaCapturePipelineOutput) GoString() string { + return s.String() +} + +// SetMediaCapturePipeline sets the MediaCapturePipeline field's value. +func (s *GetMediaCapturePipelineOutput) SetMediaCapturePipeline(v *MediaCapturePipeline) *GetMediaCapturePipelineOutput { + s.MediaCapturePipeline = v + return s +} + +type ListMediaCapturePipelinesInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The maximum number of results to return in a single call. Valid Range: 1 + // - 99. + MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` + + // The token used to retrieve the next page of results. + NextToken *string `location:"querystring" locationName:"next-token" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListMediaCapturePipelinesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListMediaCapturePipelinesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListMediaCapturePipelinesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListMediaCapturePipelinesInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListMediaCapturePipelinesInput) SetMaxResults(v int64) *ListMediaCapturePipelinesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListMediaCapturePipelinesInput) SetNextToken(v string) *ListMediaCapturePipelinesInput { + s.NextToken = &v + return s +} + +type ListMediaCapturePipelinesOutput struct { + _ struct{} `type:"structure"` + + // The media capture pipeline objects in the list. + MediaCapturePipelines []*MediaCapturePipelineSummary `type:"list"` + + // The token used to retrieve the next page of results. + NextToken *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListMediaCapturePipelinesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListMediaCapturePipelinesOutput) GoString() string { + return s.String() +} + +// SetMediaCapturePipelines sets the MediaCapturePipelines field's value. +func (s *ListMediaCapturePipelinesOutput) SetMediaCapturePipelines(v []*MediaCapturePipelineSummary) *ListMediaCapturePipelinesOutput { + s.MediaCapturePipelines = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListMediaCapturePipelinesOutput) SetNextToken(v string) *ListMediaCapturePipelinesOutput { + s.NextToken = &v + return s +} + +type ListTagsForResourceInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The resource ARN. + // + // ResourceARN is a required field + ResourceARN *string `location:"querystring" locationName:"arn" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} + if s.ResourceARN == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceARN")) + } + if s.ResourceARN != nil && len(*s.ResourceARN) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceARN", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceARN sets the ResourceARN field's value. +func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput { + s.ResourceARN = &v + return s +} + +type ListTagsForResourceOutput struct { + _ struct{} `type:"structure"` + + // The tag key-value pairs. + Tags []*Tag `min:"1" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) GoString() string { + return s.String() +} + +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput { + s.Tags = v + return s +} + +// A media capture pipeline object consisting of an ID, source type, source +// ARN, a sink type, a sink ARN, and a configuration object. +type MediaCapturePipeline struct { + _ struct{} `type:"structure"` + + // The configuration for a specified media capture pipeline. SourceType must + // be ChimeSdkMeeting. + ChimeSdkMeetingConfiguration *ChimeSdkMeetingConfiguration `type:"structure"` + + // The time at which the capture pipeline was created, in ISO 8601 format. + CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` + + // The ARN of a media capture pipeline. + MediaPipelineArn *string `min:"1" type:"string"` + + // The ID of a media capture pipeline. + MediaPipelineId *string `min:"36" type:"string"` + + // ARN of the destination to which the media artifacts are saved. + // + // SinkArn is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by MediaCapturePipeline's + // String and GoString methods. + SinkArn *string `min:"1" type:"string" sensitive:"true"` + + // Destination type to which the media artifacts are saved. You must use an + // S3 Bucket. + SinkType *string `type:"string" enum:"MediaPipelineSinkType"` + + // ARN of the source from which the media artifacts are saved. + // + // SourceArn is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by MediaCapturePipeline's + // String and GoString methods. + SourceArn *string `min:"1" type:"string" sensitive:"true"` + + // Source type from which media artifacts are saved. You must use ChimeMeeting. + SourceType *string `type:"string" enum:"MediaPipelineSourceType"` + + // The status of the media capture pipeline. + Status *string `type:"string" enum:"MediaPipelineStatus"` + + // The time at which the capture pipeline was updated, in ISO 8601 format. + UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MediaCapturePipeline) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MediaCapturePipeline) GoString() string { + return s.String() +} + +// SetChimeSdkMeetingConfiguration sets the ChimeSdkMeetingConfiguration field's value. +func (s *MediaCapturePipeline) SetChimeSdkMeetingConfiguration(v *ChimeSdkMeetingConfiguration) *MediaCapturePipeline { + s.ChimeSdkMeetingConfiguration = v + return s +} + +// SetCreatedTimestamp sets the CreatedTimestamp field's value. +func (s *MediaCapturePipeline) SetCreatedTimestamp(v time.Time) *MediaCapturePipeline { + s.CreatedTimestamp = &v + return s +} + +// SetMediaPipelineArn sets the MediaPipelineArn field's value. +func (s *MediaCapturePipeline) SetMediaPipelineArn(v string) *MediaCapturePipeline { + s.MediaPipelineArn = &v + return s +} + +// SetMediaPipelineId sets the MediaPipelineId field's value. +func (s *MediaCapturePipeline) SetMediaPipelineId(v string) *MediaCapturePipeline { + s.MediaPipelineId = &v + return s +} + +// SetSinkArn sets the SinkArn field's value. +func (s *MediaCapturePipeline) SetSinkArn(v string) *MediaCapturePipeline { + s.SinkArn = &v + return s +} + +// SetSinkType sets the SinkType field's value. +func (s *MediaCapturePipeline) SetSinkType(v string) *MediaCapturePipeline { + s.SinkType = &v + return s +} + +// SetSourceArn sets the SourceArn field's value. +func (s *MediaCapturePipeline) SetSourceArn(v string) *MediaCapturePipeline { + s.SourceArn = &v + return s +} + +// SetSourceType sets the SourceType field's value. +func (s *MediaCapturePipeline) SetSourceType(v string) *MediaCapturePipeline { + s.SourceType = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *MediaCapturePipeline) SetStatus(v string) *MediaCapturePipeline { + s.Status = &v + return s +} + +// SetUpdatedTimestamp sets the UpdatedTimestamp field's value. +func (s *MediaCapturePipeline) SetUpdatedTimestamp(v time.Time) *MediaCapturePipeline { + s.UpdatedTimestamp = &v + return s +} + +// A summary of a media capture pipeline. +type MediaCapturePipelineSummary struct { + _ struct{} `type:"structure"` + + // The ARN of a media capture pipeline. + MediaPipelineArn *string `min:"1" type:"string"` + + // The ID of a media capture pipeline. + MediaPipelineId *string `min:"36" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MediaCapturePipelineSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MediaCapturePipelineSummary) GoString() string { + return s.String() +} + +// SetMediaPipelineArn sets the MediaPipelineArn field's value. +func (s *MediaCapturePipelineSummary) SetMediaPipelineArn(v string) *MediaCapturePipelineSummary { + s.MediaPipelineArn = &v + return s +} + +// SetMediaPipelineId sets the MediaPipelineId field's value. +func (s *MediaCapturePipelineSummary) SetMediaPipelineId(v string) *MediaCapturePipelineSummary { + s.MediaPipelineId = &v + return s +} + +// One or more of the resources in the request does not exist in the system. +type NotFoundException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"` + + Message_ *string `locationName:"Message" type:"string"` + + // The request id associated with the call responsible for the exception. + RequestId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NotFoundException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NotFoundException) GoString() string { + return s.String() +} + +func newErrorNotFoundException(v protocol.ResponseMetadata) error { + return &NotFoundException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *NotFoundException) Code() string { + return "NotFoundException" +} + +// Message returns the exception's message. +func (s *NotFoundException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *NotFoundException) OrigErr() error { + return nil +} + +func (s *NotFoundException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *NotFoundException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *NotFoundException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The request exceeds the resource limit. +type ResourceLimitExceededException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"` + + Message_ *string `locationName:"Message" type:"string"` + + // The request id associated with the call responsible for the exception. + RequestId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResourceLimitExceededException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResourceLimitExceededException) GoString() string { + return s.String() +} + +func newErrorResourceLimitExceededException(v protocol.ResponseMetadata) error { + return &ResourceLimitExceededException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ResourceLimitExceededException) Code() string { + return "ResourceLimitExceededException" +} + +// Message returns the exception's message. +func (s *ResourceLimitExceededException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ResourceLimitExceededException) OrigErr() error { + return nil +} + +func (s *ResourceLimitExceededException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ResourceLimitExceededException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ResourceLimitExceededException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The video streams to capture for a specified media capture pipeline. The +// total number of video streams can't exceed 25. +type SelectedVideoStreams struct { + _ struct{} `type:"structure"` + + // The attendee IDs of the streams selected for a media capture pipeline. + AttendeeIds []*string `min:"1" type:"list"` + + // The external user IDs of the streams selected for a media capture pipeline. + ExternalUserIds []*string `min:"1" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SelectedVideoStreams) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SelectedVideoStreams) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SelectedVideoStreams) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SelectedVideoStreams"} + if s.AttendeeIds != nil && len(s.AttendeeIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AttendeeIds", 1)) + } + if s.ExternalUserIds != nil && len(s.ExternalUserIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ExternalUserIds", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAttendeeIds sets the AttendeeIds field's value. +func (s *SelectedVideoStreams) SetAttendeeIds(v []*string) *SelectedVideoStreams { + s.AttendeeIds = v + return s +} + +// SetExternalUserIds sets the ExternalUserIds field's value. +func (s *SelectedVideoStreams) SetExternalUserIds(v []*string) *SelectedVideoStreams { + s.ExternalUserIds = v + return s +} + +// The service encountered an unexpected error. +type ServiceFailureException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"` + + Message_ *string `locationName:"Message" type:"string"` + + // The request id associated with the call responsible for the exception. + RequestId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceFailureException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceFailureException) GoString() string { + return s.String() +} + +func newErrorServiceFailureException(v protocol.ResponseMetadata) error { + return &ServiceFailureException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ServiceFailureException) Code() string { + return "ServiceFailureException" +} + +// Message returns the exception's message. +func (s *ServiceFailureException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ServiceFailureException) OrigErr() error { + return nil +} + +func (s *ServiceFailureException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ServiceFailureException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ServiceFailureException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The service is currently unavailable. +type ServiceUnavailableException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"` + + Message_ *string `locationName:"Message" type:"string"` + + // The request id associated with the call responsible for the exception. + RequestId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceUnavailableException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceUnavailableException) GoString() string { + return s.String() +} + +func newErrorServiceUnavailableException(v protocol.ResponseMetadata) error { + return &ServiceUnavailableException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ServiceUnavailableException) Code() string { + return "ServiceUnavailableException" +} + +// Message returns the exception's message. +func (s *ServiceUnavailableException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ServiceUnavailableException) OrigErr() error { + return nil +} + +func (s *ServiceUnavailableException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ServiceUnavailableException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ServiceUnavailableException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Source configuration for a specified media capture pipeline. +type SourceConfiguration struct { + _ struct{} `type:"structure"` + + // The selected video streams to capture for a specified media capture pipeline. + // The number of video streams can't exceed 25. + SelectedVideoStreams *SelectedVideoStreams `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SourceConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SourceConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SourceConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SourceConfiguration"} + if s.SelectedVideoStreams != nil { + if err := s.SelectedVideoStreams.Validate(); err != nil { + invalidParams.AddNested("SelectedVideoStreams", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetSelectedVideoStreams sets the SelectedVideoStreams field's value. +func (s *SourceConfiguration) SetSelectedVideoStreams(v *SelectedVideoStreams) *SourceConfiguration { + s.SelectedVideoStreams = v + return s +} + +// Describes a tag applied to a resource. +type Tag struct { + _ struct{} `type:"structure"` + + // The key of the tag. + // + // Key is a required field + Key *string `min:"1" type:"string" required:"true"` + + // The value of the tag. + // + // Value is a required field + Value *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Tag) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Tag) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Tag) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Tag"} + if s.Key == nil { + invalidParams.Add(request.NewErrParamRequired("Key")) + } + if s.Key != nil && len(*s.Key) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Key", 1)) + } + if s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKey sets the Key field's value. +func (s *Tag) SetKey(v string) *Tag { + s.Key = &v + return s +} + +// SetValue sets the Value field's value. +func (s *Tag) SetValue(v string) *Tag { + s.Value = &v + return s +} + +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // The resource ARN. + // + // ResourceARN is a required field + ResourceARN *string `min:"1" type:"string" required:"true"` + + // The tag key-value pairs. + // + // Tags is a required field + Tags []*Tag `min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} + if s.ResourceARN == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceARN")) + } + if s.ResourceARN != nil && len(*s.ResourceARN) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceARN", 1)) + } + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) + } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceARN sets the ResourceARN field's value. +func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput { + s.ResourceARN = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput { + s.Tags = v + return s +} + +type TagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) GoString() string { + return s.String() +} + +// The client exceeded its request rate limit. +type ThrottledClientException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"` + + Message_ *string `locationName:"Message" type:"string"` + + // The request id associated with the call responsible for the exception. + RequestId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ThrottledClientException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ThrottledClientException) GoString() string { + return s.String() +} + +func newErrorThrottledClientException(v protocol.ResponseMetadata) error { + return &ThrottledClientException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ThrottledClientException) Code() string { + return "ThrottledClientException" +} + +// Message returns the exception's message. +func (s *ThrottledClientException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ThrottledClientException) OrigErr() error { + return nil +} + +func (s *ThrottledClientException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ThrottledClientException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ThrottledClientException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The client is not currently authorized to make the request. +type UnauthorizedClientException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Code_ *string `locationName:"Code" type:"string" enum:"ErrorCode"` + + Message_ *string `locationName:"Message" type:"string"` + + // The request id associated with the call responsible for the exception. + RequestId *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UnauthorizedClientException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UnauthorizedClientException) GoString() string { + return s.String() +} + +func newErrorUnauthorizedClientException(v protocol.ResponseMetadata) error { + return &UnauthorizedClientException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *UnauthorizedClientException) Code() string { + return "UnauthorizedClientException" +} + +// Message returns the exception's message. +func (s *UnauthorizedClientException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *UnauthorizedClientException) OrigErr() error { + return nil +} + +func (s *UnauthorizedClientException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *UnauthorizedClientException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *UnauthorizedClientException) RequestID() string { + return s.RespMetadata.RequestID +} + +type UntagResourceInput struct { + _ struct{} `type:"structure"` + + // The resource ARN. + // + // ResourceARN is a required field + ResourceARN *string `min:"1" type:"string" required:"true"` + + // The tag keys. + // + // TagKeys is a required field + TagKeys []*string `min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UntagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} + if s.ResourceARN == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceARN")) + } + if s.ResourceARN != nil && len(*s.ResourceARN) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceARN", 1)) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + if s.TagKeys != nil && len(s.TagKeys) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TagKeys", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceARN sets the ResourceARN field's value. +func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput { + s.ResourceARN = &v + return s +} + +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) GoString() string { + return s.String() +} + +// The video artifact configuration object. +type VideoArtifactsConfiguration struct { + _ struct{} `type:"structure"` + + // The MUX type of the video artifact configuration object. + MuxType *string `type:"string" enum:"VideoMuxType"` + + // Indicates whether the video artifact is enabled or disabled. + // + // State is a required field + State *string `type:"string" required:"true" enum:"ArtifactsState"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VideoArtifactsConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VideoArtifactsConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *VideoArtifactsConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "VideoArtifactsConfiguration"} + if s.State == nil { + invalidParams.Add(request.NewErrParamRequired("State")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMuxType sets the MuxType field's value. +func (s *VideoArtifactsConfiguration) SetMuxType(v string) *VideoArtifactsConfiguration { + s.MuxType = &v + return s +} + +// SetState sets the State field's value. +func (s *VideoArtifactsConfiguration) SetState(v string) *VideoArtifactsConfiguration { + s.State = &v + return s +} + +const ( + // ArtifactsStateEnabled is a ArtifactsState enum value + ArtifactsStateEnabled = "Enabled" + + // ArtifactsStateDisabled is a ArtifactsState enum value + ArtifactsStateDisabled = "Disabled" +) + +// ArtifactsState_Values returns all elements of the ArtifactsState enum +func ArtifactsState_Values() []string { + return []string{ + ArtifactsStateEnabled, + ArtifactsStateDisabled, + } +} + +const ( + // AudioMuxTypeAudioOnly is a AudioMuxType enum value + AudioMuxTypeAudioOnly = "AudioOnly" + + // AudioMuxTypeAudioWithActiveSpeakerVideo is a AudioMuxType enum value + AudioMuxTypeAudioWithActiveSpeakerVideo = "AudioWithActiveSpeakerVideo" +) + +// AudioMuxType_Values returns all elements of the AudioMuxType enum +func AudioMuxType_Values() []string { + return []string{ + AudioMuxTypeAudioOnly, + AudioMuxTypeAudioWithActiveSpeakerVideo, + } +} + +const ( + // ContentMuxTypeContentOnly is a ContentMuxType enum value + ContentMuxTypeContentOnly = "ContentOnly" +) + +// ContentMuxType_Values returns all elements of the ContentMuxType enum +func ContentMuxType_Values() []string { + return []string{ + ContentMuxTypeContentOnly, + } +} + +const ( + // ErrorCodeBadRequest is a ErrorCode enum value + ErrorCodeBadRequest = "BadRequest" + + // ErrorCodeForbidden is a ErrorCode enum value + ErrorCodeForbidden = "Forbidden" + + // ErrorCodeNotFound is a ErrorCode enum value + ErrorCodeNotFound = "NotFound" + + // ErrorCodeResourceLimitExceeded is a ErrorCode enum value + ErrorCodeResourceLimitExceeded = "ResourceLimitExceeded" + + // ErrorCodeServiceFailure is a ErrorCode enum value + ErrorCodeServiceFailure = "ServiceFailure" + + // ErrorCodeServiceUnavailable is a ErrorCode enum value + ErrorCodeServiceUnavailable = "ServiceUnavailable" + + // ErrorCodeThrottling is a ErrorCode enum value + ErrorCodeThrottling = "Throttling" +) + +// ErrorCode_Values returns all elements of the ErrorCode enum +func ErrorCode_Values() []string { + return []string{ + ErrorCodeBadRequest, + ErrorCodeForbidden, + ErrorCodeNotFound, + ErrorCodeResourceLimitExceeded, + ErrorCodeServiceFailure, + ErrorCodeServiceUnavailable, + ErrorCodeThrottling, + } +} + +const ( + // MediaPipelineSinkTypeS3bucket is a MediaPipelineSinkType enum value + MediaPipelineSinkTypeS3bucket = "S3Bucket" +) + +// MediaPipelineSinkType_Values returns all elements of the MediaPipelineSinkType enum +func MediaPipelineSinkType_Values() []string { + return []string{ + MediaPipelineSinkTypeS3bucket, + } +} + +const ( + // MediaPipelineSourceTypeChimeSdkMeeting is a MediaPipelineSourceType enum value + MediaPipelineSourceTypeChimeSdkMeeting = "ChimeSdkMeeting" +) + +// MediaPipelineSourceType_Values returns all elements of the MediaPipelineSourceType enum +func MediaPipelineSourceType_Values() []string { + return []string{ + MediaPipelineSourceTypeChimeSdkMeeting, + } +} + +const ( + // MediaPipelineStatusInitializing is a MediaPipelineStatus enum value + MediaPipelineStatusInitializing = "Initializing" + + // MediaPipelineStatusInProgress is a MediaPipelineStatus enum value + MediaPipelineStatusInProgress = "InProgress" + + // MediaPipelineStatusFailed is a MediaPipelineStatus enum value + MediaPipelineStatusFailed = "Failed" + + // MediaPipelineStatusStopping is a MediaPipelineStatus enum value + MediaPipelineStatusStopping = "Stopping" + + // MediaPipelineStatusStopped is a MediaPipelineStatus enum value + MediaPipelineStatusStopped = "Stopped" +) + +// MediaPipelineStatus_Values returns all elements of the MediaPipelineStatus enum +func MediaPipelineStatus_Values() []string { + return []string{ + MediaPipelineStatusInitializing, + MediaPipelineStatusInProgress, + MediaPipelineStatusFailed, + MediaPipelineStatusStopping, + MediaPipelineStatusStopped, + } +} + +const ( + // VideoMuxTypeVideoOnly is a VideoMuxType enum value + VideoMuxTypeVideoOnly = "VideoOnly" +) + +// VideoMuxType_Values returns all elements of the VideoMuxType enum +func VideoMuxType_Values() []string { + return []string{ + VideoMuxTypeVideoOnly, + } +} diff --git a/service/chimesdkmediapipelines/chimesdkmediapipelinesiface/interface.go b/service/chimesdkmediapipelines/chimesdkmediapipelinesiface/interface.go new file mode 100644 index 00000000000..bc808b14933 --- /dev/null +++ b/service/chimesdkmediapipelines/chimesdkmediapipelinesiface/interface.go @@ -0,0 +1,95 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package chimesdkmediapipelinesiface provides an interface to enable mocking the Amazon Chime SDK Media Pipelines service client +// for testing your code. +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. +package chimesdkmediapipelinesiface + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/service/chimesdkmediapipelines" +) + +// ChimeSDKMediaPipelinesAPI provides an interface to enable mocking the +// chimesdkmediapipelines.ChimeSDKMediaPipelines service client's API operation, +// paginators, and waiters. This make unit testing your code that calls out +// to the SDK's service client's calls easier. +// +// The best way to use this interface is so the SDK's service client's calls +// can be stubbed out for unit testing your code with the SDK without needing +// to inject custom request handlers into the SDK's request pipeline. +// +// // myFunc uses an SDK service client to make a request to +// // Amazon Chime SDK Media Pipelines. +// func myFunc(svc chimesdkmediapipelinesiface.ChimeSDKMediaPipelinesAPI) bool { +// // Make svc.CreateMediaCapturePipeline request +// } +// +// func main() { +// sess := session.New() +// svc := chimesdkmediapipelines.New(sess) +// +// myFunc(svc) +// } +// +// In your _test.go file: +// +// // Define a mock struct to be used in your unit tests of myFunc. +// type mockChimeSDKMediaPipelinesClient struct { +// chimesdkmediapipelinesiface.ChimeSDKMediaPipelinesAPI +// } +// func (m *mockChimeSDKMediaPipelinesClient) CreateMediaCapturePipeline(input *chimesdkmediapipelines.CreateMediaCapturePipelineInput) (*chimesdkmediapipelines.CreateMediaCapturePipelineOutput, error) { +// // mock response/functionality +// } +// +// func TestMyFunc(t *testing.T) { +// // Setup Test +// mockSvc := &mockChimeSDKMediaPipelinesClient{} +// +// myfunc(mockSvc) +// +// // Verify myFunc's functionality +// } +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. Its suggested to use the pattern above for testing, or using +// tooling to generate mocks to satisfy the interfaces. +type ChimeSDKMediaPipelinesAPI interface { + CreateMediaCapturePipeline(*chimesdkmediapipelines.CreateMediaCapturePipelineInput) (*chimesdkmediapipelines.CreateMediaCapturePipelineOutput, error) + CreateMediaCapturePipelineWithContext(aws.Context, *chimesdkmediapipelines.CreateMediaCapturePipelineInput, ...request.Option) (*chimesdkmediapipelines.CreateMediaCapturePipelineOutput, error) + CreateMediaCapturePipelineRequest(*chimesdkmediapipelines.CreateMediaCapturePipelineInput) (*request.Request, *chimesdkmediapipelines.CreateMediaCapturePipelineOutput) + + DeleteMediaCapturePipeline(*chimesdkmediapipelines.DeleteMediaCapturePipelineInput) (*chimesdkmediapipelines.DeleteMediaCapturePipelineOutput, error) + DeleteMediaCapturePipelineWithContext(aws.Context, *chimesdkmediapipelines.DeleteMediaCapturePipelineInput, ...request.Option) (*chimesdkmediapipelines.DeleteMediaCapturePipelineOutput, error) + DeleteMediaCapturePipelineRequest(*chimesdkmediapipelines.DeleteMediaCapturePipelineInput) (*request.Request, *chimesdkmediapipelines.DeleteMediaCapturePipelineOutput) + + GetMediaCapturePipeline(*chimesdkmediapipelines.GetMediaCapturePipelineInput) (*chimesdkmediapipelines.GetMediaCapturePipelineOutput, error) + GetMediaCapturePipelineWithContext(aws.Context, *chimesdkmediapipelines.GetMediaCapturePipelineInput, ...request.Option) (*chimesdkmediapipelines.GetMediaCapturePipelineOutput, error) + GetMediaCapturePipelineRequest(*chimesdkmediapipelines.GetMediaCapturePipelineInput) (*request.Request, *chimesdkmediapipelines.GetMediaCapturePipelineOutput) + + ListMediaCapturePipelines(*chimesdkmediapipelines.ListMediaCapturePipelinesInput) (*chimesdkmediapipelines.ListMediaCapturePipelinesOutput, error) + ListMediaCapturePipelinesWithContext(aws.Context, *chimesdkmediapipelines.ListMediaCapturePipelinesInput, ...request.Option) (*chimesdkmediapipelines.ListMediaCapturePipelinesOutput, error) + ListMediaCapturePipelinesRequest(*chimesdkmediapipelines.ListMediaCapturePipelinesInput) (*request.Request, *chimesdkmediapipelines.ListMediaCapturePipelinesOutput) + + ListMediaCapturePipelinesPages(*chimesdkmediapipelines.ListMediaCapturePipelinesInput, func(*chimesdkmediapipelines.ListMediaCapturePipelinesOutput, bool) bool) error + ListMediaCapturePipelinesPagesWithContext(aws.Context, *chimesdkmediapipelines.ListMediaCapturePipelinesInput, func(*chimesdkmediapipelines.ListMediaCapturePipelinesOutput, bool) bool, ...request.Option) error + + ListTagsForResource(*chimesdkmediapipelines.ListTagsForResourceInput) (*chimesdkmediapipelines.ListTagsForResourceOutput, error) + ListTagsForResourceWithContext(aws.Context, *chimesdkmediapipelines.ListTagsForResourceInput, ...request.Option) (*chimesdkmediapipelines.ListTagsForResourceOutput, error) + ListTagsForResourceRequest(*chimesdkmediapipelines.ListTagsForResourceInput) (*request.Request, *chimesdkmediapipelines.ListTagsForResourceOutput) + + TagResource(*chimesdkmediapipelines.TagResourceInput) (*chimesdkmediapipelines.TagResourceOutput, error) + TagResourceWithContext(aws.Context, *chimesdkmediapipelines.TagResourceInput, ...request.Option) (*chimesdkmediapipelines.TagResourceOutput, error) + TagResourceRequest(*chimesdkmediapipelines.TagResourceInput) (*request.Request, *chimesdkmediapipelines.TagResourceOutput) + + UntagResource(*chimesdkmediapipelines.UntagResourceInput) (*chimesdkmediapipelines.UntagResourceOutput, error) + UntagResourceWithContext(aws.Context, *chimesdkmediapipelines.UntagResourceInput, ...request.Option) (*chimesdkmediapipelines.UntagResourceOutput, error) + UntagResourceRequest(*chimesdkmediapipelines.UntagResourceInput) (*request.Request, *chimesdkmediapipelines.UntagResourceOutput) +} + +var _ ChimeSDKMediaPipelinesAPI = (*chimesdkmediapipelines.ChimeSDKMediaPipelines)(nil) diff --git a/service/chimesdkmediapipelines/doc.go b/service/chimesdkmediapipelines/doc.go new file mode 100644 index 00000000000..0262a3ef9ba --- /dev/null +++ b/service/chimesdkmediapipelines/doc.go @@ -0,0 +1,31 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package chimesdkmediapipelines provides the client and types for making API +// requests to Amazon Chime SDK Media Pipelines. +// +// The Amazon Chime SDK media pipeline APIs in this section allow software developers +// to create Amazon Chime SDK media pipelines and capture audio, video, events, +// and data messages from Amazon Chime SDK meetings. For more information about +// media pipleines, see Amzon Chime SDK media pipelines (https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Media_Pipelines.html). +// +// See https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-media-pipelines-2021-07-15 for more information on this service. +// +// See chimesdkmediapipelines package documentation for more information. +// https://docs.aws.amazon.com/sdk-for-go/api/service/chimesdkmediapipelines/ +// +// Using the Client +// +// To contact Amazon Chime SDK Media Pipelines with the SDK use the New function to create +// a new service client. With that client you can make API requests to the service. +// These clients are safe to use concurrently. +// +// See the SDK's documentation for more information on how to use the SDK. +// https://docs.aws.amazon.com/sdk-for-go/api/ +// +// See aws.Config documentation for more information on configuring SDK clients. +// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config +// +// See the Amazon Chime SDK Media Pipelines client ChimeSDKMediaPipelines for more +// information on creating client for this service. +// https://docs.aws.amazon.com/sdk-for-go/api/service/chimesdkmediapipelines/#New +package chimesdkmediapipelines diff --git a/service/chimesdkmediapipelines/errors.go b/service/chimesdkmediapipelines/errors.go new file mode 100644 index 00000000000..5ec724ee3a3 --- /dev/null +++ b/service/chimesdkmediapipelines/errors.go @@ -0,0 +1,69 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package chimesdkmediapipelines + +import ( + "github.com/aws/aws-sdk-go/private/protocol" +) + +const ( + + // ErrCodeBadRequestException for service response error code + // "BadRequestException". + // + // The input parameters don't match the service's restrictions. + ErrCodeBadRequestException = "BadRequestException" + + // ErrCodeForbiddenException for service response error code + // "ForbiddenException". + // + // The client is permanently forbidden from making the request. + ErrCodeForbiddenException = "ForbiddenException" + + // ErrCodeNotFoundException for service response error code + // "NotFoundException". + // + // One or more of the resources in the request does not exist in the system. + ErrCodeNotFoundException = "NotFoundException" + + // ErrCodeResourceLimitExceededException for service response error code + // "ResourceLimitExceededException". + // + // The request exceeds the resource limit. + ErrCodeResourceLimitExceededException = "ResourceLimitExceededException" + + // ErrCodeServiceFailureException for service response error code + // "ServiceFailureException". + // + // The service encountered an unexpected error. + ErrCodeServiceFailureException = "ServiceFailureException" + + // ErrCodeServiceUnavailableException for service response error code + // "ServiceUnavailableException". + // + // The service is currently unavailable. + ErrCodeServiceUnavailableException = "ServiceUnavailableException" + + // ErrCodeThrottledClientException for service response error code + // "ThrottledClientException". + // + // The client exceeded its request rate limit. + ErrCodeThrottledClientException = "ThrottledClientException" + + // ErrCodeUnauthorizedClientException for service response error code + // "UnauthorizedClientException". + // + // The client is not currently authorized to make the request. + ErrCodeUnauthorizedClientException = "UnauthorizedClientException" +) + +var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ + "BadRequestException": newErrorBadRequestException, + "ForbiddenException": newErrorForbiddenException, + "NotFoundException": newErrorNotFoundException, + "ResourceLimitExceededException": newErrorResourceLimitExceededException, + "ServiceFailureException": newErrorServiceFailureException, + "ServiceUnavailableException": newErrorServiceUnavailableException, + "ThrottledClientException": newErrorThrottledClientException, + "UnauthorizedClientException": newErrorUnauthorizedClientException, +} diff --git a/service/chimesdkmediapipelines/service.go b/service/chimesdkmediapipelines/service.go new file mode 100644 index 00000000000..7b61d5e647c --- /dev/null +++ b/service/chimesdkmediapipelines/service.go @@ -0,0 +1,105 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package chimesdkmediapipelines + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/client" + "github.com/aws/aws-sdk-go/aws/client/metadata" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/aws/signer/v4" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/restjson" +) + +// ChimeSDKMediaPipelines provides the API operation methods for making requests to +// Amazon Chime SDK Media Pipelines. See this package's package overview docs +// for details on the service. +// +// ChimeSDKMediaPipelines methods are safe to use concurrently. It is not safe to +// modify mutate any of the struct's properties though. +type ChimeSDKMediaPipelines struct { + *client.Client +} + +// Used for custom client initialization logic +var initClient func(*client.Client) + +// Used for custom request initialization logic +var initRequest func(*request.Request) + +// Service information constants +const ( + ServiceName = "Chime SDK Media Pipelines" // Name of service. + EndpointsID = "media-pipelines-chime" // ID to lookup a service endpoint with. + ServiceID = "Chime SDK Media Pipelines" // ServiceID is a unique identifier of a specific service. +) + +// New creates a new instance of the ChimeSDKMediaPipelines client with a session. +// If additional configuration is needed for the client instance use the optional +// aws.Config parameter to add your extra config. +// +// Example: +// mySession := session.Must(session.NewSession()) +// +// // Create a ChimeSDKMediaPipelines client from just a session. +// svc := chimesdkmediapipelines.New(mySession) +// +// // Create a ChimeSDKMediaPipelines client with additional configuration +// svc := chimesdkmediapipelines.New(mySession, aws.NewConfig().WithRegion("us-west-2")) +func New(p client.ConfigProvider, cfgs ...*aws.Config) *ChimeSDKMediaPipelines { + c := p.ClientConfig(EndpointsID, cfgs...) + if c.SigningNameDerived || len(c.SigningName) == 0 { + c.SigningName = "chime" + } + return newClient(*c.Config, c.Handlers, c.PartitionID, c.Endpoint, c.SigningRegion, c.SigningName, c.ResolvedRegion) +} + +// newClient creates, initializes and returns a new service client instance. +func newClient(cfg aws.Config, handlers request.Handlers, partitionID, endpoint, signingRegion, signingName, resolvedRegion string) *ChimeSDKMediaPipelines { + svc := &ChimeSDKMediaPipelines{ + Client: client.New( + cfg, + metadata.ClientInfo{ + ServiceName: ServiceName, + ServiceID: ServiceID, + SigningName: signingName, + SigningRegion: signingRegion, + PartitionID: partitionID, + Endpoint: endpoint, + APIVersion: "2021-07-15", + ResolvedRegion: resolvedRegion, + }, + handlers, + ), + } + + // Handlers + svc.Handlers.Sign.PushBackNamed(v4.SignRequestHandler) + svc.Handlers.Build.PushBackNamed(restjson.BuildHandler) + svc.Handlers.Unmarshal.PushBackNamed(restjson.UnmarshalHandler) + svc.Handlers.UnmarshalMeta.PushBackNamed(restjson.UnmarshalMetaHandler) + svc.Handlers.UnmarshalError.PushBackNamed( + protocol.NewUnmarshalErrorHandler(restjson.NewUnmarshalTypedError(exceptionFromCode)).NamedHandler(), + ) + + // Run custom client initialization if present + if initClient != nil { + initClient(svc.Client) + } + + return svc +} + +// newRequest creates a new request for a ChimeSDKMediaPipelines operation and runs any +// custom request initialization. +func (c *ChimeSDKMediaPipelines) newRequest(op *request.Operation, params, data interface{}) *request.Request { + req := c.NewRequest(op, params, data) + + // Run custom request initialization if present + if initRequest != nil { + initRequest(req) + } + + return req +} diff --git a/service/cloudtrail/api.go b/service/cloudtrail/api.go index 68253a5f4e9..32086052193 100644 --- a/service/cloudtrail/api.go +++ b/service/cloudtrail/api.go @@ -58,13 +58,14 @@ func (c *CloudTrail) AddTagsRequest(input *AddTagsInput) (req *request.Request, // AddTags API operation for AWS CloudTrail. // -// Adds one or more tags to a trail, up to a limit of 50. Overwrites an existing -// tag's value when a new value is specified for an existing tag key. Tag key -// names must be unique for a trail; you cannot have two keys with the same -// name but different values. If you specify a key without a value, the tag -// will be created with the specified key and a value of null. You can tag a -// trail that applies to all Amazon Web Services Regions only from the Region -// in which the trail was created (also known as its home region). +// Adds one or more tags to a trail or event data store, up to a limit of 50. +// Overwrites an existing tag's value when a new value is specified for an existing +// tag key. Tag key names must be unique for a trail; you cannot have two keys +// with the same name but different values. If you specify a key without a value, +// the tag will be created with the specified key and a value of null. You can +// tag a trail or event data store that applies to all Amazon Web Services Regions +// only from the Region in which the trail or event data store was created (also +// known as its home region). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -112,7 +113,7 @@ func (c *CloudTrail) AddTagsRequest(input *AddTagsInput) (req *request.Request, // It can also occur if there are duplicate tags or too many tags on the resource. // // * InactiveEventDataStoreException -// The event data store against which you ran your query is inactive. +// The event data store is inactive. // // * EventDataStoreNotFoundException // The specified event data store was not found. @@ -125,15 +126,16 @@ func (c *CloudTrail) AddTagsRequest(input *AddTagsInput) (req *request.Request, // // * NotOrganizationMasterAccountException // This exception is thrown when the Amazon Web Services account making the -// request to create or update an organization trail is not the management account -// for an organization in Organizations. For more information, see Prepare For -// Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// request to create or update an organization trail or event data store is +// not the management account for an organization in Organizations. For more +// information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) +// or Create an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html). // // * ConflictException // This exception is thrown when the specified resource is not ready for an -// operation. This can occur when you try to run an operation on a trail before -// CloudTrail has time to fully load the trail. If this exception occurs, wait -// a few minutes, and then try the operation again. +// operation. This can occur when you try to run an operation on a resource +// before CloudTrail has time to fully load the resource. If this exception +// occurs, wait a few minutes, and then try the operation again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/AddTags func (c *CloudTrail) AddTags(input *AddTagsInput) (*AddTagsOutput, error) { @@ -223,7 +225,7 @@ func (c *CloudTrail) CancelQueryRequest(input *CancelQueryInput) (req *request.R // The specified event data store was not found. // // * InactiveEventDataStoreException -// The event data store against which you ran your query is inactive. +// The event data store is inactive. // // * InactiveQueryException // The specified query cannot be canceled because it is in the FINISHED, FAILED, @@ -243,9 +245,9 @@ func (c *CloudTrail) CancelQueryRequest(input *CancelQueryInput) (req *request.R // // * ConflictException // This exception is thrown when the specified resource is not ready for an -// operation. This can occur when you try to run an operation on a trail before -// CloudTrail has time to fully load the trail. If this exception occurs, wait -// a few minutes, and then try the operation again. +// operation. This can occur when you try to run an operation on a resource +// before CloudTrail has time to fully load the resource. If this exception +// occurs, wait a few minutes, and then try the operation again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CancelQuery func (c *CloudTrail) CancelQuery(input *CancelQueryInput) (*CancelQueryOutput, error) { @@ -344,9 +346,9 @@ func (c *CloudTrail) CreateEventDataStoreRequest(input *CreateEventDataStoreInpu // // * ConflictException // This exception is thrown when the specified resource is not ready for an -// operation. This can occur when you try to run an operation on a trail before -// CloudTrail has time to fully load the trail. If this exception occurs, wait -// a few minutes, and then try the operation again. +// operation. This can occur when you try to run an operation on a resource +// before CloudTrail has time to fully load the resource. If this exception +// occurs, wait a few minutes, and then try the operation again. // // * AccessNotEnabledException // This exception is thrown when trusted access has not been enabled between @@ -356,15 +358,15 @@ func (c *CloudTrail) CreateEventDataStoreRequest(input *CreateEventDataStoreInpu // // * InsufficientDependencyServiceAccessPermissionException // This exception is thrown when the IAM user or role that is used to create -// the organization trail is lacking one or more required permissions for creating -// an organization trail in a required service. For more information, see Prepare -// For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// the organization resource lacks one or more required permissions for creating +// an organization resource in a required service. // // * NotOrganizationMasterAccountException // This exception is thrown when the Amazon Web Services account making the -// request to create or update an organization trail is not the management account -// for an organization in Organizations. For more information, see Prepare For -// Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// request to create or update an organization trail or event data store is +// not the management account for an organization in Organizations. For more +// information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) +// or Create an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html). // // * OrganizationsNotInUseException // This exception is thrown when the request is made from an Amazon Web Services @@ -374,8 +376,7 @@ func (c *CloudTrail) CreateEventDataStoreRequest(input *CreateEventDataStoreInpu // * OrganizationNotInAllFeaturesModeException // This exception is thrown when Organizations is not configured to support // all features. All features must be enabled in Organizations to support creating -// an organization trail. For more information, see Prepare For Creating a Trail -// For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// an organization trail or event data store. // // See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CreateEventDataStore func (c *CloudTrail) CreateEventDataStore(input *CreateEventDataStoreInput) (*CreateEventDataStoreOutput, error) { @@ -548,15 +549,15 @@ func (c *CloudTrail) CreateTrailRequest(input *CreateTrailInput) (req *request.R // // * InsufficientDependencyServiceAccessPermissionException // This exception is thrown when the IAM user or role that is used to create -// the organization trail is lacking one or more required permissions for creating -// an organization trail in a required service. For more information, see Prepare -// For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// the organization resource lacks one or more required permissions for creating +// an organization resource in a required service. // // * NotOrganizationMasterAccountException // This exception is thrown when the Amazon Web Services account making the -// request to create or update an organization trail is not the management account -// for an organization in Organizations. For more information, see Prepare For -// Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// request to create or update an organization trail or event data store is +// not the management account for an organization in Organizations. For more +// information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) +// or Create an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html). // // * OrganizationsNotInUseException // This exception is thrown when the request is made from an Amazon Web Services @@ -566,8 +567,7 @@ func (c *CloudTrail) CreateTrailRequest(input *CreateTrailInput) (req *request.R // * OrganizationNotInAllFeaturesModeException // This exception is thrown when Organizations is not configured to support // all features. All features must be enabled in Organizations to support creating -// an organization trail. For more information, see Prepare For Creating a Trail -// For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// an organization trail or event data store. // // * CloudTrailInvalidClientTokenIdException // This exception is thrown when a call results in the InvalidClientTokenId @@ -577,9 +577,9 @@ func (c *CloudTrail) CreateTrailRequest(input *CreateTrailInput) (req *request.R // // * ConflictException // This exception is thrown when the specified resource is not ready for an -// operation. This can occur when you try to run an operation on a trail before -// CloudTrail has time to fully load the trail. If this exception occurs, wait -// a few minutes, and then try the operation again. +// operation. This can occur when you try to run an operation on a resource +// before CloudTrail has time to fully load the resource. If this exception +// occurs, wait a few minutes, and then try the operation again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CreateTrail func (c *CloudTrail) CreateTrail(input *CreateTrailInput) (*CreateTrailOutput, error) { @@ -690,15 +690,15 @@ func (c *CloudTrail) DeleteEventDataStoreRequest(input *DeleteEventDataStoreInpu // // * NotOrganizationMasterAccountException // This exception is thrown when the Amazon Web Services account making the -// request to create or update an organization trail is not the management account -// for an organization in Organizations. For more information, see Prepare For -// Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// request to create or update an organization trail or event data store is +// not the management account for an organization in Organizations. For more +// information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) +// or Create an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html). // // * InsufficientDependencyServiceAccessPermissionException // This exception is thrown when the IAM user or role that is used to create -// the organization trail is lacking one or more required permissions for creating -// an organization trail in a required service. For more information, see Prepare -// For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// the organization resource lacks one or more required permissions for creating +// an organization resource in a required service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DeleteEventDataStore func (c *CloudTrail) DeleteEventDataStore(input *DeleteEventDataStoreInput) (*DeleteEventDataStoreOutput, error) { @@ -810,21 +810,21 @@ func (c *CloudTrail) DeleteTrailRequest(input *DeleteTrailInput) (req *request.R // // * NotOrganizationMasterAccountException // This exception is thrown when the Amazon Web Services account making the -// request to create or update an organization trail is not the management account -// for an organization in Organizations. For more information, see Prepare For -// Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// request to create or update an organization trail or event data store is +// not the management account for an organization in Organizations. For more +// information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) +// or Create an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html). // // * InsufficientDependencyServiceAccessPermissionException // This exception is thrown when the IAM user or role that is used to create -// the organization trail is lacking one or more required permissions for creating -// an organization trail in a required service. For more information, see Prepare -// For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// the organization resource lacks one or more required permissions for creating +// an organization resource in a required service. // // * ConflictException // This exception is thrown when the specified resource is not ready for an -// operation. This can occur when you try to run an operation on a trail before -// CloudTrail has time to fully load the trail. If this exception occurs, wait -// a few minutes, and then try the operation again. +// operation. This can occur when you try to run an operation on a resource +// before CloudTrail has time to fully load the resource. If this exception +// occurs, wait a few minutes, and then try the operation again. // // See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DeleteTrail func (c *CloudTrail) DeleteTrail(input *DeleteTrailInput) (*DeleteTrailOutput, error) { @@ -912,7 +912,7 @@ func (c *CloudTrail) DescribeQueryRequest(input *DescribeQueryInput) (req *reque // The specified event data store was not found. // // * InactiveEventDataStoreException -// The event data store against which you ran your query is inactive. +// The event data store is inactive. // // * InvalidParameterException // The request includes a parameter that is not valid. @@ -1434,7 +1434,7 @@ func (c *CloudTrail) GetQueryResultsRequest(input *GetQueryResultsInput) (req *r // The specified event data store was not found. // // * InactiveEventDataStoreException -// The event data store against which you ran your query is inactive. +// The event data store is inactive. // // * InvalidMaxResultsException // This exception is thrown if the limit specified is not valid. @@ -2110,10 +2110,11 @@ func (c *CloudTrail) ListQueriesRequest(input *ListQueriesInput) (req *request.R // The specified event data store was not found. // // * InactiveEventDataStoreException -// The event data store against which you ran your query is inactive. +// The event data store is inactive. // // * InvalidDateRangeException -// A date range for the query was specified that is not valid. For more information +// A date range for the query was specified that is not valid. Be sure that +// the start time is chronologically before the end time. For more information // about writing a query, see Create or edit a query (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html) // in the CloudTrail User Guide. // @@ -2260,7 +2261,7 @@ func (c *CloudTrail) ListTagsRequest(input *ListTagsInput) (req *request.Request // ListTags API operation for AWS CloudTrail. // -// Lists the tags for the trail in the current region. +// Lists the tags for the trail or event data store in the current region. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2300,7 +2301,7 @@ func (c *CloudTrail) ListTagsRequest(input *ListTagsInput) (req *request.Request // * Not be in IP address format (for example, 192.168.5.4) // // * InactiveEventDataStoreException -// The event data store against which you ran your query is inactive. +// The event data store is inactive. // // * EventDataStoreNotFoundException // The specified event data store was not found. @@ -2873,15 +2874,15 @@ func (c *CloudTrail) PutEventSelectorsRequest(input *PutEventSelectorsInput) (re // // * NotOrganizationMasterAccountException // This exception is thrown when the Amazon Web Services account making the -// request to create or update an organization trail is not the management account -// for an organization in Organizations. For more information, see Prepare For -// Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// request to create or update an organization trail or event data store is +// not the management account for an organization in Organizations. For more +// information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) +// or Create an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html). // // * InsufficientDependencyServiceAccessPermissionException // This exception is thrown when the IAM user or role that is used to create -// the organization trail is lacking one or more required permissions for creating -// an organization trail in a required service. For more information, see Prepare -// For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// the organization resource lacks one or more required permissions for creating +// an organization resource in a required service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutEventSelectors func (c *CloudTrail) PutEventSelectors(input *PutEventSelectorsInput) (*PutEventSelectorsOutput, error) { @@ -3013,9 +3014,10 @@ func (c *CloudTrail) PutInsightSelectorsRequest(input *PutInsightSelectorsInput) // // * NotOrganizationMasterAccountException // This exception is thrown when the Amazon Web Services account making the -// request to create or update an organization trail is not the management account -// for an organization in Organizations. For more information, see Prepare For -// Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// request to create or update an organization trail or event data store is +// not the management account for an organization in Organizations. For more +// information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) +// or Create an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html). // // See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutInsightSelectors func (c *CloudTrail) PutInsightSelectors(input *PutInsightSelectorsInput) (*PutInsightSelectorsOutput, error) { @@ -3084,7 +3086,7 @@ func (c *CloudTrail) RemoveTagsRequest(input *RemoveTagsInput) (req *request.Req // RemoveTags API operation for AWS CloudTrail. // -// Removes the specified tags from a trail. +// Removes the specified tags from a trail or event data store. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3128,7 +3130,7 @@ func (c *CloudTrail) RemoveTagsRequest(input *RemoveTagsInput) (req *request.Req // It can also occur if there are duplicate tags or too many tags on the resource. // // * InactiveEventDataStoreException -// The event data store against which you ran your query is inactive. +// The event data store is inactive. // // * EventDataStoreNotFoundException // The specified event data store was not found. @@ -3141,9 +3143,10 @@ func (c *CloudTrail) RemoveTagsRequest(input *RemoveTagsInput) (req *request.Req // // * NotOrganizationMasterAccountException // This exception is thrown when the Amazon Web Services account making the -// request to create or update an organization trail is not the management account -// for an organization in Organizations. For more information, see Prepare For -// Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// request to create or update an organization trail or event data store is +// not the management account for an organization in Organizations. For more +// information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) +// or Create an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html). // // See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/RemoveTags func (c *CloudTrail) RemoveTags(input *RemoveTagsInput) (*RemoveTagsOutput, error) { @@ -3254,9 +3257,8 @@ func (c *CloudTrail) RestoreEventDataStoreRequest(input *RestoreEventDataStoreIn // // * InsufficientDependencyServiceAccessPermissionException // This exception is thrown when the IAM user or role that is used to create -// the organization trail is lacking one or more required permissions for creating -// an organization trail in a required service. For more information, see Prepare -// For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// the organization resource lacks one or more required permissions for creating +// an organization resource in a required service. // // * OrganizationsNotInUseException // This exception is thrown when the request is made from an Amazon Web Services @@ -3265,15 +3267,15 @@ func (c *CloudTrail) RestoreEventDataStoreRequest(input *RestoreEventDataStoreIn // // * NotOrganizationMasterAccountException // This exception is thrown when the Amazon Web Services account making the -// request to create or update an organization trail is not the management account -// for an organization in Organizations. For more information, see Prepare For -// Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// request to create or update an organization trail or event data store is +// not the management account for an organization in Organizations. For more +// information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) +// or Create an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html). // // * OrganizationNotInAllFeaturesModeException // This exception is thrown when Organizations is not configured to support // all features. All features must be enabled in Organizations to support creating -// an organization trail. For more information, see Prepare For Creating a Trail -// For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// an organization trail or event data store. // // See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/RestoreEventDataStore func (c *CloudTrail) RestoreEventDataStore(input *RestoreEventDataStoreInput) (*RestoreEventDataStoreOutput, error) { @@ -3387,15 +3389,15 @@ func (c *CloudTrail) StartLoggingRequest(input *StartLoggingInput) (req *request // // * NotOrganizationMasterAccountException // This exception is thrown when the Amazon Web Services account making the -// request to create or update an organization trail is not the management account -// for an organization in Organizations. For more information, see Prepare For -// Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// request to create or update an organization trail or event data store is +// not the management account for an organization in Organizations. For more +// information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) +// or Create an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html). // // * InsufficientDependencyServiceAccessPermissionException // This exception is thrown when the IAM user or role that is used to create -// the organization trail is lacking one or more required permissions for creating -// an organization trail in a required service. For more information, see Prepare -// For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// the organization resource lacks one or more required permissions for creating +// an organization resource in a required service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StartLogging func (c *CloudTrail) StartLogging(input *StartLoggingInput) (*StartLoggingOutput, error) { @@ -3482,7 +3484,7 @@ func (c *CloudTrail) StartQueryRequest(input *StartQueryInput) (req *request.Req // The specified event data store was not found. // // * InactiveEventDataStoreException -// The event data store against which you ran your query is inactive. +// The event data store is inactive. // // * InvalidParameterException // The request includes a parameter that is not valid. @@ -3618,15 +3620,15 @@ func (c *CloudTrail) StopLoggingRequest(input *StopLoggingInput) (req *request.R // // * NotOrganizationMasterAccountException // This exception is thrown when the Amazon Web Services account making the -// request to create or update an organization trail is not the management account -// for an organization in Organizations. For more information, see Prepare For -// Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// request to create or update an organization trail or event data store is +// not the management account for an organization in Organizations. For more +// information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) +// or Create an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html). // // * InsufficientDependencyServiceAccessPermissionException // This exception is thrown when the IAM user or role that is used to create -// the organization trail is lacking one or more required permissions for creating -// an organization trail in a required service. For more information, see Prepare -// For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// the organization resource lacks one or more required permissions for creating +// an organization resource in a required service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StopLogging func (c *CloudTrail) StopLogging(input *StopLoggingInput) (*StopLoggingOutput, error) { @@ -3718,7 +3720,7 @@ func (c *CloudTrail) UpdateEventDataStoreRequest(input *UpdateEventDataStoreInpu // The specified event data store was not found. // // * InactiveEventDataStoreException -// The event data store against which you ran your query is inactive. +// The event data store is inactive. // // * InvalidParameterException // The request includes a parameter that is not valid. @@ -3737,9 +3739,8 @@ func (c *CloudTrail) UpdateEventDataStoreRequest(input *UpdateEventDataStoreInpu // // * InsufficientDependencyServiceAccessPermissionException // This exception is thrown when the IAM user or role that is used to create -// the organization trail is lacking one or more required permissions for creating -// an organization trail in a required service. For more information, see Prepare -// For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// the organization resource lacks one or more required permissions for creating +// an organization resource in a required service. // // * OrganizationsNotInUseException // This exception is thrown when the request is made from an Amazon Web Services @@ -3748,15 +3749,15 @@ func (c *CloudTrail) UpdateEventDataStoreRequest(input *UpdateEventDataStoreInpu // // * NotOrganizationMasterAccountException // This exception is thrown when the Amazon Web Services account making the -// request to create or update an organization trail is not the management account -// for an organization in Organizations. For more information, see Prepare For -// Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// request to create or update an organization trail or event data store is +// not the management account for an organization in Organizations. For more +// information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) +// or Create an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html). // // * OrganizationNotInAllFeaturesModeException // This exception is thrown when Organizations is not configured to support // all features. All features must be enabled in Organizations to support creating -// an organization trail. For more information, see Prepare For Creating a Trail -// For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// an organization trail or event data store. // // See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/UpdateEventDataStore func (c *CloudTrail) UpdateEventDataStore(input *UpdateEventDataStoreInput) (*UpdateEventDataStoreOutput, error) { @@ -3957,9 +3958,8 @@ func (c *CloudTrail) UpdateTrailRequest(input *UpdateTrailInput) (req *request.R // // * InsufficientDependencyServiceAccessPermissionException // This exception is thrown when the IAM user or role that is used to create -// the organization trail is lacking one or more required permissions for creating -// an organization trail in a required service. For more information, see Prepare -// For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// the organization resource lacks one or more required permissions for creating +// an organization resource in a required service. // // * OrganizationsNotInUseException // This exception is thrown when the request is made from an Amazon Web Services @@ -3968,15 +3968,15 @@ func (c *CloudTrail) UpdateTrailRequest(input *UpdateTrailInput) (req *request.R // // * NotOrganizationMasterAccountException // This exception is thrown when the Amazon Web Services account making the -// request to create or update an organization trail is not the management account -// for an organization in Organizations. For more information, see Prepare For -// Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// request to create or update an organization trail or event data store is +// not the management account for an organization in Organizations. For more +// information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) +// or Create an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html). // // * OrganizationNotInAllFeaturesModeException // This exception is thrown when Organizations is not configured to support // all features. All features must be enabled in Organizations to support creating -// an organization trail. For more information, see Prepare For Creating a Trail -// For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// an organization trail or event data store. // // * CloudTrailInvalidClientTokenIdException // This exception is thrown when a call results in the InvalidClientTokenId @@ -4140,12 +4140,12 @@ func (s *AccessNotEnabledException) RequestID() string { return s.RespMetadata.RequestID } -// Specifies the tags to add to a trail. +// Specifies the tags to add to a trail or event data store. type AddTagsInput struct { _ struct{} `type:"structure"` - // Specifies the ARN of the trail to which one or more tags will be added. The - // format of a trail ARN is: + // Specifies the ARN of the trail or event data store to which one or more tags + // will be added. The format of a trail ARN is: // // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail // @@ -4759,9 +4759,9 @@ func (s *CloudWatchLogsDeliveryUnavailableException) RequestID() string { } // This exception is thrown when the specified resource is not ready for an -// operation. This can occur when you try to run an operation on a trail before -// CloudTrail has time to fully load the trail. If this exception occurs, wait -// a few minutes, and then try the operation again. +// operation. This can occur when you try to run an operation on a resource +// before CloudTrail has time to fully load the resource. If this exception +// occurs, wait a few minutes, and then try the operation again. type ConflictException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -6099,39 +6099,58 @@ func (s *Event) SetUsername(v string) *Event { type EventDataStore struct { _ struct{} `type:"structure"` - // The advanced event selectors that were used to select events for the data - // store. - AdvancedEventSelectors []*AdvancedEventSelector `type:"list"` + // This field is being deprecated. The advanced event selectors that were used + // to select events for the data store. + // + // Deprecated: AdvancedEventSelectors is no longer returned by ListEventDataStores + AdvancedEventSelectors []*AdvancedEventSelector `deprecated:"true" type:"list"` - // The timestamp of the event data store's creation. - CreatedTimestamp *time.Time `type:"timestamp"` + // This field is being deprecated. The timestamp of the event data store's creation. + // + // Deprecated: CreatedTimestamp is no longer returned by ListEventDataStores + CreatedTimestamp *time.Time `deprecated:"true" type:"timestamp"` // The ARN of the event data store. EventDataStoreArn *string `min:"3" type:"string"` - // Indicates whether the event data store includes events from all regions, - // or only from the region in which it was created. - MultiRegionEnabled *bool `type:"boolean"` + // This field is being deprecated. Indicates whether the event data store includes + // events from all regions, or only from the region in which it was created. + // + // Deprecated: MultiRegionEnabled is no longer returned by ListEventDataStores + MultiRegionEnabled *bool `deprecated:"true" type:"boolean"` // The name of the event data store. Name *string `min:"3" type:"string"` - // Indicates that an event data store is collecting logged events for an organization. - OrganizationEnabled *bool `type:"boolean"` + // This field is being deprecated. Indicates that an event data store is collecting + // logged events for an organization. + // + // Deprecated: OrganizationEnabled is no longer returned by ListEventDataStores + OrganizationEnabled *bool `deprecated:"true" type:"boolean"` - // The retention period, in days. - RetentionPeriod *int64 `min:"7" type:"integer"` + // This field is being deprecated. The retention period, in days. + // + // Deprecated: RetentionPeriod is no longer returned by ListEventDataStores + RetentionPeriod *int64 `min:"7" deprecated:"true" type:"integer"` - // The status of an event data store. Values are ENABLED and PENDING_DELETION. - Status *string `type:"string" enum:"EventDataStoreStatus"` + // This field is being deprecated. The status of an event data store. Values + // are ENABLED and PENDING_DELETION. + // + // Deprecated: Status is no longer returned by ListEventDataStores + Status *string `deprecated:"true" type:"string" enum:"EventDataStoreStatus"` - // Indicates whether the event data store is protected from termination. - TerminationProtectionEnabled *bool `type:"boolean"` + // This field is being deprecated. Indicates whether the event data store is + // protected from termination. + // + // Deprecated: TerminationProtectionEnabled is no longer returned by ListEventDataStores + TerminationProtectionEnabled *bool `deprecated:"true" type:"boolean"` - // The timestamp showing when an event data store was updated, if applicable. - // UpdatedTimestamp is always either the same or newer than the time shown in - // CreatedTimestamp. - UpdatedTimestamp *time.Time `type:"timestamp"` + // This field is being deprecated. The timestamp showing when an event data + // store was updated, if applicable. UpdatedTimestamp is always either the same + // or newer than the time shown in CreatedTimestamp. + // + // Deprecated: UpdatedTimestamp is no longer returned by ListEventDataStores + UpdatedTimestamp *time.Time `deprecated:"true" type:"timestamp"` } // String returns the string representation. @@ -7507,7 +7526,7 @@ func (s *GetTrailStatusOutput) SetTimeLoggingStopped(v string) *GetTrailStatusOu return s } -// The event data store against which you ran your query is inactive. +// The event data store is inactive. type InactiveEventDataStoreException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -7736,9 +7755,8 @@ func (s *InsightSelector) SetInsightType(v string) *InsightSelector { } // This exception is thrown when the IAM user or role that is used to create -// the organization trail is lacking one or more required permissions for creating -// an organization trail in a required service. For more information, see Prepare -// For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// the organization resource lacks one or more required permissions for creating +// an organization resource in a required service. type InsufficientDependencyServiceAccessPermissionException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -8124,7 +8142,8 @@ func (s *InvalidCloudWatchLogsRoleArnException) RequestID() string { return s.RespMetadata.RequestID } -// A date range for the query was specified that is not valid. For more information +// A date range for the query was specified that is not valid. Be sure that +// the start time is chronologically before the end time. For more information // about writing a query, see Create or edit a query (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html) // in the CloudTrail User Guide. type InvalidDateRangeException struct { @@ -10053,17 +10072,15 @@ func (s *ListQueriesOutput) SetQueries(v []*Query) *ListQueriesOutput { return s } -// Specifies a list of trail tags to return. +// Specifies a list of tags to return. type ListTagsInput struct { _ struct{} `type:"structure"` // Reserved for future use. NextToken *string `type:"string"` - // Specifies a list of trail ARNs whose tags will be listed. The list has a - // limit of 20 ARNs. The following is the format of a trail ARN. - // - // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // Specifies a list of trail and event data store ARNs whose tags will be listed. + // The list has a limit of 20 ARNs. // // ResourceIdList is a required field ResourceIdList []*string `type:"list" required:"true"` @@ -10584,9 +10601,10 @@ func (s *MaximumNumberOfTrailsExceededException) RequestID() string { } // This exception is thrown when the Amazon Web Services account making the -// request to create or update an organization trail is not the management account -// for an organization in Organizations. For more information, see Prepare For -// Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// request to create or update an organization trail or event data store is +// not the management account for an organization in Organizations. For more +// information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) +// or Create an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html). type NotOrganizationMasterAccountException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -10716,8 +10734,7 @@ func (s *OperationNotPermittedException) RequestID() string { // This exception is thrown when Organizations is not configured to support // all features. All features must be enabled in Organizations to support creating -// an organization trail. For more information, see Prepare For Creating a Trail -// For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). +// an organization trail or event data store. type OrganizationNotInAllFeaturesModeException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -11405,14 +11422,16 @@ func (s *QueryStatisticsForDescribeQuery) SetExecutionTimeInMillis(v int64) *Que return s } -// Specifies the tags to remove from a trail. +// Specifies the tags to remove from a trail or event data store. type RemoveTagsInput struct { _ struct{} `type:"structure"` - // Specifies the ARN of the trail from which tags should be removed. The format - // of a trail ARN is: + // Specifies the ARN of the trail or event data store from which tags should + // be removed. // - // arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // Example trail ARN format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail + // + // Example event data store ARN format: arn:aws:cloudtrail:us-east-2:12345678910:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE // // ResourceId is a required field ResourceId *string `type:"string" required:"true"` diff --git a/service/cloudtrail/errors.go b/service/cloudtrail/errors.go index 0b00687546b..062bc4ad3e4 100644 --- a/service/cloudtrail/errors.go +++ b/service/cloudtrail/errors.go @@ -45,9 +45,9 @@ const ( // "ConflictException". // // This exception is thrown when the specified resource is not ready for an - // operation. This can occur when you try to run an operation on a trail before - // CloudTrail has time to fully load the trail. If this exception occurs, wait - // a few minutes, and then try the operation again. + // operation. This can occur when you try to run an operation on a resource + // before CloudTrail has time to fully load the resource. If this exception + // occurs, wait a few minutes, and then try the operation again. ErrCodeConflictException = "ConflictException" // ErrCodeEventDataStoreARNInvalidException for service response error code @@ -85,7 +85,7 @@ const ( // ErrCodeInactiveEventDataStoreException for service response error code // "InactiveEventDataStoreException". // - // The event data store against which you ran your query is inactive. + // The event data store is inactive. ErrCodeInactiveEventDataStoreException = "InactiveEventDataStoreException" // ErrCodeInactiveQueryException for service response error code @@ -106,9 +106,8 @@ const ( // "InsufficientDependencyServiceAccessPermissionException". // // This exception is thrown when the IAM user or role that is used to create - // the organization trail is lacking one or more required permissions for creating - // an organization trail in a required service. For more information, see Prepare - // For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). + // the organization resource lacks one or more required permissions for creating + // an organization resource in a required service. ErrCodeInsufficientDependencyServiceAccessPermissionException = "InsufficientDependencyServiceAccessPermissionException" // ErrCodeInsufficientEncryptionPolicyException for service response error code @@ -146,7 +145,8 @@ const ( // ErrCodeInvalidDateRangeException for service response error code // "InvalidDateRangeException". // - // A date range for the query was specified that is not valid. For more information + // A date range for the query was specified that is not valid. Be sure that + // the start time is chronologically before the end time. For more information // about writing a query, see Create or edit a query (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html) // in the CloudTrail User Guide. ErrCodeInvalidDateRangeException = "InvalidDateRangeException" @@ -356,9 +356,10 @@ const ( // "NotOrganizationMasterAccountException". // // This exception is thrown when the Amazon Web Services account making the - // request to create or update an organization trail is not the management account - // for an organization in Organizations. For more information, see Prepare For - // Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). + // request to create or update an organization trail or event data store is + // not the management account for an organization in Organizations. For more + // information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html) + // or Create an event data store (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store.html). ErrCodeNotOrganizationMasterAccountException = "NotOrganizationMasterAccountException" // ErrCodeOperationNotPermittedException for service response error code @@ -372,8 +373,7 @@ const ( // // This exception is thrown when Organizations is not configured to support // all features. All features must be enabled in Organizations to support creating - // an organization trail. For more information, see Prepare For Creating a Trail - // For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html). + // an organization trail or event data store. ErrCodeOrganizationNotInAllFeaturesModeException = "OrganizationNotInAllFeaturesModeException" // ErrCodeOrganizationsNotInUseException for service response error code diff --git a/service/iotwireless/api.go b/service/iotwireless/api.go index bd15ef80c94..629d5880f24 100644 --- a/service/iotwireless/api.go +++ b/service/iotwireless/api.go @@ -1144,6 +1144,100 @@ func (c *IoTWireless) CreateMulticastGroupWithContext(ctx aws.Context, input *Cr return out, req.Send() } +const opCreateNetworkAnalyzerConfiguration = "CreateNetworkAnalyzerConfiguration" + +// CreateNetworkAnalyzerConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the CreateNetworkAnalyzerConfiguration operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateNetworkAnalyzerConfiguration for more information on using the CreateNetworkAnalyzerConfiguration +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateNetworkAnalyzerConfigurationRequest method. +// req, resp := client.CreateNetworkAnalyzerConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/CreateNetworkAnalyzerConfiguration +func (c *IoTWireless) CreateNetworkAnalyzerConfigurationRequest(input *CreateNetworkAnalyzerConfigurationInput) (req *request.Request, output *CreateNetworkAnalyzerConfigurationOutput) { + op := &request.Operation{ + Name: opCreateNetworkAnalyzerConfiguration, + HTTPMethod: "POST", + HTTPPath: "/network-analyzer-configurations", + } + + if input == nil { + input = &CreateNetworkAnalyzerConfigurationInput{} + } + + output = &CreateNetworkAnalyzerConfigurationOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateNetworkAnalyzerConfiguration API operation for AWS IoT Wireless. +// +// Creates a new network analyzer configuration. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS IoT Wireless's +// API operation CreateNetworkAnalyzerConfiguration for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The input did not meet the specified constraints. +// +// * ResourceNotFoundException +// Resource does not exist. +// +// * AccessDeniedException +// User does not have permission to perform this action. +// +// * ConflictException +// Adding, updating, or deleting the resource can cause an inconsistent state. +// +// * InternalServerException +// An unexpected error occurred while processing a request. +// +// * ThrottlingException +// The request was denied because it exceeded the allowed API request rate. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/CreateNetworkAnalyzerConfiguration +func (c *IoTWireless) CreateNetworkAnalyzerConfiguration(input *CreateNetworkAnalyzerConfigurationInput) (*CreateNetworkAnalyzerConfigurationOutput, error) { + req, out := c.CreateNetworkAnalyzerConfigurationRequest(input) + return out, req.Send() +} + +// CreateNetworkAnalyzerConfigurationWithContext is the same as CreateNetworkAnalyzerConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See CreateNetworkAnalyzerConfiguration for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoTWireless) CreateNetworkAnalyzerConfigurationWithContext(ctx aws.Context, input *CreateNetworkAnalyzerConfigurationInput, opts ...request.Option) (*CreateNetworkAnalyzerConfigurationOutput, error) { + req, out := c.CreateNetworkAnalyzerConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateServiceProfile = "CreateServiceProfile" // CreateServiceProfileRequest generates a "aws/request.Request" representing the @@ -1985,6 +2079,101 @@ func (c *IoTWireless) DeleteMulticastGroupWithContext(ctx aws.Context, input *De return out, req.Send() } +const opDeleteNetworkAnalyzerConfiguration = "DeleteNetworkAnalyzerConfiguration" + +// DeleteNetworkAnalyzerConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the DeleteNetworkAnalyzerConfiguration operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteNetworkAnalyzerConfiguration for more information on using the DeleteNetworkAnalyzerConfiguration +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteNetworkAnalyzerConfigurationRequest method. +// req, resp := client.DeleteNetworkAnalyzerConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/DeleteNetworkAnalyzerConfiguration +func (c *IoTWireless) DeleteNetworkAnalyzerConfigurationRequest(input *DeleteNetworkAnalyzerConfigurationInput) (req *request.Request, output *DeleteNetworkAnalyzerConfigurationOutput) { + op := &request.Operation{ + Name: opDeleteNetworkAnalyzerConfiguration, + HTTPMethod: "DELETE", + HTTPPath: "/network-analyzer-configurations/{ConfigurationName}", + } + + if input == nil { + input = &DeleteNetworkAnalyzerConfigurationInput{} + } + + output = &DeleteNetworkAnalyzerConfigurationOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteNetworkAnalyzerConfiguration API operation for AWS IoT Wireless. +// +// Deletes a network analyzer configuration. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS IoT Wireless's +// API operation DeleteNetworkAnalyzerConfiguration for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The input did not meet the specified constraints. +// +// * ResourceNotFoundException +// Resource does not exist. +// +// * AccessDeniedException +// User does not have permission to perform this action. +// +// * InternalServerException +// An unexpected error occurred while processing a request. +// +// * ConflictException +// Adding, updating, or deleting the resource can cause an inconsistent state. +// +// * ThrottlingException +// The request was denied because it exceeded the allowed API request rate. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/DeleteNetworkAnalyzerConfiguration +func (c *IoTWireless) DeleteNetworkAnalyzerConfiguration(input *DeleteNetworkAnalyzerConfigurationInput) (*DeleteNetworkAnalyzerConfigurationOutput, error) { + req, out := c.DeleteNetworkAnalyzerConfigurationRequest(input) + return out, req.Send() +} + +// DeleteNetworkAnalyzerConfigurationWithContext is the same as DeleteNetworkAnalyzerConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteNetworkAnalyzerConfiguration for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoTWireless) DeleteNetworkAnalyzerConfigurationWithContext(ctx aws.Context, input *DeleteNetworkAnalyzerConfigurationInput, opts ...request.Option) (*DeleteNetworkAnalyzerConfigurationOutput, error) { + req, out := c.DeleteNetworkAnalyzerConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteQueuedMessages = "DeleteQueuedMessages" // DeleteQueuedMessagesRequest generates a "aws/request.Request" representing the @@ -2030,7 +2219,7 @@ func (c *IoTWireless) DeleteQueuedMessagesRequest(input *DeleteQueuedMessagesInp // DeleteQueuedMessages API operation for AWS IoT Wireless. // -// The operation to delete queued messages. +// Remove queued messages from the downlink queue. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3375,6 +3564,91 @@ func (c *IoTWireless) GetDeviceProfileWithContext(ctx aws.Context, input *GetDev return out, req.Send() } +const opGetEventConfigurationByResourceTypes = "GetEventConfigurationByResourceTypes" + +// GetEventConfigurationByResourceTypesRequest generates a "aws/request.Request" representing the +// client's request for the GetEventConfigurationByResourceTypes operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetEventConfigurationByResourceTypes for more information on using the GetEventConfigurationByResourceTypes +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetEventConfigurationByResourceTypesRequest method. +// req, resp := client.GetEventConfigurationByResourceTypesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/GetEventConfigurationByResourceTypes +func (c *IoTWireless) GetEventConfigurationByResourceTypesRequest(input *GetEventConfigurationByResourceTypesInput) (req *request.Request, output *GetEventConfigurationByResourceTypesOutput) { + op := &request.Operation{ + Name: opGetEventConfigurationByResourceTypes, + HTTPMethod: "GET", + HTTPPath: "/event-configurations-resource-types", + } + + if input == nil { + input = &GetEventConfigurationByResourceTypesInput{} + } + + output = &GetEventConfigurationByResourceTypesOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetEventConfigurationByResourceTypes API operation for AWS IoT Wireless. +// +// Get the event configuration by resource types. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS IoT Wireless's +// API operation GetEventConfigurationByResourceTypes for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// User does not have permission to perform this action. +// +// * ThrottlingException +// The request was denied because it exceeded the allowed API request rate. +// +// * InternalServerException +// An unexpected error occurred while processing a request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/GetEventConfigurationByResourceTypes +func (c *IoTWireless) GetEventConfigurationByResourceTypes(input *GetEventConfigurationByResourceTypesInput) (*GetEventConfigurationByResourceTypesOutput, error) { + req, out := c.GetEventConfigurationByResourceTypesRequest(input) + return out, req.Send() +} + +// GetEventConfigurationByResourceTypesWithContext is the same as GetEventConfigurationByResourceTypes with the addition of +// the ability to pass a context and additional request options. +// +// See GetEventConfigurationByResourceTypes for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoTWireless) GetEventConfigurationByResourceTypesWithContext(ctx aws.Context, input *GetEventConfigurationByResourceTypesInput, opts ...request.Option) (*GetEventConfigurationByResourceTypesOutput, error) { + req, out := c.GetEventConfigurationByResourceTypesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetFuotaTask = "GetFuotaTask" // GetFuotaTaskRequest generates a "aws/request.Request" representing the @@ -3785,7 +4059,7 @@ func (c *IoTWireless) GetNetworkAnalyzerConfigurationRequest(input *GetNetworkAn // GetNetworkAnalyzerConfiguration API operation for AWS IoT Wireless. // -// Get NetworkAnalyzer configuration. +// Get network analyzer configuration. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5305,64 +5579,58 @@ func (c *IoTWireless) ListDeviceProfilesPagesWithContext(ctx aws.Context, input return p.Err() } -const opListFuotaTasks = "ListFuotaTasks" +const opListEventConfigurations = "ListEventConfigurations" -// ListFuotaTasksRequest generates a "aws/request.Request" representing the -// client's request for the ListFuotaTasks operation. The "output" return +// ListEventConfigurationsRequest generates a "aws/request.Request" representing the +// client's request for the ListEventConfigurations operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListFuotaTasks for more information on using the ListFuotaTasks +// See ListEventConfigurations for more information on using the ListEventConfigurations // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the ListFuotaTasksRequest method. -// req, resp := client.ListFuotaTasksRequest(params) +// // Example sending a request using the ListEventConfigurationsRequest method. +// req, resp := client.ListEventConfigurationsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListFuotaTasks -func (c *IoTWireless) ListFuotaTasksRequest(input *ListFuotaTasksInput) (req *request.Request, output *ListFuotaTasksOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListEventConfigurations +func (c *IoTWireless) ListEventConfigurationsRequest(input *ListEventConfigurationsInput) (req *request.Request, output *ListEventConfigurationsOutput) { op := &request.Operation{ - Name: opListFuotaTasks, + Name: opListEventConfigurations, HTTPMethod: "GET", - HTTPPath: "/fuota-tasks", - Paginator: &request.Paginator{ - InputTokens: []string{"NextToken"}, - OutputTokens: []string{"NextToken"}, - LimitToken: "MaxResults", - TruncationToken: "", - }, + HTTPPath: "/event-configurations", } if input == nil { - input = &ListFuotaTasksInput{} + input = &ListEventConfigurationsInput{} } - output = &ListFuotaTasksOutput{} + output = &ListEventConfigurationsOutput{} req = c.newRequest(op, input, output) return } -// ListFuotaTasks API operation for AWS IoT Wireless. +// ListEventConfigurations API operation for AWS IoT Wireless. // -// Lists the FUOTA tasks registered to your AWS account. +// List event configurations where at least one event topic has been enabled. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS IoT Wireless's -// API operation ListFuotaTasks for usage and error information. +// API operation ListEventConfigurations for usage and error information. // // Returned Error Types: // * ValidationException @@ -5371,41 +5639,135 @@ func (c *IoTWireless) ListFuotaTasksRequest(input *ListFuotaTasksInput) (req *re // * AccessDeniedException // User does not have permission to perform this action. // -// * InternalServerException -// An unexpected error occurred while processing a request. -// // * ThrottlingException // The request was denied because it exceeded the allowed API request rate. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListFuotaTasks -func (c *IoTWireless) ListFuotaTasks(input *ListFuotaTasksInput) (*ListFuotaTasksOutput, error) { - req, out := c.ListFuotaTasksRequest(input) +// * InternalServerException +// An unexpected error occurred while processing a request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListEventConfigurations +func (c *IoTWireless) ListEventConfigurations(input *ListEventConfigurationsInput) (*ListEventConfigurationsOutput, error) { + req, out := c.ListEventConfigurationsRequest(input) return out, req.Send() } -// ListFuotaTasksWithContext is the same as ListFuotaTasks with the addition of +// ListEventConfigurationsWithContext is the same as ListEventConfigurations with the addition of // the ability to pass a context and additional request options. // -// See ListFuotaTasks for details on how to use this API operation. +// See ListEventConfigurations for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *IoTWireless) ListFuotaTasksWithContext(ctx aws.Context, input *ListFuotaTasksInput, opts ...request.Option) (*ListFuotaTasksOutput, error) { - req, out := c.ListFuotaTasksRequest(input) +func (c *IoTWireless) ListEventConfigurationsWithContext(ctx aws.Context, input *ListEventConfigurationsInput, opts ...request.Option) (*ListEventConfigurationsOutput, error) { + req, out := c.ListEventConfigurationsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListFuotaTasksPages iterates over the pages of a ListFuotaTasks operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. +const opListFuotaTasks = "ListFuotaTasks" + +// ListFuotaTasksRequest generates a "aws/request.Request" representing the +// client's request for the ListFuotaTasks operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. // -// See ListFuotaTasks method for more information on how to use this operation. +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. // -// Note: This operation can generate multiple requests to a service. +// See ListFuotaTasks for more information on using the ListFuotaTasks +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListFuotaTasksRequest method. +// req, resp := client.ListFuotaTasksRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListFuotaTasks +func (c *IoTWireless) ListFuotaTasksRequest(input *ListFuotaTasksInput) (req *request.Request, output *ListFuotaTasksOutput) { + op := &request.Operation{ + Name: opListFuotaTasks, + HTTPMethod: "GET", + HTTPPath: "/fuota-tasks", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListFuotaTasksInput{} + } + + output = &ListFuotaTasksOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListFuotaTasks API operation for AWS IoT Wireless. +// +// Lists the FUOTA tasks registered to your AWS account. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS IoT Wireless's +// API operation ListFuotaTasks for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The input did not meet the specified constraints. +// +// * AccessDeniedException +// User does not have permission to perform this action. +// +// * InternalServerException +// An unexpected error occurred while processing a request. +// +// * ThrottlingException +// The request was denied because it exceeded the allowed API request rate. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListFuotaTasks +func (c *IoTWireless) ListFuotaTasks(input *ListFuotaTasksInput) (*ListFuotaTasksOutput, error) { + req, out := c.ListFuotaTasksRequest(input) + return out, req.Send() +} + +// ListFuotaTasksWithContext is the same as ListFuotaTasks with the addition of +// the ability to pass a context and additional request options. +// +// See ListFuotaTasks for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoTWireless) ListFuotaTasksWithContext(ctx aws.Context, input *ListFuotaTasksInput, opts ...request.Option) (*ListFuotaTasksOutput, error) { + req, out := c.ListFuotaTasksRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListFuotaTasksPages iterates over the pages of a ListFuotaTasks operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListFuotaTasks method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. // // // Example iterating over at most 3 pages of a ListFuotaTasks operation. // pageNum := 0 @@ -5746,6 +6108,152 @@ func (c *IoTWireless) ListMulticastGroupsByFuotaTaskPagesWithContext(ctx aws.Con return p.Err() } +const opListNetworkAnalyzerConfigurations = "ListNetworkAnalyzerConfigurations" + +// ListNetworkAnalyzerConfigurationsRequest generates a "aws/request.Request" representing the +// client's request for the ListNetworkAnalyzerConfigurations operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListNetworkAnalyzerConfigurations for more information on using the ListNetworkAnalyzerConfigurations +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListNetworkAnalyzerConfigurationsRequest method. +// req, resp := client.ListNetworkAnalyzerConfigurationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListNetworkAnalyzerConfigurations +func (c *IoTWireless) ListNetworkAnalyzerConfigurationsRequest(input *ListNetworkAnalyzerConfigurationsInput) (req *request.Request, output *ListNetworkAnalyzerConfigurationsOutput) { + op := &request.Operation{ + Name: opListNetworkAnalyzerConfigurations, + HTTPMethod: "GET", + HTTPPath: "/network-analyzer-configurations", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListNetworkAnalyzerConfigurationsInput{} + } + + output = &ListNetworkAnalyzerConfigurationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListNetworkAnalyzerConfigurations API operation for AWS IoT Wireless. +// +// Lists the network analyzer configurations. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS IoT Wireless's +// API operation ListNetworkAnalyzerConfigurations for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The input did not meet the specified constraints. +// +// * AccessDeniedException +// User does not have permission to perform this action. +// +// * InternalServerException +// An unexpected error occurred while processing a request. +// +// * ThrottlingException +// The request was denied because it exceeded the allowed API request rate. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListNetworkAnalyzerConfigurations +func (c *IoTWireless) ListNetworkAnalyzerConfigurations(input *ListNetworkAnalyzerConfigurationsInput) (*ListNetworkAnalyzerConfigurationsOutput, error) { + req, out := c.ListNetworkAnalyzerConfigurationsRequest(input) + return out, req.Send() +} + +// ListNetworkAnalyzerConfigurationsWithContext is the same as ListNetworkAnalyzerConfigurations with the addition of +// the ability to pass a context and additional request options. +// +// See ListNetworkAnalyzerConfigurations for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoTWireless) ListNetworkAnalyzerConfigurationsWithContext(ctx aws.Context, input *ListNetworkAnalyzerConfigurationsInput, opts ...request.Option) (*ListNetworkAnalyzerConfigurationsOutput, error) { + req, out := c.ListNetworkAnalyzerConfigurationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListNetworkAnalyzerConfigurationsPages iterates over the pages of a ListNetworkAnalyzerConfigurations operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListNetworkAnalyzerConfigurations method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListNetworkAnalyzerConfigurations operation. +// pageNum := 0 +// err := client.ListNetworkAnalyzerConfigurationsPages(params, +// func(page *iotwireless.ListNetworkAnalyzerConfigurationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *IoTWireless) ListNetworkAnalyzerConfigurationsPages(input *ListNetworkAnalyzerConfigurationsInput, fn func(*ListNetworkAnalyzerConfigurationsOutput, bool) bool) error { + return c.ListNetworkAnalyzerConfigurationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListNetworkAnalyzerConfigurationsPagesWithContext same as ListNetworkAnalyzerConfigurationsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoTWireless) ListNetworkAnalyzerConfigurationsPagesWithContext(ctx aws.Context, input *ListNetworkAnalyzerConfigurationsInput, fn func(*ListNetworkAnalyzerConfigurationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListNetworkAnalyzerConfigurationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListNetworkAnalyzerConfigurationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListNetworkAnalyzerConfigurationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListPartnerAccounts = "ListPartnerAccounts" // ListPartnerAccountsRequest generates a "aws/request.Request" representing the @@ -5884,7 +6392,7 @@ func (c *IoTWireless) ListQueuedMessagesRequest(input *ListQueuedMessagesInput) // ListQueuedMessages API operation for AWS IoT Wireless. // -// The operation to list queued messages. +// List queued messages in the downlink queue. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7805,134 +8313,223 @@ func (c *IoTWireless) UpdateDestinationWithContext(ctx aws.Context, input *Updat return out, req.Send() } -const opUpdateFuotaTask = "UpdateFuotaTask" +const opUpdateEventConfigurationByResourceTypes = "UpdateEventConfigurationByResourceTypes" -// UpdateFuotaTaskRequest generates a "aws/request.Request" representing the -// client's request for the UpdateFuotaTask operation. The "output" return +// UpdateEventConfigurationByResourceTypesRequest generates a "aws/request.Request" representing the +// client's request for the UpdateEventConfigurationByResourceTypes operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateFuotaTask for more information on using the UpdateFuotaTask +// See UpdateEventConfigurationByResourceTypes for more information on using the UpdateEventConfigurationByResourceTypes // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the UpdateFuotaTaskRequest method. -// req, resp := client.UpdateFuotaTaskRequest(params) +// // Example sending a request using the UpdateEventConfigurationByResourceTypesRequest method. +// req, resp := client.UpdateEventConfigurationByResourceTypesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/UpdateFuotaTask -func (c *IoTWireless) UpdateFuotaTaskRequest(input *UpdateFuotaTaskInput) (req *request.Request, output *UpdateFuotaTaskOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/UpdateEventConfigurationByResourceTypes +func (c *IoTWireless) UpdateEventConfigurationByResourceTypesRequest(input *UpdateEventConfigurationByResourceTypesInput) (req *request.Request, output *UpdateEventConfigurationByResourceTypesOutput) { op := &request.Operation{ - Name: opUpdateFuotaTask, + Name: opUpdateEventConfigurationByResourceTypes, HTTPMethod: "PATCH", - HTTPPath: "/fuota-tasks/{Id}", + HTTPPath: "/event-configurations-resource-types", } if input == nil { - input = &UpdateFuotaTaskInput{} + input = &UpdateEventConfigurationByResourceTypesInput{} } - output = &UpdateFuotaTaskOutput{} + output = &UpdateEventConfigurationByResourceTypesOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateFuotaTask API operation for AWS IoT Wireless. +// UpdateEventConfigurationByResourceTypes API operation for AWS IoT Wireless. // -// Updates properties of a FUOTA task. +// Update the event configuration by resource types. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS IoT Wireless's -// API operation UpdateFuotaTask for usage and error information. +// API operation UpdateEventConfigurationByResourceTypes for usage and error information. // // Returned Error Types: // * ValidationException // The input did not meet the specified constraints. // -// * ResourceNotFoundException -// Resource does not exist. -// // * AccessDeniedException // User does not have permission to perform this action. // -// * ConflictException -// Adding, updating, or deleting the resource can cause an inconsistent state. +// * ThrottlingException +// The request was denied because it exceeded the allowed API request rate. // // * InternalServerException // An unexpected error occurred while processing a request. // -// * ThrottlingException -// The request was denied because it exceeded the allowed API request rate. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/UpdateFuotaTask -func (c *IoTWireless) UpdateFuotaTask(input *UpdateFuotaTaskInput) (*UpdateFuotaTaskOutput, error) { - req, out := c.UpdateFuotaTaskRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/UpdateEventConfigurationByResourceTypes +func (c *IoTWireless) UpdateEventConfigurationByResourceTypes(input *UpdateEventConfigurationByResourceTypesInput) (*UpdateEventConfigurationByResourceTypesOutput, error) { + req, out := c.UpdateEventConfigurationByResourceTypesRequest(input) return out, req.Send() } -// UpdateFuotaTaskWithContext is the same as UpdateFuotaTask with the addition of +// UpdateEventConfigurationByResourceTypesWithContext is the same as UpdateEventConfigurationByResourceTypes with the addition of // the ability to pass a context and additional request options. // -// See UpdateFuotaTask for details on how to use this API operation. +// See UpdateEventConfigurationByResourceTypes for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *IoTWireless) UpdateFuotaTaskWithContext(ctx aws.Context, input *UpdateFuotaTaskInput, opts ...request.Option) (*UpdateFuotaTaskOutput, error) { - req, out := c.UpdateFuotaTaskRequest(input) +func (c *IoTWireless) UpdateEventConfigurationByResourceTypesWithContext(ctx aws.Context, input *UpdateEventConfigurationByResourceTypesInput, opts ...request.Option) (*UpdateEventConfigurationByResourceTypesOutput, error) { + req, out := c.UpdateEventConfigurationByResourceTypesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateLogLevelsByResourceTypes = "UpdateLogLevelsByResourceTypes" +const opUpdateFuotaTask = "UpdateFuotaTask" -// UpdateLogLevelsByResourceTypesRequest generates a "aws/request.Request" representing the -// client's request for the UpdateLogLevelsByResourceTypes operation. The "output" return +// UpdateFuotaTaskRequest generates a "aws/request.Request" representing the +// client's request for the UpdateFuotaTask operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateLogLevelsByResourceTypes for more information on using the UpdateLogLevelsByResourceTypes +// See UpdateFuotaTask for more information on using the UpdateFuotaTask // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the UpdateLogLevelsByResourceTypesRequest method. -// req, resp := client.UpdateLogLevelsByResourceTypesRequest(params) +// // Example sending a request using the UpdateFuotaTaskRequest method. +// req, resp := client.UpdateFuotaTaskRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/UpdateLogLevelsByResourceTypes -func (c *IoTWireless) UpdateLogLevelsByResourceTypesRequest(input *UpdateLogLevelsByResourceTypesInput) (req *request.Request, output *UpdateLogLevelsByResourceTypesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/UpdateFuotaTask +func (c *IoTWireless) UpdateFuotaTaskRequest(input *UpdateFuotaTaskInput) (req *request.Request, output *UpdateFuotaTaskOutput) { op := &request.Operation{ - Name: opUpdateLogLevelsByResourceTypes, - HTTPMethod: "POST", - HTTPPath: "/log-levels", - } - + Name: opUpdateFuotaTask, + HTTPMethod: "PATCH", + HTTPPath: "/fuota-tasks/{Id}", + } + + if input == nil { + input = &UpdateFuotaTaskInput{} + } + + output = &UpdateFuotaTaskOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateFuotaTask API operation for AWS IoT Wireless. +// +// Updates properties of a FUOTA task. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS IoT Wireless's +// API operation UpdateFuotaTask for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The input did not meet the specified constraints. +// +// * ResourceNotFoundException +// Resource does not exist. +// +// * AccessDeniedException +// User does not have permission to perform this action. +// +// * ConflictException +// Adding, updating, or deleting the resource can cause an inconsistent state. +// +// * InternalServerException +// An unexpected error occurred while processing a request. +// +// * ThrottlingException +// The request was denied because it exceeded the allowed API request rate. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/UpdateFuotaTask +func (c *IoTWireless) UpdateFuotaTask(input *UpdateFuotaTaskInput) (*UpdateFuotaTaskOutput, error) { + req, out := c.UpdateFuotaTaskRequest(input) + return out, req.Send() +} + +// UpdateFuotaTaskWithContext is the same as UpdateFuotaTask with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateFuotaTask for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IoTWireless) UpdateFuotaTaskWithContext(ctx aws.Context, input *UpdateFuotaTaskInput, opts ...request.Option) (*UpdateFuotaTaskOutput, error) { + req, out := c.UpdateFuotaTaskRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateLogLevelsByResourceTypes = "UpdateLogLevelsByResourceTypes" + +// UpdateLogLevelsByResourceTypesRequest generates a "aws/request.Request" representing the +// client's request for the UpdateLogLevelsByResourceTypes operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateLogLevelsByResourceTypes for more information on using the UpdateLogLevelsByResourceTypes +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateLogLevelsByResourceTypesRequest method. +// req, resp := client.UpdateLogLevelsByResourceTypesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/UpdateLogLevelsByResourceTypes +func (c *IoTWireless) UpdateLogLevelsByResourceTypesRequest(input *UpdateLogLevelsByResourceTypesInput) (req *request.Request, output *UpdateLogLevelsByResourceTypesOutput) { + op := &request.Operation{ + Name: opUpdateLogLevelsByResourceTypes, + HTTPMethod: "POST", + HTTPPath: "/log-levels", + } + if input == nil { input = &UpdateLogLevelsByResourceTypesInput{} } @@ -8137,7 +8734,7 @@ func (c *IoTWireless) UpdateNetworkAnalyzerConfigurationRequest(input *UpdateNet // UpdateNetworkAnalyzerConfiguration API operation for AWS IoT Wireless. // -// Update NetworkAnalyzer configuration. +// Update network analyzer configuration. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8559,6 +9156,9 @@ type AbpV10X struct { // The DevAddr value. DevAddr *string `type:"string"` + // The FCnt init value. + FCntStart *int64 `type:"integer"` + // Session keys for ABP v1.0.x SessionKeys *SessionKeysAbpV10X `type:"structure"` } @@ -8587,6 +9187,12 @@ func (s *AbpV10X) SetDevAddr(v string) *AbpV10X { return s } +// SetFCntStart sets the FCntStart field's value. +func (s *AbpV10X) SetFCntStart(v int64) *AbpV10X { + s.FCntStart = &v + return s +} + // SetSessionKeys sets the SessionKeys field's value. func (s *AbpV10X) SetSessionKeys(v *SessionKeysAbpV10X) *AbpV10X { s.SessionKeys = v @@ -8600,6 +9206,9 @@ type AbpV11 struct { // The DevAddr value. DevAddr *string `type:"string"` + // The FCnt init value. + FCntStart *int64 `type:"integer"` + // Session keys for ABP v1.1 SessionKeys *SessionKeysAbpV11 `type:"structure"` } @@ -8628,6 +9237,12 @@ func (s *AbpV11) SetDevAddr(v string) *AbpV11 { return s } +// SetFCntStart sets the FCntStart field's value. +func (s *AbpV11) SetFCntStart(v int64) *AbpV11 { + s.FCntStart = &v + return s +} + // SetSessionKeys sets the SessionKeys field's value. func (s *AbpV11) SetSessionKeys(v *SessionKeysAbpV11) *AbpV11 { s.SessionKeys = v @@ -9532,6 +10147,83 @@ func (s *ConflictException) RequestID() string { return s.RespMetadata.RequestID } +// Connection status event configuration object for enabling or disabling topic. +type ConnectionStatusEventConfiguration struct { + _ struct{} `type:"structure"` + + // Connection status event configuration object for enabling or disabling LoRaWAN + // related event topics. + LoRaWAN *LoRaWANConnectionStatusEventNotificationConfigurations `type:"structure"` + + // Enum to denote whether the wireless gateway id connection status event topic + // is enabled or disabled . + WirelessGatewayIdEventTopic *string `type:"string" enum:"EventNotificationTopicStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConnectionStatusEventConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConnectionStatusEventConfiguration) GoString() string { + return s.String() +} + +// SetLoRaWAN sets the LoRaWAN field's value. +func (s *ConnectionStatusEventConfiguration) SetLoRaWAN(v *LoRaWANConnectionStatusEventNotificationConfigurations) *ConnectionStatusEventConfiguration { + s.LoRaWAN = v + return s +} + +// SetWirelessGatewayIdEventTopic sets the WirelessGatewayIdEventTopic field's value. +func (s *ConnectionStatusEventConfiguration) SetWirelessGatewayIdEventTopic(v string) *ConnectionStatusEventConfiguration { + s.WirelessGatewayIdEventTopic = &v + return s +} + +// Connection status resource type event configuration object for enabling or +// disabling topic. +type ConnectionStatusResourceTypeEventConfiguration struct { + _ struct{} `type:"structure"` + + // Connection status resource type event configuration object for enabling or + // disabling LoRaWAN related event topics. + LoRaWAN *LoRaWANConnectionStatusResourceTypeEventConfiguration `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConnectionStatusResourceTypeEventConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConnectionStatusResourceTypeEventConfiguration) GoString() string { + return s.String() +} + +// SetLoRaWAN sets the LoRaWAN field's value. +func (s *ConnectionStatusResourceTypeEventConfiguration) SetLoRaWAN(v *LoRaWANConnectionStatusResourceTypeEventConfiguration) *ConnectionStatusResourceTypeEventConfiguration { + s.LoRaWAN = v + return s +} + type CreateDestinationInput struct { _ struct{} `type:"structure"` @@ -10145,7 +10837,7 @@ func (s *CreateMulticastGroupOutput) SetId(v string) *CreateMulticastGroupOutput return s } -type CreateServiceProfileInput struct { +type CreateNetworkAnalyzerConfigurationInput struct { _ struct{} `type:"structure"` // Each resource must have a unique client request token. If you try to create @@ -10154,15 +10846,28 @@ type CreateServiceProfileInput struct { // a unique client request. ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` - // The service profile information to use to create the service profile. - LoRaWAN *LoRaWANServiceProfile `type:"structure"` + // The description of the new resource. + Description *string `type:"string"` - // The name of the new resource. - Name *string `type:"string"` + // Name of the network analyzer configuration. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` - // The tags to attach to the new service profile. Tags are metadata that you - // can use to manage a resource. + // The tag to attach to the specified resource. Tags are metadata that you can + // use to manage a resource. Tags []*Tag `type:"list"` + + // Trace content for your wireless gateway and wireless device resources. + TraceContent *TraceContent `type:"structure"` + + // Wireless device resources to add to the network analyzer configuration. Provide + // the WirelessDeviceId of the resource to add in the input array. + WirelessDevices []*string `type:"list"` + + // Wireless gateway resources to add to the network analyzer configuration. + // Provide the WirelessGatewayId of the resource to add in the input array. + WirelessGateways []*string `type:"list"` } // String returns the string representation. @@ -10170,7 +10875,7 @@ type CreateServiceProfileInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateServiceProfileInput) String() string { +func (s CreateNetworkAnalyzerConfigurationInput) String() string { return awsutil.Prettify(s) } @@ -10179,16 +10884,22 @@ func (s CreateServiceProfileInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateServiceProfileInput) GoString() string { +func (s CreateNetworkAnalyzerConfigurationInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateServiceProfileInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateServiceProfileInput"} +func (s *CreateNetworkAnalyzerConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateNetworkAnalyzerConfigurationInput"} if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } if s.Tags != nil { for i, v := range s.Tags { if v == nil { @@ -10207,37 +10918,55 @@ func (s *CreateServiceProfileInput) Validate() error { } // SetClientRequestToken sets the ClientRequestToken field's value. -func (s *CreateServiceProfileInput) SetClientRequestToken(v string) *CreateServiceProfileInput { +func (s *CreateNetworkAnalyzerConfigurationInput) SetClientRequestToken(v string) *CreateNetworkAnalyzerConfigurationInput { s.ClientRequestToken = &v return s } -// SetLoRaWAN sets the LoRaWAN field's value. -func (s *CreateServiceProfileInput) SetLoRaWAN(v *LoRaWANServiceProfile) *CreateServiceProfileInput { - s.LoRaWAN = v +// SetDescription sets the Description field's value. +func (s *CreateNetworkAnalyzerConfigurationInput) SetDescription(v string) *CreateNetworkAnalyzerConfigurationInput { + s.Description = &v return s } // SetName sets the Name field's value. -func (s *CreateServiceProfileInput) SetName(v string) *CreateServiceProfileInput { +func (s *CreateNetworkAnalyzerConfigurationInput) SetName(v string) *CreateNetworkAnalyzerConfigurationInput { s.Name = &v return s } // SetTags sets the Tags field's value. -func (s *CreateServiceProfileInput) SetTags(v []*Tag) *CreateServiceProfileInput { +func (s *CreateNetworkAnalyzerConfigurationInput) SetTags(v []*Tag) *CreateNetworkAnalyzerConfigurationInput { s.Tags = v return s } -type CreateServiceProfileOutput struct { +// SetTraceContent sets the TraceContent field's value. +func (s *CreateNetworkAnalyzerConfigurationInput) SetTraceContent(v *TraceContent) *CreateNetworkAnalyzerConfigurationInput { + s.TraceContent = v + return s +} + +// SetWirelessDevices sets the WirelessDevices field's value. +func (s *CreateNetworkAnalyzerConfigurationInput) SetWirelessDevices(v []*string) *CreateNetworkAnalyzerConfigurationInput { + s.WirelessDevices = v + return s +} + +// SetWirelessGateways sets the WirelessGateways field's value. +func (s *CreateNetworkAnalyzerConfigurationInput) SetWirelessGateways(v []*string) *CreateNetworkAnalyzerConfigurationInput { + s.WirelessGateways = v + return s +} + +type CreateNetworkAnalyzerConfigurationOutput struct { _ struct{} `type:"structure"` // The Amazon Resource Name of the new resource. Arn *string `type:"string"` - // The ID of the new service profile. - Id *string `type:"string"` + // Name of the network analyzer configuration. + Name *string `min:"1" type:"string"` } // String returns the string representation. @@ -10245,7 +10974,7 @@ type CreateServiceProfileOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateServiceProfileOutput) String() string { +func (s CreateNetworkAnalyzerConfigurationOutput) String() string { return awsutil.Prettify(s) } @@ -10254,23 +10983,23 @@ func (s CreateServiceProfileOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateServiceProfileOutput) GoString() string { +func (s CreateNetworkAnalyzerConfigurationOutput) GoString() string { return s.String() } // SetArn sets the Arn field's value. -func (s *CreateServiceProfileOutput) SetArn(v string) *CreateServiceProfileOutput { +func (s *CreateNetworkAnalyzerConfigurationOutput) SetArn(v string) *CreateNetworkAnalyzerConfigurationOutput { s.Arn = &v return s } -// SetId sets the Id field's value. -func (s *CreateServiceProfileOutput) SetId(v string) *CreateServiceProfileOutput { - s.Id = &v +// SetName sets the Name field's value. +func (s *CreateNetworkAnalyzerConfigurationOutput) SetName(v string) *CreateNetworkAnalyzerConfigurationOutput { + s.Name = &v return s } -type CreateWirelessDeviceInput struct { +type CreateServiceProfileInput struct { _ struct{} `type:"structure"` // Each resource must have a unique client request token. If you try to create @@ -10279,28 +11008,15 @@ type CreateWirelessDeviceInput struct { // a unique client request. ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` - // The description of the new resource. - Description *string `type:"string"` - - // The name of the destination to assign to the new wireless device. - // - // DestinationName is a required field - DestinationName *string `type:"string" required:"true"` - - // The device configuration information to use to create the wireless device. - LoRaWAN *LoRaWANDevice `type:"structure"` + // The service profile information to use to create the service profile. + LoRaWAN *LoRaWANServiceProfile `type:"structure"` // The name of the new resource. Name *string `type:"string"` - // The tags to attach to the new wireless device. Tags are metadata that you + // The tags to attach to the new service profile. Tags are metadata that you // can use to manage a resource. Tags []*Tag `type:"list"` - - // The wireless device type. - // - // Type is a required field - Type *string `type:"string" required:"true" enum:"WirelessDeviceType"` } // String returns the string representation. @@ -10308,7 +11024,7 @@ type CreateWirelessDeviceInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateWirelessDeviceInput) String() string { +func (s CreateServiceProfileInput) String() string { return awsutil.Prettify(s) } @@ -10317,17 +11033,155 @@ func (s CreateWirelessDeviceInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateWirelessDeviceInput) GoString() string { +func (s CreateServiceProfileInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateWirelessDeviceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateWirelessDeviceInput"} +func (s *CreateServiceProfileInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateServiceProfileInput"} if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) } - if s.DestinationName == nil { + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *CreateServiceProfileInput) SetClientRequestToken(v string) *CreateServiceProfileInput { + s.ClientRequestToken = &v + return s +} + +// SetLoRaWAN sets the LoRaWAN field's value. +func (s *CreateServiceProfileInput) SetLoRaWAN(v *LoRaWANServiceProfile) *CreateServiceProfileInput { + s.LoRaWAN = v + return s +} + +// SetName sets the Name field's value. +func (s *CreateServiceProfileInput) SetName(v string) *CreateServiceProfileInput { + s.Name = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateServiceProfileInput) SetTags(v []*Tag) *CreateServiceProfileInput { + s.Tags = v + return s +} + +type CreateServiceProfileOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name of the new resource. + Arn *string `type:"string"` + + // The ID of the new service profile. + Id *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateServiceProfileOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateServiceProfileOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *CreateServiceProfileOutput) SetArn(v string) *CreateServiceProfileOutput { + s.Arn = &v + return s +} + +// SetId sets the Id field's value. +func (s *CreateServiceProfileOutput) SetId(v string) *CreateServiceProfileOutput { + s.Id = &v + return s +} + +type CreateWirelessDeviceInput struct { + _ struct{} `type:"structure"` + + // Each resource must have a unique client request token. If you try to create + // a new resource with the same token as a resource that already exists, an + // exception occurs. If you omit this value, AWS SDKs will automatically generate + // a unique client request. + ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // The description of the new resource. + Description *string `type:"string"` + + // The name of the destination to assign to the new wireless device. + // + // DestinationName is a required field + DestinationName *string `type:"string" required:"true"` + + // The device configuration information to use to create the wireless device. + LoRaWAN *LoRaWANDevice `type:"structure"` + + // The name of the new resource. + Name *string `type:"string"` + + // The tags to attach to the new wireless device. Tags are metadata that you + // can use to manage a resource. + Tags []*Tag `type:"list"` + + // The wireless device type. + // + // Type is a required field + Type *string `type:"string" required:"true" enum:"WirelessDeviceType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateWirelessDeviceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateWirelessDeviceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateWirelessDeviceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateWirelessDeviceInput"} + if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) + } + if s.DestinationName == nil { invalidParams.Add(request.NewErrParamRequired("DestinationName")) } if s.Type == nil { @@ -11112,21 +11966,93 @@ func (s DeleteMulticastGroupOutput) GoString() string { return s.String() } +type DeleteNetworkAnalyzerConfigurationInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // Name of the network analyzer configuration. + // + // ConfigurationName is a required field + ConfigurationName *string `location:"uri" locationName:"ConfigurationName" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteNetworkAnalyzerConfigurationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteNetworkAnalyzerConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteNetworkAnalyzerConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteNetworkAnalyzerConfigurationInput"} + if s.ConfigurationName == nil { + invalidParams.Add(request.NewErrParamRequired("ConfigurationName")) + } + if s.ConfigurationName != nil && len(*s.ConfigurationName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ConfigurationName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetConfigurationName sets the ConfigurationName field's value. +func (s *DeleteNetworkAnalyzerConfigurationInput) SetConfigurationName(v string) *DeleteNetworkAnalyzerConfigurationInput { + s.ConfigurationName = &v + return s +} + +type DeleteNetworkAnalyzerConfigurationOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteNetworkAnalyzerConfigurationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteNetworkAnalyzerConfigurationOutput) GoString() string { + return s.String() +} + type DeleteQueuedMessagesInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Id of a given wireless device which messages will be deleted + // The ID of a given wireless device for which downlink messages will be deleted. // // Id is a required field Id *string `location:"uri" locationName:"Id" type:"string" required:"true"` - // if messageID=="*", the queue for a particular wireless deviceId will be purged, - // otherwise, the specific message with messageId will be deleted + // If message ID is "*", it cleares the entire downlink queue for a given device, + // specified by the wireless device ID. Otherwise, the downlink message with + // the specified message ID will be deleted. // // MessageId is a required field MessageId *string `location:"querystring" locationName:"messageId" type:"string" required:"true"` - // The wireless device type, it is either Sidewalk or LoRaWAN. + // The wireless device type, which can be either Sidewalk or LoRaWAN. WirelessDeviceType *string `location:"querystring" locationName:"WirelessDeviceType" type:"string" enum:"WirelessDeviceType"` } @@ -11697,6 +12623,10 @@ type DeviceRegistrationStateEventConfiguration struct { // Device registration state event configuration object for enabling or disabling // Sidewalk related event topics. Sidewalk *SidewalkEventNotificationConfigurations `type:"structure"` + + // Enum to denote whether the wireless device id device registration state event + // topic is enabled or disabled. + WirelessDeviceIdEventTopic *string `type:"string" enum:"EventNotificationTopicStatus"` } // String returns the string representation. @@ -11723,6 +12653,46 @@ func (s *DeviceRegistrationStateEventConfiguration) SetSidewalk(v *SidewalkEvent return s } +// SetWirelessDeviceIdEventTopic sets the WirelessDeviceIdEventTopic field's value. +func (s *DeviceRegistrationStateEventConfiguration) SetWirelessDeviceIdEventTopic(v string) *DeviceRegistrationStateEventConfiguration { + s.WirelessDeviceIdEventTopic = &v + return s +} + +// Device registration state resource type event configuration object for enabling +// or disabling topic. +type DeviceRegistrationStateResourceTypeEventConfiguration struct { + _ struct{} `type:"structure"` + + // Device registration resource type state event configuration object for enabling + // or disabling Sidewalk related event topics. + Sidewalk *SidewalkResourceTypeEventConfiguration `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeviceRegistrationStateResourceTypeEventConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeviceRegistrationStateResourceTypeEventConfiguration) GoString() string { + return s.String() +} + +// SetSidewalk sets the Sidewalk field's value. +func (s *DeviceRegistrationStateResourceTypeEventConfiguration) SetSidewalk(v *SidewalkResourceTypeEventConfiguration) *DeviceRegistrationStateResourceTypeEventConfiguration { + s.Sidewalk = v + return s +} + type DisassociateAwsAccountFromPartnerAccountInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -12285,21 +13255,22 @@ func (s DisassociateWirelessGatewayFromThingOutput) GoString() string { return s.String() } -// The message in downlink queue. +// The message in the downlink queue. type DownlinkQueueMessage struct { _ struct{} `type:"structure"` // LoRaWAN router info. LoRaWAN *LoRaWANSendDataToDevice `type:"structure"` - // The messageId allocated by IoT Wireless for tracing purpose + // The message ID assigned by IoT Wireless to each downlink message, which helps + // identify the message. MessageId *string `type:"string"` - // The timestamp that Iot Wireless received the message. + // The time at which Iot Wireless received the downlink message. ReceivedAt *string `type:"string"` - // The transmit mode to use to send data to the wireless device. Can be: 0 for - // UM (unacknowledge mode) or 1 for AM (acknowledge mode). + // The transmit mode to use for sending data to the wireless device. This can + // be 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode). TransmitMode *int64 `type:"integer"` } @@ -12345,18 +13316,21 @@ func (s *DownlinkQueueMessage) SetTransmitMode(v int64) *DownlinkQueueMessage { return s } -// List of FPort assigned for different LoRaWAN application packages to use -type FPorts struct { +// Event configuration object for a single resource. +type EventConfigurationItem struct { _ struct{} `type:"structure"` - // The Fport value. - ClockSync *int64 `min:"1" type:"integer"` + // Object of all event configurations and the status of the event topics. + Events *EventNotificationItemConfigurations `type:"structure"` - // The Fport value. - Fuota *int64 `min:"1" type:"integer"` + // Resource identifier opted in for event messaging. + Identifier *string `type:"string"` - // The Fport value. - Multicast *int64 `min:"1" type:"integer"` + // Identifier type of the particular resource identifier for event configuration. + IdentifierType *string `type:"string" enum:"IdentifierType"` + + // Partner type of the resource if the identifier type is PartnerAccountId. + PartnerType *string `type:"string" enum:"EventNotificationPartnerType"` } // String returns the string representation. @@ -12364,7 +13338,7 @@ type FPorts struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s FPorts) String() string { +func (s EventConfigurationItem) String() string { return awsutil.Prettify(s) } @@ -12373,22 +13347,138 @@ func (s FPorts) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s FPorts) GoString() string { +func (s EventConfigurationItem) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *FPorts) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "FPorts"} - if s.ClockSync != nil && *s.ClockSync < 1 { - invalidParams.Add(request.NewErrParamMinValue("ClockSync", 1)) - } - if s.Fuota != nil && *s.Fuota < 1 { - invalidParams.Add(request.NewErrParamMinValue("Fuota", 1)) - } - if s.Multicast != nil && *s.Multicast < 1 { - invalidParams.Add(request.NewErrParamMinValue("Multicast", 1)) - } +// SetEvents sets the Events field's value. +func (s *EventConfigurationItem) SetEvents(v *EventNotificationItemConfigurations) *EventConfigurationItem { + s.Events = v + return s +} + +// SetIdentifier sets the Identifier field's value. +func (s *EventConfigurationItem) SetIdentifier(v string) *EventConfigurationItem { + s.Identifier = &v + return s +} + +// SetIdentifierType sets the IdentifierType field's value. +func (s *EventConfigurationItem) SetIdentifierType(v string) *EventConfigurationItem { + s.IdentifierType = &v + return s +} + +// SetPartnerType sets the PartnerType field's value. +func (s *EventConfigurationItem) SetPartnerType(v string) *EventConfigurationItem { + s.PartnerType = &v + return s +} + +// Object of all event configurations and the status of the event topics. +type EventNotificationItemConfigurations struct { + _ struct{} `type:"structure"` + + // Connection status event configuration for an event configuration item. + ConnectionStatus *ConnectionStatusEventConfiguration `type:"structure"` + + // Device registration state event configuration for an event configuration + // item. + DeviceRegistrationState *DeviceRegistrationStateEventConfiguration `type:"structure"` + + // Join event configuration for an event configuration item. + Join *JoinEventConfiguration `type:"structure"` + + // Proximity event configuration for an event configuration item. + Proximity *ProximityEventConfiguration `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EventNotificationItemConfigurations) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EventNotificationItemConfigurations) GoString() string { + return s.String() +} + +// SetConnectionStatus sets the ConnectionStatus field's value. +func (s *EventNotificationItemConfigurations) SetConnectionStatus(v *ConnectionStatusEventConfiguration) *EventNotificationItemConfigurations { + s.ConnectionStatus = v + return s +} + +// SetDeviceRegistrationState sets the DeviceRegistrationState field's value. +func (s *EventNotificationItemConfigurations) SetDeviceRegistrationState(v *DeviceRegistrationStateEventConfiguration) *EventNotificationItemConfigurations { + s.DeviceRegistrationState = v + return s +} + +// SetJoin sets the Join field's value. +func (s *EventNotificationItemConfigurations) SetJoin(v *JoinEventConfiguration) *EventNotificationItemConfigurations { + s.Join = v + return s +} + +// SetProximity sets the Proximity field's value. +func (s *EventNotificationItemConfigurations) SetProximity(v *ProximityEventConfiguration) *EventNotificationItemConfigurations { + s.Proximity = v + return s +} + +// List of FPort assigned for different LoRaWAN application packages to use +type FPorts struct { + _ struct{} `type:"structure"` + + // The Fport value. + ClockSync *int64 `min:"1" type:"integer"` + + // The Fport value. + Fuota *int64 `min:"1" type:"integer"` + + // The Fport value. + Multicast *int64 `min:"1" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FPorts) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FPorts) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *FPorts) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "FPorts"} + if s.ClockSync != nil && *s.ClockSync < 1 { + invalidParams.Add(request.NewErrParamMinValue("ClockSync", 1)) + } + if s.Fuota != nil && *s.Fuota < 1 { + invalidParams.Add(request.NewErrParamMinValue("Fuota", 1)) + } + if s.Multicast != nil && *s.Multicast < 1 { + invalidParams.Add(request.NewErrParamMinValue("Multicast", 1)) + } if invalidParams.Len() > 0 { return invalidParams @@ -12696,6 +13786,86 @@ func (s *GetDeviceProfileOutput) SetName(v string) *GetDeviceProfileOutput { return s } +type GetEventConfigurationByResourceTypesInput struct { + _ struct{} `type:"structure" nopayload:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetEventConfigurationByResourceTypesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetEventConfigurationByResourceTypesInput) GoString() string { + return s.String() +} + +type GetEventConfigurationByResourceTypesOutput struct { + _ struct{} `type:"structure"` + + // Resource type event configuration for the connection status event + ConnectionStatus *ConnectionStatusResourceTypeEventConfiguration `type:"structure"` + + // Resource type event configuration for the device registration state event + DeviceRegistrationState *DeviceRegistrationStateResourceTypeEventConfiguration `type:"structure"` + + // Resource type event configuration for the join event + Join *JoinResourceTypeEventConfiguration `type:"structure"` + + // Resource type event configuration for the proximity event + Proximity *ProximityResourceTypeEventConfiguration `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetEventConfigurationByResourceTypesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetEventConfigurationByResourceTypesOutput) GoString() string { + return s.String() +} + +// SetConnectionStatus sets the ConnectionStatus field's value. +func (s *GetEventConfigurationByResourceTypesOutput) SetConnectionStatus(v *ConnectionStatusResourceTypeEventConfiguration) *GetEventConfigurationByResourceTypesOutput { + s.ConnectionStatus = v + return s +} + +// SetDeviceRegistrationState sets the DeviceRegistrationState field's value. +func (s *GetEventConfigurationByResourceTypesOutput) SetDeviceRegistrationState(v *DeviceRegistrationStateResourceTypeEventConfiguration) *GetEventConfigurationByResourceTypesOutput { + s.DeviceRegistrationState = v + return s +} + +// SetJoin sets the Join field's value. +func (s *GetEventConfigurationByResourceTypesOutput) SetJoin(v *JoinResourceTypeEventConfiguration) *GetEventConfigurationByResourceTypesOutput { + s.Join = v + return s +} + +// SetProximity sets the Proximity field's value. +func (s *GetEventConfigurationByResourceTypesOutput) SetProximity(v *ProximityResourceTypeEventConfiguration) *GetEventConfigurationByResourceTypesOutput { + s.Proximity = v + return s +} + type GetFuotaTaskInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -12874,7 +14044,9 @@ func (s GetLogLevelsByResourceTypesInput) GoString() string { type GetLogLevelsByResourceTypesOutput struct { _ struct{} `type:"structure"` - // The log level for a log message. + // The log level for a log message. The log levels can be disabled, or set to + // ERROR to display less verbose logs containing only error information, or + // to INFO for more detailed logs. DefaultLogLevel *string `type:"string" enum:"LogLevel"` // The list of wireless device log options. @@ -13138,7 +14310,7 @@ func (s *GetMulticastGroupSessionOutput) SetLoRaWAN(v *LoRaWANMulticastSession) type GetNetworkAnalyzerConfigurationInput struct { _ struct{} `type:"structure" nopayload:"true"` - // NetworkAnalyzer configuration name. + // Name of the network analyzer configuration. // // ConfigurationName is a required field ConfigurationName *string `location:"uri" locationName:"ConfigurationName" min:"1" type:"string" required:"true"` @@ -13187,13 +14359,24 @@ func (s *GetNetworkAnalyzerConfigurationInput) SetConfigurationName(v string) *G type GetNetworkAnalyzerConfigurationOutput struct { _ struct{} `type:"structure"` - // Trace Content for resources. + // The Amazon Resource Name of the new resource. + Arn *string `type:"string"` + + // The description of the new resource. + Description *string `type:"string"` + + // Name of the network analyzer configuration. + Name *string `min:"1" type:"string"` + + // Trace content for your wireless gateway and wireless device resources. TraceContent *TraceContent `type:"structure"` - // List of WirelessDevices in the NetworkAnalyzerConfiguration. + // List of wireless gateway resources that have been added to the network analyzer + // configuration. WirelessDevices []*string `type:"list"` - // List of WirelessGateways in the NetworkAnalyzerConfiguration. + // List of wireless gateway resources that have been added to the network analyzer + // configuration. WirelessGateways []*string `type:"list"` } @@ -13215,6 +14398,24 @@ func (s GetNetworkAnalyzerConfigurationOutput) GoString() string { return s.String() } +// SetArn sets the Arn field's value. +func (s *GetNetworkAnalyzerConfigurationOutput) SetArn(v string) *GetNetworkAnalyzerConfigurationOutput { + s.Arn = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *GetNetworkAnalyzerConfigurationOutput) SetDescription(v string) *GetNetworkAnalyzerConfigurationOutput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *GetNetworkAnalyzerConfigurationOutput) SetName(v string) *GetNetworkAnalyzerConfigurationOutput { + s.Name = &v + return s +} + // SetTraceContent sets the TraceContent field's value. func (s *GetNetworkAnalyzerConfigurationOutput) SetTraceContent(v *TraceContent) *GetNetworkAnalyzerConfigurationOutput { s.TraceContent = v @@ -13411,9 +14612,15 @@ func (s *GetResourceEventConfigurationInput) SetPartnerType(v string) *GetResour type GetResourceEventConfigurationOutput struct { _ struct{} `type:"structure"` + // Event configuration for the connection status event. + ConnectionStatus *ConnectionStatusEventConfiguration `type:"structure"` + // Event configuration for the device registration state event DeviceRegistrationState *DeviceRegistrationStateEventConfiguration `type:"structure"` + // Event configuration for the join event. + Join *JoinEventConfiguration `type:"structure"` + // Event configuration for the Proximity event Proximity *ProximityEventConfiguration `type:"structure"` } @@ -13436,12 +14643,24 @@ func (s GetResourceEventConfigurationOutput) GoString() string { return s.String() } +// SetConnectionStatus sets the ConnectionStatus field's value. +func (s *GetResourceEventConfigurationOutput) SetConnectionStatus(v *ConnectionStatusEventConfiguration) *GetResourceEventConfigurationOutput { + s.ConnectionStatus = v + return s +} + // SetDeviceRegistrationState sets the DeviceRegistrationState field's value. func (s *GetResourceEventConfigurationOutput) SetDeviceRegistrationState(v *DeviceRegistrationStateEventConfiguration) *GetResourceEventConfigurationOutput { s.DeviceRegistrationState = v return s } +// SetJoin sets the Join field's value. +func (s *GetResourceEventConfigurationOutput) SetJoin(v *JoinEventConfiguration) *GetResourceEventConfigurationOutput { + s.Join = v + return s +} + // SetProximity sets the Proximity field's value. func (s *GetResourceEventConfigurationOutput) SetProximity(v *ProximityEventConfiguration) *GetResourceEventConfigurationOutput { s.Proximity = v @@ -13515,7 +14734,9 @@ func (s *GetResourceLogLevelInput) SetResourceType(v string) *GetResourceLogLeve type GetResourceLogLevelOutput struct { _ struct{} `type:"structure"` - // The log level for a log message. + // The log level for a log message. The log levels can be disabled, or set to + // ERROR to display less verbose logs containing only error information, or + // to INFO for more detailed logs. LogLevel *string `type:"string" enum:"LogLevel"` } @@ -13548,7 +14769,7 @@ type GetServiceEndpointInput struct { // The service type for which to get endpoint information about. Can be CUPS // for the Configuration and Update Server endpoint, or LNS for the LoRaWAN - // Network Server endpoint. + // Network Server endpoint or CLAIM for the global endpoint. ServiceType *string `location:"querystring" locationName:"serviceType" type:"string" enum:"WirelessGatewayServiceType"` } @@ -14721,6 +15942,82 @@ func (s *InternalServerException) RequestID() string { return s.RespMetadata.RequestID } +// Join event configuration object for enabling or disabling topic. +type JoinEventConfiguration struct { + _ struct{} `type:"structure"` + + // Join event configuration object for enabling or disabling LoRaWAN related + // event topics. + LoRaWAN *LoRaWANJoinEventNotificationConfigurations `type:"structure"` + + // Enum to denote whether the wireless device id join event topic is enabled + // or disabled. + WirelessDeviceIdEventTopic *string `type:"string" enum:"EventNotificationTopicStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s JoinEventConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s JoinEventConfiguration) GoString() string { + return s.String() +} + +// SetLoRaWAN sets the LoRaWAN field's value. +func (s *JoinEventConfiguration) SetLoRaWAN(v *LoRaWANJoinEventNotificationConfigurations) *JoinEventConfiguration { + s.LoRaWAN = v + return s +} + +// SetWirelessDeviceIdEventTopic sets the WirelessDeviceIdEventTopic field's value. +func (s *JoinEventConfiguration) SetWirelessDeviceIdEventTopic(v string) *JoinEventConfiguration { + s.WirelessDeviceIdEventTopic = &v + return s +} + +// Join resource type event configuration object for enabling or disabling topic. +type JoinResourceTypeEventConfiguration struct { + _ struct{} `type:"structure"` + + // Join resource type event configuration object for enabling or disabling LoRaWAN + // related event topics. + LoRaWAN *LoRaWANJoinResourceTypeEventConfiguration `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s JoinResourceTypeEventConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s JoinResourceTypeEventConfiguration) GoString() string { + return s.String() +} + +// SetLoRaWAN sets the LoRaWAN field's value. +func (s *JoinResourceTypeEventConfiguration) SetLoRaWAN(v *LoRaWANJoinResourceTypeEventConfiguration) *JoinResourceTypeEventConfiguration { + s.LoRaWAN = v + return s +} + type ListDestinationsInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -14885,6 +16182,112 @@ func (s *ListDeviceProfilesOutput) SetNextToken(v string) *ListDeviceProfilesOut return s } +type ListEventConfigurationsInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The maximum number of results to return in this operation. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // To retrieve the next set of results, the nextToken value from a previous + // response; otherwise null to receive the first set of results. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` + + // Resource type to filter event configurations. + // + // ResourceType is a required field + ResourceType *string `location:"querystring" locationName:"resourceType" type:"string" required:"true" enum:"EventNotificationResourceType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEventConfigurationsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEventConfigurationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListEventConfigurationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListEventConfigurationsInput"} + if s.ResourceType == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceType")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListEventConfigurationsInput) SetMaxResults(v int64) *ListEventConfigurationsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListEventConfigurationsInput) SetNextToken(v string) *ListEventConfigurationsInput { + s.NextToken = &v + return s +} + +// SetResourceType sets the ResourceType field's value. +func (s *ListEventConfigurationsInput) SetResourceType(v string) *ListEventConfigurationsInput { + s.ResourceType = &v + return s +} + +type ListEventConfigurationsOutput struct { + _ struct{} `type:"structure"` + + // Event configurations of all events for a single resource. + EventConfigurationsList []*EventConfigurationItem `type:"list"` + + // To retrieve the next set of results, the nextToken value from a previous + // response; otherwise null to receive the first set of results. + NextToken *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEventConfigurationsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListEventConfigurationsOutput) GoString() string { + return s.String() +} + +// SetEventConfigurationsList sets the EventConfigurationsList field's value. +func (s *ListEventConfigurationsOutput) SetEventConfigurationsList(v []*EventConfigurationItem) *ListEventConfigurationsOutput { + s.EventConfigurationsList = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListEventConfigurationsOutput) SetNextToken(v string) *ListEventConfigurationsOutput { + s.NextToken = &v + return s +} + type ListFuotaTasksInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -15158,6 +16561,88 @@ func (s *ListMulticastGroupsOutput) SetNextToken(v string) *ListMulticastGroupsO return s } +type ListNetworkAnalyzerConfigurationsInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The maximum number of results to return in this operation. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // To retrieve the next set of results, the nextToken value from a previous + // response; otherwise null to receive the first set of results. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListNetworkAnalyzerConfigurationsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListNetworkAnalyzerConfigurationsInput) GoString() string { + return s.String() +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListNetworkAnalyzerConfigurationsInput) SetMaxResults(v int64) *ListNetworkAnalyzerConfigurationsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListNetworkAnalyzerConfigurationsInput) SetNextToken(v string) *ListNetworkAnalyzerConfigurationsInput { + s.NextToken = &v + return s +} + +type ListNetworkAnalyzerConfigurationsOutput struct { + _ struct{} `type:"structure"` + + // The list of network analyzer configurations. + NetworkAnalyzerConfigurationList []*NetworkAnalyzerConfigurations `type:"list"` + + // The token to use to get the next set of results, or null if there are no + // additional results. + NextToken *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListNetworkAnalyzerConfigurationsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListNetworkAnalyzerConfigurationsOutput) GoString() string { + return s.String() +} + +// SetNetworkAnalyzerConfigurationList sets the NetworkAnalyzerConfigurationList field's value. +func (s *ListNetworkAnalyzerConfigurationsOutput) SetNetworkAnalyzerConfigurationList(v []*NetworkAnalyzerConfigurations) *ListNetworkAnalyzerConfigurationsOutput { + s.NetworkAnalyzerConfigurationList = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListNetworkAnalyzerConfigurationsOutput) SetNextToken(v string) *ListNetworkAnalyzerConfigurationsOutput { + s.NextToken = &v + return s +} + type ListPartnerAccountsInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -15243,7 +16728,8 @@ func (s *ListPartnerAccountsOutput) SetSidewalk(v []*SidewalkAccountInfoWithFing type ListQueuedMessagesInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Id of a given wireless device which the downlink packets are targeted + // The ID of a given wireless device which the downlink message packets are + // being sent. // // Id is a required field Id *string `location:"uri" locationName:"Id" type:"string" required:"true"` @@ -15255,7 +16741,7 @@ type ListQueuedMessagesInput struct { // response; otherwise null to receive the first set of results. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` - // The wireless device type, it is either Sidewalk or LoRaWAN. + // The wireless device type, whic can be either Sidewalk or LoRaWAN. WirelessDeviceType *string `location:"querystring" locationName:"WirelessDeviceType" type:"string" enum:"WirelessDeviceType"` } @@ -15320,7 +16806,7 @@ func (s *ListQueuedMessagesInput) SetWirelessDeviceType(v string) *ListQueuedMes type ListQueuedMessagesOutput struct { _ struct{} `type:"structure"` - // The messages in downlink queue. + // The messages in the downlink queue. DownlinkQueueMessagesList []*DownlinkQueueMessage `type:"list"` // To retrieve the next set of results, the nextToken value from a previous @@ -15832,6 +17318,72 @@ func (s *ListWirelessGatewaysOutput) SetWirelessGatewayList(v []*WirelessGateway return s } +// Object for LoRaWAN connection status resource type event configuration. +type LoRaWANConnectionStatusEventNotificationConfigurations struct { + _ struct{} `type:"structure"` + + // Enum to denote whether the gateway eui connection status event topic is enabled + // or disabled. + GatewayEuiEventTopic *string `type:"string" enum:"EventNotificationTopicStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LoRaWANConnectionStatusEventNotificationConfigurations) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LoRaWANConnectionStatusEventNotificationConfigurations) GoString() string { + return s.String() +} + +// SetGatewayEuiEventTopic sets the GatewayEuiEventTopic field's value. +func (s *LoRaWANConnectionStatusEventNotificationConfigurations) SetGatewayEuiEventTopic(v string) *LoRaWANConnectionStatusEventNotificationConfigurations { + s.GatewayEuiEventTopic = &v + return s +} + +// Object for LoRaWAN connection status resource type event configuration. +type LoRaWANConnectionStatusResourceTypeEventConfiguration struct { + _ struct{} `type:"structure"` + + // Enum to denote whether the wireless gateway connection status event topic + // is enabled or disabled. + WirelessGatewayEventTopic *string `type:"string" enum:"EventNotificationTopicStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LoRaWANConnectionStatusResourceTypeEventConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LoRaWANConnectionStatusResourceTypeEventConfiguration) GoString() string { + return s.String() +} + +// SetWirelessGatewayEventTopic sets the WirelessGatewayEventTopic field's value. +func (s *LoRaWANConnectionStatusResourceTypeEventConfiguration) SetWirelessGatewayEventTopic(v string) *LoRaWANConnectionStatusResourceTypeEventConfiguration { + s.WirelessGatewayEventTopic = &v + return s +} + // LoRaWAN object for create functions. type LoRaWANDevice struct { _ struct{} `type:"structure"` @@ -16708,15 +18260,80 @@ func (s *LoRaWANGetServiceProfileInfo) SetUlBucketSize(v int64) *LoRaWANGetServi return s } -// SetUlRate sets the UlRate field's value. -func (s *LoRaWANGetServiceProfileInfo) SetUlRate(v int64) *LoRaWANGetServiceProfileInfo { - s.UlRate = &v - return s +// SetUlRate sets the UlRate field's value. +func (s *LoRaWANGetServiceProfileInfo) SetUlRate(v int64) *LoRaWANGetServiceProfileInfo { + s.UlRate = &v + return s +} + +// SetUlRatePolicy sets the UlRatePolicy field's value. +func (s *LoRaWANGetServiceProfileInfo) SetUlRatePolicy(v string) *LoRaWANGetServiceProfileInfo { + s.UlRatePolicy = &v + return s +} + +// Object for LoRaWAN join resource type event configuration. +type LoRaWANJoinEventNotificationConfigurations struct { + _ struct{} `type:"structure"` + + // Enum to denote whether the dev eui join event topic is enabled or disabled. + DevEuiEventTopic *string `type:"string" enum:"EventNotificationTopicStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LoRaWANJoinEventNotificationConfigurations) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LoRaWANJoinEventNotificationConfigurations) GoString() string { + return s.String() +} + +// SetDevEuiEventTopic sets the DevEuiEventTopic field's value. +func (s *LoRaWANJoinEventNotificationConfigurations) SetDevEuiEventTopic(v string) *LoRaWANJoinEventNotificationConfigurations { + s.DevEuiEventTopic = &v + return s +} + +// Object for LoRaWAN join resource type event configuration. +type LoRaWANJoinResourceTypeEventConfiguration struct { + _ struct{} `type:"structure"` + + // Enum to denote whether the wireless device join event topic is enabled or + // disabled. + WirelessDeviceEventTopic *string `type:"string" enum:"EventNotificationTopicStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LoRaWANJoinResourceTypeEventConfiguration) String() string { + return awsutil.Prettify(s) } -// SetUlRatePolicy sets the UlRatePolicy field's value. -func (s *LoRaWANGetServiceProfileInfo) SetUlRatePolicy(v string) *LoRaWANGetServiceProfileInfo { - s.UlRatePolicy = &v +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LoRaWANJoinResourceTypeEventConfiguration) GoString() string { + return s.String() +} + +// SetWirelessDeviceEventTopic sets the WirelessDeviceEventTopic field's value. +func (s *LoRaWANJoinResourceTypeEventConfiguration) SetWirelessDeviceEventTopic(v string) *LoRaWANJoinResourceTypeEventConfiguration { + s.WirelessDeviceEventTopic = &v return s } @@ -17087,6 +18704,12 @@ func (s *LoRaWANStartFuotaTask) SetStartTime(v time.Time) *LoRaWANStartFuotaTask type LoRaWANUpdateDevice struct { _ struct{} `type:"structure"` + // ABP device object for update APIs for v1.0.x + AbpV1_0_x *UpdateAbpV10X `type:"structure"` + + // ABP device object for update APIs for v1.1 + AbpV1_1 *UpdateAbpV11 `type:"structure"` + // The ID of the device profile for the wireless device. DeviceProfileId *string `type:"string"` @@ -17112,6 +18735,18 @@ func (s LoRaWANUpdateDevice) GoString() string { return s.String() } +// SetAbpV1_0_x sets the AbpV1_0_x field's value. +func (s *LoRaWANUpdateDevice) SetAbpV1_0_x(v *UpdateAbpV10X) *LoRaWANUpdateDevice { + s.AbpV1_0_x = v + return s +} + +// SetAbpV1_1 sets the AbpV1_1 field's value. +func (s *LoRaWANUpdateDevice) SetAbpV1_1(v *UpdateAbpV11) *LoRaWANUpdateDevice { + s.AbpV1_1 = v + return s +} + // SetDeviceProfileId sets the DeviceProfileId field's value. func (s *LoRaWANUpdateDevice) SetDeviceProfileId(v string) *LoRaWANUpdateDevice { s.DeviceProfileId = &v @@ -17379,6 +19014,47 @@ func (s *MulticastWirelessMetadata) SetLoRaWAN(v *LoRaWANMulticastMetadata) *Mul return s } +// Network analyzer configurations. +type NetworkAnalyzerConfigurations struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name of the new resource. + Arn *string `type:"string"` + + // Name of the network analyzer configuration. + Name *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NetworkAnalyzerConfigurations) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NetworkAnalyzerConfigurations) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *NetworkAnalyzerConfigurations) SetArn(v string) *NetworkAnalyzerConfigurations { + s.Arn = &v + return s +} + +// SetName sets the Name field's value. +func (s *NetworkAnalyzerConfigurations) SetName(v string) *NetworkAnalyzerConfigurations { + s.Name = &v + return s +} + // OTAA device object for v1.0.x type OtaaV10X struct { _ struct{} `type:"structure"` @@ -17487,6 +19163,10 @@ type ProximityEventConfiguration struct { // Proximity event configuration object for enabling or disabling Sidewalk related // event topics. Sidewalk *SidewalkEventNotificationConfigurations `type:"structure"` + + // Enum to denote whether the wireless device id proximity event topic is enabled + // or disabled. + WirelessDeviceIdEventTopic *string `type:"string" enum:"EventNotificationTopicStatus"` } // String returns the string representation. @@ -17513,10 +19193,52 @@ func (s *ProximityEventConfiguration) SetSidewalk(v *SidewalkEventNotificationCo return s } +// SetWirelessDeviceIdEventTopic sets the WirelessDeviceIdEventTopic field's value. +func (s *ProximityEventConfiguration) SetWirelessDeviceIdEventTopic(v string) *ProximityEventConfiguration { + s.WirelessDeviceIdEventTopic = &v + return s +} + +// Proximity resource type event configuration object for enabling or disabling +// topic. +type ProximityResourceTypeEventConfiguration struct { + _ struct{} `type:"structure"` + + // Proximity resource type event configuration object for enabling and disabling + // wireless device topic. + Sidewalk *SidewalkResourceTypeEventConfiguration `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ProximityResourceTypeEventConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ProximityResourceTypeEventConfiguration) GoString() string { + return s.String() +} + +// SetSidewalk sets the Sidewalk field's value. +func (s *ProximityResourceTypeEventConfiguration) SetSidewalk(v *SidewalkResourceTypeEventConfiguration) *ProximityResourceTypeEventConfiguration { + s.Sidewalk = v + return s +} + type PutResourceLogLevelInput struct { _ struct{} `type:"structure"` - // The log level for a log message. + // The log level for a log message. The log levels can be disabled, or set to + // ERROR to display less verbose logs containing only error information, or + // to INFO for more detailed logs. // // LogLevel is a required field LogLevel *string `type:"string" required:"true" enum:"LogLevel"` @@ -18521,6 +20243,40 @@ func (s *SidewalkListDevice) SetSidewalkManufacturingSn(v string) *SidewalkListD return s } +// Sidewalk resource type event configuration object for enabling or disabling +// topic. +type SidewalkResourceTypeEventConfiguration struct { + _ struct{} `type:"structure"` + + // Enum to denote whether the wireless device join event topic is enabled or + // disabled. + WirelessDeviceEventTopic *string `type:"string" enum:"EventNotificationTopicStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SidewalkResourceTypeEventConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SidewalkResourceTypeEventConfiguration) GoString() string { + return s.String() +} + +// SetWirelessDeviceEventTopic sets the WirelessDeviceEventTopic field's value. +func (s *SidewalkResourceTypeEventConfiguration) SetWirelessDeviceEventTopic(v string) *SidewalkResourceTypeEventConfiguration { + s.WirelessDeviceEventTopic = &v + return s +} + // Information about a Sidewalk router. type SidewalkSendDataToDevice struct { _ struct{} `type:"structure"` @@ -19354,14 +21110,18 @@ func (s *TooManyTagsException) RequestID() string { return s.RespMetadata.RequestID } -// Trace Content for resources. +// Trace content for your wireless gateway and wireless device resources. type TraceContent struct { _ struct{} `type:"structure"` - // The log level for a log message. + // The log level for a log message. The log levels can be disabled, or set to + // ERROR to display less verbose logs containing only error information, or + // to INFO for more detailed logs. LogLevel *string `type:"string" enum:"LogLevel"` - // WirelessDevice FrameInfo for trace content. + // FrameInfo of your wireless device resources for the trace content. Use FrameInfo + // to debug the communication between your LoRaWAN end devices and the network + // server. WirelessDeviceFrameInfo *string `type:"string" enum:"WirelessDeviceFrameInfo"` } @@ -19480,6 +21240,70 @@ func (s UntagResourceOutput) GoString() string { return s.String() } +// ABP device object for LoRaWAN specification v1.0.x +type UpdateAbpV10X struct { + _ struct{} `type:"structure"` + + // The FCnt init value. + FCntStart *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateAbpV10X) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateAbpV10X) GoString() string { + return s.String() +} + +// SetFCntStart sets the FCntStart field's value. +func (s *UpdateAbpV10X) SetFCntStart(v int64) *UpdateAbpV10X { + s.FCntStart = &v + return s +} + +// ABP device object for LoRaWAN specification v1.1 +type UpdateAbpV11 struct { + _ struct{} `type:"structure"` + + // The FCnt init value. + FCntStart *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateAbpV11) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateAbpV11) GoString() string { + return s.String() +} + +// SetFCntStart sets the FCntStart field's value. +func (s *UpdateAbpV11) SetFCntStart(v int64) *UpdateAbpV11 { + s.FCntStart = &v + return s +} + type UpdateDestinationInput struct { _ struct{} `type:"structure"` @@ -19590,6 +21414,90 @@ func (s UpdateDestinationOutput) GoString() string { return s.String() } +type UpdateEventConfigurationByResourceTypesInput struct { + _ struct{} `type:"structure"` + + // Connection status resource type event configuration object for enabling and + // disabling wireless gateway topic. + ConnectionStatus *ConnectionStatusResourceTypeEventConfiguration `type:"structure"` + + // Device registration state resource type event configuration object for enabling + // and disabling wireless gateway topic. + DeviceRegistrationState *DeviceRegistrationStateResourceTypeEventConfiguration `type:"structure"` + + // Join resource type event configuration object for enabling and disabling + // wireless device topic. + Join *JoinResourceTypeEventConfiguration `type:"structure"` + + // Proximity resource type event configuration object for enabling and disabling + // wireless gateway topic. + Proximity *ProximityResourceTypeEventConfiguration `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateEventConfigurationByResourceTypesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateEventConfigurationByResourceTypesInput) GoString() string { + return s.String() +} + +// SetConnectionStatus sets the ConnectionStatus field's value. +func (s *UpdateEventConfigurationByResourceTypesInput) SetConnectionStatus(v *ConnectionStatusResourceTypeEventConfiguration) *UpdateEventConfigurationByResourceTypesInput { + s.ConnectionStatus = v + return s +} + +// SetDeviceRegistrationState sets the DeviceRegistrationState field's value. +func (s *UpdateEventConfigurationByResourceTypesInput) SetDeviceRegistrationState(v *DeviceRegistrationStateResourceTypeEventConfiguration) *UpdateEventConfigurationByResourceTypesInput { + s.DeviceRegistrationState = v + return s +} + +// SetJoin sets the Join field's value. +func (s *UpdateEventConfigurationByResourceTypesInput) SetJoin(v *JoinResourceTypeEventConfiguration) *UpdateEventConfigurationByResourceTypesInput { + s.Join = v + return s +} + +// SetProximity sets the Proximity field's value. +func (s *UpdateEventConfigurationByResourceTypesInput) SetProximity(v *ProximityResourceTypeEventConfiguration) *UpdateEventConfigurationByResourceTypesInput { + s.Proximity = v + return s +} + +type UpdateEventConfigurationByResourceTypesOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateEventConfigurationByResourceTypesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateEventConfigurationByResourceTypesOutput) GoString() string { + return s.String() +} + type UpdateFuotaTaskInput struct { _ struct{} `type:"structure"` @@ -19716,7 +21624,9 @@ func (s UpdateFuotaTaskOutput) GoString() string { type UpdateLogLevelsByResourceTypesInput struct { _ struct{} `type:"structure"` - // The log level for a log message. + // The log level for a log message. The log levels can be disabled, or set to + // ERROR to display less verbose logs containing only error information, or + // to INFO for more detailed logs. DefaultLogLevel *string `type:"string" enum:"LogLevel"` // The list of wireless device log options. @@ -19915,24 +21825,31 @@ func (s UpdateMulticastGroupOutput) GoString() string { type UpdateNetworkAnalyzerConfigurationInput struct { _ struct{} `type:"structure"` - // NetworkAnalyzer configuration name. + // Name of the network analyzer configuration. // // ConfigurationName is a required field ConfigurationName *string `location:"uri" locationName:"ConfigurationName" min:"1" type:"string" required:"true"` - // Trace Content for resources. + // The description of the new resource. + Description *string `type:"string"` + + // Trace content for your wireless gateway and wireless device resources. TraceContent *TraceContent `type:"structure"` - // WirelessDevices to add into NetworkAnalyzerConfiguration. + // Wireless device resources to add to the network analyzer configuration. Provide + // the WirelessDeviceId of the resource to add in the input array. WirelessDevicesToAdd []*string `type:"list"` - // WirelessDevices to remove from NetworkAnalyzerConfiguration. + // Wireless device resources to remove from the network analyzer configuration. + // Provide the WirelessDeviceId of the resources to remove in the input array. WirelessDevicesToRemove []*string `type:"list"` - // WirelessGateways to add into NetworkAnalyzerConfiguration. + // Wireless gateway resources to add to the network analyzer configuration. + // Provide the WirelessGatewayId of the resource to add in the input array. WirelessGatewaysToAdd []*string `type:"list"` - // WirelessGateways to remove from NetworkAnalyzerConfiguration. + // Wireless gateway resources to remove from the network analyzer configuration. + // Provide the WirelessGatewayId of the resources to remove in the input array. WirelessGatewaysToRemove []*string `type:"list"` } @@ -19976,6 +21893,12 @@ func (s *UpdateNetworkAnalyzerConfigurationInput) SetConfigurationName(v string) return s } +// SetDescription sets the Description field's value. +func (s *UpdateNetworkAnalyzerConfigurationInput) SetDescription(v string) *UpdateNetworkAnalyzerConfigurationInput { + s.Description = &v + return s +} + // SetTraceContent sets the TraceContent field's value. func (s *UpdateNetworkAnalyzerConfigurationInput) SetTraceContent(v *TraceContent) *UpdateNetworkAnalyzerConfigurationInput { s.TraceContent = v @@ -20135,6 +22058,9 @@ func (s UpdatePartnerAccountOutput) GoString() string { type UpdateResourceEventConfigurationInput struct { _ struct{} `type:"structure"` + // Event configuration for the connection status event + ConnectionStatus *ConnectionStatusEventConfiguration `type:"structure"` + // Event configuration for the device registration state event DeviceRegistrationState *DeviceRegistrationStateEventConfiguration `type:"structure"` @@ -20148,6 +22074,9 @@ type UpdateResourceEventConfigurationInput struct { // IdentifierType is a required field IdentifierType *string `location:"querystring" locationName:"identifierType" type:"string" required:"true" enum:"IdentifierType"` + // Event configuration for the join event + Join *JoinEventConfiguration `type:"structure"` + // Partner type of the resource if the identifier type is PartnerAccountId PartnerType *string `location:"querystring" locationName:"partnerType" type:"string" enum:"EventNotificationPartnerType"` @@ -20192,6 +22121,12 @@ func (s *UpdateResourceEventConfigurationInput) Validate() error { return nil } +// SetConnectionStatus sets the ConnectionStatus field's value. +func (s *UpdateResourceEventConfigurationInput) SetConnectionStatus(v *ConnectionStatusEventConfiguration) *UpdateResourceEventConfigurationInput { + s.ConnectionStatus = v + return s +} + // SetDeviceRegistrationState sets the DeviceRegistrationState field's value. func (s *UpdateResourceEventConfigurationInput) SetDeviceRegistrationState(v *DeviceRegistrationStateEventConfiguration) *UpdateResourceEventConfigurationInput { s.DeviceRegistrationState = v @@ -20210,6 +22145,12 @@ func (s *UpdateResourceEventConfigurationInput) SetIdentifierType(v string) *Upd return s } +// SetJoin sets the Join field's value. +func (s *UpdateResourceEventConfigurationInput) SetJoin(v *JoinEventConfiguration) *UpdateResourceEventConfigurationInput { + s.Join = v + return s +} + // SetPartnerType sets the PartnerType field's value. func (s *UpdateResourceEventConfigurationInput) SetPartnerType(v string) *UpdateResourceEventConfigurationInput { s.PartnerType = &v @@ -20658,7 +22599,9 @@ type WirelessDeviceEventLogOption struct { // Event is a required field Event *string `type:"string" required:"true" enum:"WirelessDeviceEvent"` - // The log level for a log message. + // The log level for a log message. The log levels can be disabled, or set to + // ERROR to display less verbose logs containing only error information, or + // to INFO for more detailed logs. // // LogLevel is a required field LogLevel *string `type:"string" required:"true" enum:"LogLevel"` @@ -20718,7 +22661,9 @@ type WirelessDeviceLogOption struct { // The list of wireless device event log options. Events []*WirelessDeviceEventLogOption `type:"list"` - // The log level for a log message. + // The log level for a log message. The log levels can be disabled, or set to + // ERROR to display less verbose logs containing only error information, or + // to INFO for more detailed logs. // // LogLevel is a required field LogLevel *string `type:"string" required:"true" enum:"LogLevel"` @@ -20926,7 +22871,9 @@ type WirelessGatewayEventLogOption struct { // Event is a required field Event *string `type:"string" required:"true" enum:"WirelessGatewayEvent"` - // The log level for a log message. + // The log level for a log message. The log levels can be disabled, or set to + // ERROR to display less verbose logs containing only error information, or + // to INFO for more detailed logs. // // LogLevel is a required field LogLevel *string `type:"string" required:"true" enum:"LogLevel"` @@ -20986,7 +22933,9 @@ type WirelessGatewayLogOption struct { // The list of wireless gateway event log options. Events []*WirelessGatewayEventLogOption `type:"list"` - // The log level for a log message. + // The log level for a log message. The log levels can be disabled, or set to + // ERROR to display less verbose logs containing only error information, or + // to INFO for more detailed logs. // // LogLevel is a required field LogLevel *string `type:"string" required:"true" enum:"LogLevel"` @@ -21312,6 +23261,26 @@ func EventNotificationPartnerType_Values() []string { } } +const ( + // EventNotificationResourceTypeSidewalkAccount is a EventNotificationResourceType enum value + EventNotificationResourceTypeSidewalkAccount = "SidewalkAccount" + + // EventNotificationResourceTypeWirelessDevice is a EventNotificationResourceType enum value + EventNotificationResourceTypeWirelessDevice = "WirelessDevice" + + // EventNotificationResourceTypeWirelessGateway is a EventNotificationResourceType enum value + EventNotificationResourceTypeWirelessGateway = "WirelessGateway" +) + +// EventNotificationResourceType_Values returns all elements of the EventNotificationResourceType enum +func EventNotificationResourceType_Values() []string { + return []string{ + EventNotificationResourceTypeSidewalkAccount, + EventNotificationResourceTypeWirelessDevice, + EventNotificationResourceTypeWirelessGateway, + } +} + const ( // EventNotificationTopicStatusEnabled is a EventNotificationTopicStatus enum value EventNotificationTopicStatusEnabled = "Enabled" @@ -21429,16 +23398,34 @@ func FuotaTaskStatus_Values() []string { const ( // IdentifierTypePartnerAccountId is a IdentifierType enum value IdentifierTypePartnerAccountId = "PartnerAccountId" + + // IdentifierTypeDevEui is a IdentifierType enum value + IdentifierTypeDevEui = "DevEui" + + // IdentifierTypeGatewayEui is a IdentifierType enum value + IdentifierTypeGatewayEui = "GatewayEui" + + // IdentifierTypeWirelessDeviceId is a IdentifierType enum value + IdentifierTypeWirelessDeviceId = "WirelessDeviceId" + + // IdentifierTypeWirelessGatewayId is a IdentifierType enum value + IdentifierTypeWirelessGatewayId = "WirelessGatewayId" ) // IdentifierType_Values returns all elements of the IdentifierType enum func IdentifierType_Values() []string { return []string{ IdentifierTypePartnerAccountId, + IdentifierTypeDevEui, + IdentifierTypeGatewayEui, + IdentifierTypeWirelessDeviceId, + IdentifierTypeWirelessGatewayId, } } -// The log level for a log message. +// The log level for a log message. The log levels can be disabled, or set to +// ERROR to display less verbose logs containing only error information, or +// to INFO for more detailed logs. const ( // LogLevelInfo is a LogLevel enum value LogLevelInfo = "INFO" @@ -21567,7 +23554,9 @@ func WirelessDeviceEvent_Values() []string { } } -// WirelessDevice FrameInfo for trace content. +// FrameInfo of your wireless device resources for the trace content. Use FrameInfo +// to debug the communication between your LoRaWAN end devices and the network +// server. const ( // WirelessDeviceFrameInfoEnabled is a WirelessDeviceFrameInfo enum value WirelessDeviceFrameInfoEnabled = "ENABLED" diff --git a/service/iotwireless/iotwirelessiface/interface.go b/service/iotwireless/iotwirelessiface/interface.go index d11c34d4734..20d8e1e9197 100644 --- a/service/iotwireless/iotwirelessiface/interface.go +++ b/service/iotwireless/iotwirelessiface/interface.go @@ -108,6 +108,10 @@ type IoTWirelessAPI interface { CreateMulticastGroupWithContext(aws.Context, *iotwireless.CreateMulticastGroupInput, ...request.Option) (*iotwireless.CreateMulticastGroupOutput, error) CreateMulticastGroupRequest(*iotwireless.CreateMulticastGroupInput) (*request.Request, *iotwireless.CreateMulticastGroupOutput) + CreateNetworkAnalyzerConfiguration(*iotwireless.CreateNetworkAnalyzerConfigurationInput) (*iotwireless.CreateNetworkAnalyzerConfigurationOutput, error) + CreateNetworkAnalyzerConfigurationWithContext(aws.Context, *iotwireless.CreateNetworkAnalyzerConfigurationInput, ...request.Option) (*iotwireless.CreateNetworkAnalyzerConfigurationOutput, error) + CreateNetworkAnalyzerConfigurationRequest(*iotwireless.CreateNetworkAnalyzerConfigurationInput) (*request.Request, *iotwireless.CreateNetworkAnalyzerConfigurationOutput) + CreateServiceProfile(*iotwireless.CreateServiceProfileInput) (*iotwireless.CreateServiceProfileOutput, error) CreateServiceProfileWithContext(aws.Context, *iotwireless.CreateServiceProfileInput, ...request.Option) (*iotwireless.CreateServiceProfileOutput, error) CreateServiceProfileRequest(*iotwireless.CreateServiceProfileInput) (*request.Request, *iotwireless.CreateServiceProfileOutput) @@ -144,6 +148,10 @@ type IoTWirelessAPI interface { DeleteMulticastGroupWithContext(aws.Context, *iotwireless.DeleteMulticastGroupInput, ...request.Option) (*iotwireless.DeleteMulticastGroupOutput, error) DeleteMulticastGroupRequest(*iotwireless.DeleteMulticastGroupInput) (*request.Request, *iotwireless.DeleteMulticastGroupOutput) + DeleteNetworkAnalyzerConfiguration(*iotwireless.DeleteNetworkAnalyzerConfigurationInput) (*iotwireless.DeleteNetworkAnalyzerConfigurationOutput, error) + DeleteNetworkAnalyzerConfigurationWithContext(aws.Context, *iotwireless.DeleteNetworkAnalyzerConfigurationInput, ...request.Option) (*iotwireless.DeleteNetworkAnalyzerConfigurationOutput, error) + DeleteNetworkAnalyzerConfigurationRequest(*iotwireless.DeleteNetworkAnalyzerConfigurationInput) (*request.Request, *iotwireless.DeleteNetworkAnalyzerConfigurationOutput) + DeleteQueuedMessages(*iotwireless.DeleteQueuedMessagesInput) (*iotwireless.DeleteQueuedMessagesOutput, error) DeleteQueuedMessagesWithContext(aws.Context, *iotwireless.DeleteQueuedMessagesInput, ...request.Option) (*iotwireless.DeleteQueuedMessagesOutput, error) DeleteQueuedMessagesRequest(*iotwireless.DeleteQueuedMessagesInput) (*request.Request, *iotwireless.DeleteQueuedMessagesOutput) @@ -204,6 +212,10 @@ type IoTWirelessAPI interface { GetDeviceProfileWithContext(aws.Context, *iotwireless.GetDeviceProfileInput, ...request.Option) (*iotwireless.GetDeviceProfileOutput, error) GetDeviceProfileRequest(*iotwireless.GetDeviceProfileInput) (*request.Request, *iotwireless.GetDeviceProfileOutput) + GetEventConfigurationByResourceTypes(*iotwireless.GetEventConfigurationByResourceTypesInput) (*iotwireless.GetEventConfigurationByResourceTypesOutput, error) + GetEventConfigurationByResourceTypesWithContext(aws.Context, *iotwireless.GetEventConfigurationByResourceTypesInput, ...request.Option) (*iotwireless.GetEventConfigurationByResourceTypesOutput, error) + GetEventConfigurationByResourceTypesRequest(*iotwireless.GetEventConfigurationByResourceTypesInput) (*request.Request, *iotwireless.GetEventConfigurationByResourceTypesOutput) + GetFuotaTask(*iotwireless.GetFuotaTaskInput) (*iotwireless.GetFuotaTaskOutput, error) GetFuotaTaskWithContext(aws.Context, *iotwireless.GetFuotaTaskInput, ...request.Option) (*iotwireless.GetFuotaTaskOutput, error) GetFuotaTaskRequest(*iotwireless.GetFuotaTaskInput) (*request.Request, *iotwireless.GetFuotaTaskOutput) @@ -290,6 +302,10 @@ type IoTWirelessAPI interface { ListDeviceProfilesPages(*iotwireless.ListDeviceProfilesInput, func(*iotwireless.ListDeviceProfilesOutput, bool) bool) error ListDeviceProfilesPagesWithContext(aws.Context, *iotwireless.ListDeviceProfilesInput, func(*iotwireless.ListDeviceProfilesOutput, bool) bool, ...request.Option) error + ListEventConfigurations(*iotwireless.ListEventConfigurationsInput) (*iotwireless.ListEventConfigurationsOutput, error) + ListEventConfigurationsWithContext(aws.Context, *iotwireless.ListEventConfigurationsInput, ...request.Option) (*iotwireless.ListEventConfigurationsOutput, error) + ListEventConfigurationsRequest(*iotwireless.ListEventConfigurationsInput) (*request.Request, *iotwireless.ListEventConfigurationsOutput) + ListFuotaTasks(*iotwireless.ListFuotaTasksInput) (*iotwireless.ListFuotaTasksOutput, error) ListFuotaTasksWithContext(aws.Context, *iotwireless.ListFuotaTasksInput, ...request.Option) (*iotwireless.ListFuotaTasksOutput, error) ListFuotaTasksRequest(*iotwireless.ListFuotaTasksInput) (*request.Request, *iotwireless.ListFuotaTasksOutput) @@ -311,6 +327,13 @@ type IoTWirelessAPI interface { ListMulticastGroupsByFuotaTaskPages(*iotwireless.ListMulticastGroupsByFuotaTaskInput, func(*iotwireless.ListMulticastGroupsByFuotaTaskOutput, bool) bool) error ListMulticastGroupsByFuotaTaskPagesWithContext(aws.Context, *iotwireless.ListMulticastGroupsByFuotaTaskInput, func(*iotwireless.ListMulticastGroupsByFuotaTaskOutput, bool) bool, ...request.Option) error + ListNetworkAnalyzerConfigurations(*iotwireless.ListNetworkAnalyzerConfigurationsInput) (*iotwireless.ListNetworkAnalyzerConfigurationsOutput, error) + ListNetworkAnalyzerConfigurationsWithContext(aws.Context, *iotwireless.ListNetworkAnalyzerConfigurationsInput, ...request.Option) (*iotwireless.ListNetworkAnalyzerConfigurationsOutput, error) + ListNetworkAnalyzerConfigurationsRequest(*iotwireless.ListNetworkAnalyzerConfigurationsInput) (*request.Request, *iotwireless.ListNetworkAnalyzerConfigurationsOutput) + + ListNetworkAnalyzerConfigurationsPages(*iotwireless.ListNetworkAnalyzerConfigurationsInput, func(*iotwireless.ListNetworkAnalyzerConfigurationsOutput, bool) bool) error + ListNetworkAnalyzerConfigurationsPagesWithContext(aws.Context, *iotwireless.ListNetworkAnalyzerConfigurationsInput, func(*iotwireless.ListNetworkAnalyzerConfigurationsOutput, bool) bool, ...request.Option) error + ListPartnerAccounts(*iotwireless.ListPartnerAccountsInput) (*iotwireless.ListPartnerAccountsOutput, error) ListPartnerAccountsWithContext(aws.Context, *iotwireless.ListPartnerAccountsInput, ...request.Option) (*iotwireless.ListPartnerAccountsOutput, error) ListPartnerAccountsRequest(*iotwireless.ListPartnerAccountsInput) (*request.Request, *iotwireless.ListPartnerAccountsOutput) @@ -403,6 +426,10 @@ type IoTWirelessAPI interface { UpdateDestinationWithContext(aws.Context, *iotwireless.UpdateDestinationInput, ...request.Option) (*iotwireless.UpdateDestinationOutput, error) UpdateDestinationRequest(*iotwireless.UpdateDestinationInput) (*request.Request, *iotwireless.UpdateDestinationOutput) + UpdateEventConfigurationByResourceTypes(*iotwireless.UpdateEventConfigurationByResourceTypesInput) (*iotwireless.UpdateEventConfigurationByResourceTypesOutput, error) + UpdateEventConfigurationByResourceTypesWithContext(aws.Context, *iotwireless.UpdateEventConfigurationByResourceTypesInput, ...request.Option) (*iotwireless.UpdateEventConfigurationByResourceTypesOutput, error) + UpdateEventConfigurationByResourceTypesRequest(*iotwireless.UpdateEventConfigurationByResourceTypesInput) (*request.Request, *iotwireless.UpdateEventConfigurationByResourceTypesOutput) + UpdateFuotaTask(*iotwireless.UpdateFuotaTaskInput) (*iotwireless.UpdateFuotaTaskOutput, error) UpdateFuotaTaskWithContext(aws.Context, *iotwireless.UpdateFuotaTaskInput, ...request.Option) (*iotwireless.UpdateFuotaTaskOutput, error) UpdateFuotaTaskRequest(*iotwireless.UpdateFuotaTaskInput) (*request.Request, *iotwireless.UpdateFuotaTaskOutput) diff --git a/service/lookoutequipment/api.go b/service/lookoutequipment/api.go index 4707728658d..107e76905c2 100644 --- a/service/lookoutequipment/api.go +++ b/service/lookoutequipment/api.go @@ -679,7 +679,7 @@ func (c *LookoutEquipment) DescribeDataIngestionJobRequest(input *DescribeDataIn // DescribeDataIngestionJob API operation for Amazon Lookout for Equipment. // // Provides information on a specific data ingestion job such as creation time, -// dataset ARN, status, and so on. +// dataset ARN, and status. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -774,8 +774,8 @@ func (c *LookoutEquipment) DescribeDatasetRequest(input *DescribeDatasetInput) ( // DescribeDataset API operation for Amazon Lookout for Equipment. // -// Provides a JSON description of the data that is in each time series dataset, -// including names, column names, and data types. +// Provides a JSON description of the data in each time series dataset, including +// names, column names, and data types. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1773,6 +1773,161 @@ func (c *LookoutEquipment) ListModelsPagesWithContext(ctx aws.Context, input *Li return p.Err() } +const opListSensorStatistics = "ListSensorStatistics" + +// ListSensorStatisticsRequest generates a "aws/request.Request" representing the +// client's request for the ListSensorStatistics operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListSensorStatistics for more information on using the ListSensorStatistics +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListSensorStatisticsRequest method. +// req, resp := client.ListSensorStatisticsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListSensorStatistics +func (c *LookoutEquipment) ListSensorStatisticsRequest(input *ListSensorStatisticsInput) (req *request.Request, output *ListSensorStatisticsOutput) { + op := &request.Operation{ + Name: opListSensorStatistics, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListSensorStatisticsInput{} + } + + output = &ListSensorStatisticsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListSensorStatistics API operation for Amazon Lookout for Equipment. +// +// Lists statistics about the data collected for each of the sensors that have +// been successfully ingested in the particular dataset. Can also be used to +// retreive Sensor Statistics for a previous ingestion job. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lookout for Equipment's +// API operation ListSensorStatistics for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The input fails to satisfy constraints specified by Amazon Lookout for Equipment +// or a related AWS service that's being utilized. +// +// * ResourceNotFoundException +// The resource requested could not be found. Verify the resource ID and retry +// your request. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * AccessDeniedException +// The request could not be completed because you do not have access to the +// resource. +// +// * InternalServerException +// Processing of the request has failed because of an unknown error, exception +// or failure. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListSensorStatistics +func (c *LookoutEquipment) ListSensorStatistics(input *ListSensorStatisticsInput) (*ListSensorStatisticsOutput, error) { + req, out := c.ListSensorStatisticsRequest(input) + return out, req.Send() +} + +// ListSensorStatisticsWithContext is the same as ListSensorStatistics with the addition of +// the ability to pass a context and additional request options. +// +// See ListSensorStatistics for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LookoutEquipment) ListSensorStatisticsWithContext(ctx aws.Context, input *ListSensorStatisticsInput, opts ...request.Option) (*ListSensorStatisticsOutput, error) { + req, out := c.ListSensorStatisticsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListSensorStatisticsPages iterates over the pages of a ListSensorStatistics operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListSensorStatistics method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListSensorStatistics operation. +// pageNum := 0 +// err := client.ListSensorStatisticsPages(params, +// func(page *lookoutequipment.ListSensorStatisticsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *LookoutEquipment) ListSensorStatisticsPages(input *ListSensorStatisticsInput, fn func(*ListSensorStatisticsOutput, bool) bool) error { + return c.ListSensorStatisticsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListSensorStatisticsPagesWithContext same as ListSensorStatisticsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LookoutEquipment) ListSensorStatisticsPagesWithContext(ctx aws.Context, input *ListSensorStatisticsInput, fn func(*ListSensorStatisticsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListSensorStatisticsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListSensorStatisticsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListSensorStatisticsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListTagsForResource = "ListTagsForResource" // ListTagsForResourceRequest generates a "aws/request.Request" representing the @@ -2534,6 +2689,50 @@ func (s *AccessDeniedException) RequestID() string { return s.RespMetadata.RequestID } +// Entity that comprises information on categorical values in data. +type CategoricalValues struct { + _ struct{} `type:"structure"` + + // Indicates the number of categories in the data. + NumberOfCategory *int64 `type:"integer"` + + // Indicates whether there is a potential data issue related to categorical + // values. + // + // Status is a required field + Status *string `type:"string" required:"true" enum:"StatisticalIssueStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CategoricalValues) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CategoricalValues) GoString() string { + return s.String() +} + +// SetNumberOfCategory sets the NumberOfCategory field's value. +func (s *CategoricalValues) SetNumberOfCategory(v int64) *CategoricalValues { + s.NumberOfCategory = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *CategoricalValues) SetStatus(v string) *CategoricalValues { + s.Status = &v + return s +} + // The request could not be completed due to a conflict with the current state // of the target resource. type ConflictException struct { @@ -2599,6 +2798,51 @@ func (s *ConflictException) RequestID() string { return s.RespMetadata.RequestID } +// Entity that comprises information of count and percentage. +type CountPercent struct { + _ struct{} `type:"structure"` + + // Indicates the count of occurences of the given statistic. + // + // Count is a required field + Count *int64 `type:"integer" required:"true"` + + // Indicates the percentage of occurances of the given statistic. + // + // Percentage is a required field + Percentage *float64 `type:"float" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CountPercent) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CountPercent) GoString() string { + return s.String() +} + +// SetCount sets the Count field's value. +func (s *CountPercent) SetCount(v int64) *CountPercent { + s.Count = &v + return s +} + +// SetPercentage sets the Percentage field's value. +func (s *CountPercent) SetPercentage(v float64) *CountPercent { + s.Percentage = &v + return s +} + type CreateDatasetInput struct { _ struct{} `type:"structure"` @@ -2613,9 +2857,7 @@ type CreateDatasetInput struct { // A JSON description of the data that is in each time series dataset, including // names, column names, and data types. - // - // DatasetSchema is a required field - DatasetSchema *DatasetSchema `type:"structure" required:"true"` + DatasetSchema *DatasetSchema `type:"structure"` // Provides the identifier of the KMS key used to encrypt dataset data by Amazon // Lookout for Equipment. @@ -2655,9 +2897,6 @@ func (s *CreateDatasetInput) Validate() error { if s.DatasetName != nil && len(*s.DatasetName) < 1 { invalidParams.Add(request.NewErrParamMinLen("DatasetName", 1)) } - if s.DatasetSchema == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetSchema")) - } if s.ServerSideKmsKeyId != nil && len(*s.ServerSideKmsKeyId) < 1 { invalidParams.Add(request.NewErrParamMinLen("ServerSideKmsKeyId", 1)) } @@ -3284,7 +3523,7 @@ type DataIngestionJobSummary struct { DatasetName *string `min:"1" type:"string"` // Specifies information for the input data for the data inference job, including - // data S3 location parameters. + // data Amazon S3 location parameters. IngestionInputConfiguration *IngestionInputConfiguration `type:"structure"` // Indicates the job ID of the data ingestion job. @@ -3391,6 +3630,93 @@ func (s *DataPreProcessingConfiguration) SetTargetSamplingRate(v string) *DataPr return s } +// DataQualitySummary gives aggregated statistics over all the sensors about +// a completed ingestion job. It primarily gives more information about statistics +// over different incorrect data like MissingCompleteSensorData, MissingSensorData, +// UnsupportedDateFormats, InsufficientSensorData, DuplicateTimeStamps. +type DataQualitySummary struct { + _ struct{} `type:"structure"` + + // Parameter that gives information about duplicate timestamps in the input + // data. + // + // DuplicateTimestamps is a required field + DuplicateTimestamps *DuplicateTimestamps `type:"structure" required:"true"` + + // Parameter that gives information about insufficient data for sensors in the + // dataset. This includes information about those sensors that have complete + // data missing and those with a short date range. + // + // InsufficientSensorData is a required field + InsufficientSensorData *InsufficientSensorData `type:"structure" required:"true"` + + // Parameter that gives information about data that is invalid over all the + // sensors in the input data. + // + // InvalidSensorData is a required field + InvalidSensorData *InvalidSensorData `type:"structure" required:"true"` + + // Parameter that gives information about data that is missing over all the + // sensors in the input data. + // + // MissingSensorData is a required field + MissingSensorData *MissingSensorData `type:"structure" required:"true"` + + // Parameter that gives information about unsupported timestamps in the input + // data. + // + // UnsupportedTimestamps is a required field + UnsupportedTimestamps *UnsupportedTimestamps `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DataQualitySummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DataQualitySummary) GoString() string { + return s.String() +} + +// SetDuplicateTimestamps sets the DuplicateTimestamps field's value. +func (s *DataQualitySummary) SetDuplicateTimestamps(v *DuplicateTimestamps) *DataQualitySummary { + s.DuplicateTimestamps = v + return s +} + +// SetInsufficientSensorData sets the InsufficientSensorData field's value. +func (s *DataQualitySummary) SetInsufficientSensorData(v *InsufficientSensorData) *DataQualitySummary { + s.InsufficientSensorData = v + return s +} + +// SetInvalidSensorData sets the InvalidSensorData field's value. +func (s *DataQualitySummary) SetInvalidSensorData(v *InvalidSensorData) *DataQualitySummary { + s.InvalidSensorData = v + return s +} + +// SetMissingSensorData sets the MissingSensorData field's value. +func (s *DataQualitySummary) SetMissingSensorData(v *MissingSensorData) *DataQualitySummary { + s.MissingSensorData = v + return s +} + +// SetUnsupportedTimestamps sets the UnsupportedTimestamps field's value. +func (s *DataQualitySummary) SetUnsupportedTimestamps(v *UnsupportedTimestamps) *DataQualitySummary { + s.UnsupportedTimestamps = v + return s +} + // Provides information about the data schema used with the given dataset. type DatasetSchema struct { _ struct{} `type:"structure"` @@ -3747,6 +4073,19 @@ type DescribeDataIngestionJobOutput struct { // The time at which the data ingestion job was created. CreatedAt *time.Time `type:"timestamp"` + // Indicates the latest timestamp corresponding to data that was successfully + // ingested during this specific ingestion job. + DataEndTime *time.Time `type:"timestamp"` + + // Gives statistics about a completed ingestion job. These statistics primarily + // relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, + // UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps. + DataQualitySummary *DataQualitySummary `type:"structure"` + + // Indicates the earliest timestamp corresponding to data that was successfully + // ingested during this specific ingestion job. + DataStartTime *time.Time `type:"timestamp"` + // The Amazon Resource Name (ARN) of the dataset being used in the data ingestion // job. DatasetArn *string `min:"20" type:"string"` @@ -3754,6 +4093,13 @@ type DescribeDataIngestionJobOutput struct { // Specifies the reason for failure when a data ingestion job has failed. FailedReason *string `min:"1" type:"string"` + // Indicates the size of the ingested dataset. + IngestedDataSize *int64 `type:"long"` + + // Gives statistics about how many files have been ingested, and which files + // have not been ingested, for a particular ingestion job. + IngestedFilesSummary *IngestedFilesSummary `type:"structure"` + // Specifies the S3 location configuration for the data input for the data ingestion // job. IngestionInputConfiguration *IngestionInputConfiguration `type:"structure"` @@ -3767,6 +4113,9 @@ type DescribeDataIngestionJobOutput struct { // Indicates the status of the DataIngestionJob operation. Status *string `type:"string" enum:"IngestionJobStatus"` + + // Provides details about status of the ingestion job that is currently in progress. + StatusDetail *string `min:"1" type:"string"` } // String returns the string representation. @@ -3793,6 +4142,24 @@ func (s *DescribeDataIngestionJobOutput) SetCreatedAt(v time.Time) *DescribeData return s } +// SetDataEndTime sets the DataEndTime field's value. +func (s *DescribeDataIngestionJobOutput) SetDataEndTime(v time.Time) *DescribeDataIngestionJobOutput { + s.DataEndTime = &v + return s +} + +// SetDataQualitySummary sets the DataQualitySummary field's value. +func (s *DescribeDataIngestionJobOutput) SetDataQualitySummary(v *DataQualitySummary) *DescribeDataIngestionJobOutput { + s.DataQualitySummary = v + return s +} + +// SetDataStartTime sets the DataStartTime field's value. +func (s *DescribeDataIngestionJobOutput) SetDataStartTime(v time.Time) *DescribeDataIngestionJobOutput { + s.DataStartTime = &v + return s +} + // SetDatasetArn sets the DatasetArn field's value. func (s *DescribeDataIngestionJobOutput) SetDatasetArn(v string) *DescribeDataIngestionJobOutput { s.DatasetArn = &v @@ -3805,6 +4172,18 @@ func (s *DescribeDataIngestionJobOutput) SetFailedReason(v string) *DescribeData return s } +// SetIngestedDataSize sets the IngestedDataSize field's value. +func (s *DescribeDataIngestionJobOutput) SetIngestedDataSize(v int64) *DescribeDataIngestionJobOutput { + s.IngestedDataSize = &v + return s +} + +// SetIngestedFilesSummary sets the IngestedFilesSummary field's value. +func (s *DescribeDataIngestionJobOutput) SetIngestedFilesSummary(v *IngestedFilesSummary) *DescribeDataIngestionJobOutput { + s.IngestedFilesSummary = v + return s +} + // SetIngestionInputConfiguration sets the IngestionInputConfiguration field's value. func (s *DescribeDataIngestionJobOutput) SetIngestionInputConfiguration(v *IngestionInputConfiguration) *DescribeDataIngestionJobOutput { s.IngestionInputConfiguration = v @@ -3829,6 +4208,12 @@ func (s *DescribeDataIngestionJobOutput) SetStatus(v string) *DescribeDataIngest return s } +// SetStatusDetail sets the StatusDetail field's value. +func (s *DescribeDataIngestionJobOutput) SetStatusDetail(v string) *DescribeDataIngestionJobOutput { + s.StatusDetail = &v + return s +} + type DescribeDatasetInput struct { _ struct{} `type:"structure"` @@ -3884,12 +4269,30 @@ type DescribeDatasetOutput struct { // Specifies the time the dataset was created in Amazon Lookout for Equipment. CreatedAt *time.Time `type:"timestamp"` + // Indicates the latest timestamp corresponding to data that was successfully + // ingested during the most recent ingestion of this particular dataset. + DataEndTime *time.Time `type:"timestamp"` + + // Gives statistics associated with the given dataset for the latest successful + // associated ingestion job id. These statistics primarily relate to quantifying + // incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, + // InsufficientSensorData, and DuplicateTimeStamps. + DataQualitySummary *DataQualitySummary `type:"structure"` + + // Indicates the earliest timestamp corresponding to data that was successfully + // ingested during the most recent ingestion of this particular dataset. + DataStartTime *time.Time `type:"timestamp"` + // The Amazon Resource Name (ARN) of the dataset being described. DatasetArn *string `min:"20" type:"string"` // The name of the dataset being described. DatasetName *string `min:"1" type:"string"` + // IngestedFilesSummary associated with the given dataset for the latest successful + // associated ingestion job id. + IngestedFilesSummary *IngestedFilesSummary `type:"structure"` + // Specifies the S3 location configuration for the data input for the data ingestion // job. IngestionInputConfiguration *IngestionInputConfiguration `type:"structure"` @@ -3897,6 +4300,10 @@ type DescribeDatasetOutput struct { // Specifies the time the dataset was last updated, if it was. LastUpdatedAt *time.Time `type:"timestamp"` + // The Amazon Resource Name (ARN) of the IAM role that you are using for this + // the data ingestion job. + RoleArn *string `min:"20" type:"string"` + // A JSON description of the data that is in each time series dataset, including // names, column names, and data types. Schema aws.JSONValue `type:"jsonvalue"` @@ -3933,6 +4340,24 @@ func (s *DescribeDatasetOutput) SetCreatedAt(v time.Time) *DescribeDatasetOutput return s } +// SetDataEndTime sets the DataEndTime field's value. +func (s *DescribeDatasetOutput) SetDataEndTime(v time.Time) *DescribeDatasetOutput { + s.DataEndTime = &v + return s +} + +// SetDataQualitySummary sets the DataQualitySummary field's value. +func (s *DescribeDatasetOutput) SetDataQualitySummary(v *DataQualitySummary) *DescribeDatasetOutput { + s.DataQualitySummary = v + return s +} + +// SetDataStartTime sets the DataStartTime field's value. +func (s *DescribeDatasetOutput) SetDataStartTime(v time.Time) *DescribeDatasetOutput { + s.DataStartTime = &v + return s +} + // SetDatasetArn sets the DatasetArn field's value. func (s *DescribeDatasetOutput) SetDatasetArn(v string) *DescribeDatasetOutput { s.DatasetArn = &v @@ -3945,6 +4370,12 @@ func (s *DescribeDatasetOutput) SetDatasetName(v string) *DescribeDatasetOutput return s } +// SetIngestedFilesSummary sets the IngestedFilesSummary field's value. +func (s *DescribeDatasetOutput) SetIngestedFilesSummary(v *IngestedFilesSummary) *DescribeDatasetOutput { + s.IngestedFilesSummary = v + return s +} + // SetIngestionInputConfiguration sets the IngestionInputConfiguration field's value. func (s *DescribeDatasetOutput) SetIngestionInputConfiguration(v *IngestionInputConfiguration) *DescribeDatasetOutput { s.IngestionInputConfiguration = v @@ -3957,6 +4388,12 @@ func (s *DescribeDatasetOutput) SetLastUpdatedAt(v time.Time) *DescribeDatasetOu return s } +// SetRoleArn sets the RoleArn field's value. +func (s *DescribeDatasetOutput) SetRoleArn(v string) *DescribeDatasetOutput { + s.RoleArn = &v + return s +} + // SetSchema sets the Schema field's value. func (s *DescribeDatasetOutput) SetSchema(v aws.JSONValue) *DescribeDatasetOutput { s.Schema = v @@ -4466,6 +4903,40 @@ func (s *DescribeModelOutput) SetTrainingExecutionStartTime(v time.Time) *Descri return s } +// Entity that comprises information abount duplicate timestamps in the dataset. +type DuplicateTimestamps struct { + _ struct{} `type:"structure"` + + // Indicates the total number of duplicate timestamps. + // + // TotalNumberOfDuplicateTimestamps is a required field + TotalNumberOfDuplicateTimestamps *int64 `type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DuplicateTimestamps) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DuplicateTimestamps) GoString() string { + return s.String() +} + +// SetTotalNumberOfDuplicateTimestamps sets the TotalNumberOfDuplicateTimestamps field's value. +func (s *DuplicateTimestamps) SetTotalNumberOfDuplicateTimestamps(v int64) *DuplicateTimestamps { + s.TotalNumberOfDuplicateTimestamps = &v + return s +} + // Contains information about the specific inference execution, including input // and output data configuration, inference scheduling information, status, // and so on. @@ -4484,7 +4955,7 @@ type InferenceExecutionSummary struct { DataInputConfiguration *InferenceInputConfiguration `type:"structure"` // Specifies configuration information for the output results from for the inference - // execution, including the output S3 location. + // execution, including the output Amazon S3 location. DataOutputConfiguration *InferenceOutputConfiguration `type:"structure"` // Indicates the time reference in the dataset at which the inference execution @@ -4606,7 +5077,7 @@ func (s *InferenceExecutionSummary) SetStatus(v string) *InferenceExecutionSumma } // Specifies configuration information for the input data for the inference, -// including S3 location of input data.. +// including Amazon S3 location of input data.. type InferenceInputConfiguration struct { _ struct{} `type:"structure"` @@ -4614,11 +5085,12 @@ type InferenceInputConfiguration struct { // including timestamp format and delimiter. InferenceInputNameConfiguration *InferenceInputNameConfiguration `type:"structure"` - // Indicates the difference between your time zone and Greenwich Mean Time (GMT). + // Indicates the difference between your time zone and Coordinated Universal + // Time (UTC). InputTimeZoneOffset *string `type:"string"` // Specifies configuration information for the input data for the inference, - // including S3 location of input data.. + // including Amazon S3 location of input data. S3InputConfiguration *InferenceS3InputConfiguration `type:"structure"` } @@ -5001,6 +5473,62 @@ func (s *InferenceSchedulerSummary) SetStatus(v string) *InferenceSchedulerSumma return s } +// Gives statistics about how many files have been ingested, and which files +// have not been ingested, for a particular ingestion job. +type IngestedFilesSummary struct { + _ struct{} `type:"structure"` + + // Indicates the number of files that were discarded. A file could be discarded + // because its format is invalid (for example, a jpg or pdf) or not readable. + DiscardedFiles []*S3Object `type:"list"` + + // Indicates the number of files that were successfully ingested. + // + // IngestedNumberOfFiles is a required field + IngestedNumberOfFiles *int64 `type:"integer" required:"true"` + + // Indicates the total number of files that were submitted for ingestion. + // + // TotalNumberOfFiles is a required field + TotalNumberOfFiles *int64 `type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s IngestedFilesSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s IngestedFilesSummary) GoString() string { + return s.String() +} + +// SetDiscardedFiles sets the DiscardedFiles field's value. +func (s *IngestedFilesSummary) SetDiscardedFiles(v []*S3Object) *IngestedFilesSummary { + s.DiscardedFiles = v + return s +} + +// SetIngestedNumberOfFiles sets the IngestedNumberOfFiles field's value. +func (s *IngestedFilesSummary) SetIngestedNumberOfFiles(v int64) *IngestedFilesSummary { + s.IngestedNumberOfFiles = &v + return s +} + +// SetTotalNumberOfFiles sets the TotalNumberOfFiles field's value. +func (s *IngestedFilesSummary) SetTotalNumberOfFiles(v int64) *IngestedFilesSummary { + s.TotalNumberOfFiles = &v + return s +} + // Specifies configuration information for the input data for the data ingestion // job, including input data S3 location. type IngestionInputConfiguration struct { @@ -5065,6 +5593,11 @@ type IngestionS3InputConfiguration struct { // Bucket is a required field Bucket *string `min:"3" type:"string" required:"true"` + // Pattern for matching the Amazon S3 files which will be used for ingestion. + // If no KeyPattern is provided, we will use the default hierarchy file structure, + // which is same as KeyPattern {prefix}/{component_name}/* + KeyPattern *string `min:"1" type:"string"` + // The prefix for the S3 location being used for the input data for the data // ingestion. Prefix *string `type:"string"` @@ -5097,6 +5630,9 @@ func (s *IngestionS3InputConfiguration) Validate() error { if s.Bucket != nil && len(*s.Bucket) < 3 { invalidParams.Add(request.NewErrParamMinLen("Bucket", 3)) } + if s.KeyPattern != nil && len(*s.KeyPattern) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KeyPattern", 1)) + } if invalidParams.Len() > 0 { return invalidParams @@ -5110,12 +5646,66 @@ func (s *IngestionS3InputConfiguration) SetBucket(v string) *IngestionS3InputCon return s } +// SetKeyPattern sets the KeyPattern field's value. +func (s *IngestionS3InputConfiguration) SetKeyPattern(v string) *IngestionS3InputConfiguration { + s.KeyPattern = &v + return s +} + // SetPrefix sets the Prefix field's value. func (s *IngestionS3InputConfiguration) SetPrefix(v string) *IngestionS3InputConfiguration { s.Prefix = &v return s } +// Entity that comprises aggregated information on sensors having insufficient +// data. +type InsufficientSensorData struct { + _ struct{} `type:"structure"` + + // Parameter that describes the total number of sensors that have data completely + // missing for it. + // + // MissingCompleteSensorData is a required field + MissingCompleteSensorData *MissingCompleteSensorData `type:"structure" required:"true"` + + // Parameter that describes the total number of sensors that have a short date + // range of less than 90 days of data overall. + // + // SensorsWithShortDateRange is a required field + SensorsWithShortDateRange *SensorsWithShortDateRange `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InsufficientSensorData) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InsufficientSensorData) GoString() string { + return s.String() +} + +// SetMissingCompleteSensorData sets the MissingCompleteSensorData field's value. +func (s *InsufficientSensorData) SetMissingCompleteSensorData(v *MissingCompleteSensorData) *InsufficientSensorData { + s.MissingCompleteSensorData = v + return s +} + +// SetSensorsWithShortDateRange sets the SensorsWithShortDateRange field's value. +func (s *InsufficientSensorData) SetSensorsWithShortDateRange(v *SensorsWithShortDateRange) *InsufficientSensorData { + s.SensorsWithShortDateRange = v + return s +} + // Processing of the request has failed because of an unknown error, exception // or failure. type InternalServerException struct { @@ -5181,6 +5771,52 @@ func (s *InternalServerException) RequestID() string { return s.RespMetadata.RequestID } +// Entity that comprises aggregated information on sensors having insufficient +// data. +type InvalidSensorData struct { + _ struct{} `type:"structure"` + + // Indicates the number of sensors that have at least some invalid values. + // + // AffectedSensorCount is a required field + AffectedSensorCount *int64 `type:"integer" required:"true"` + + // Indicates the total number of invalid values across all the sensors. + // + // TotalNumberOfInvalidValues is a required field + TotalNumberOfInvalidValues *int64 `type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InvalidSensorData) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InvalidSensorData) GoString() string { + return s.String() +} + +// SetAffectedSensorCount sets the AffectedSensorCount field's value. +func (s *InvalidSensorData) SetAffectedSensorCount(v int64) *InvalidSensorData { + s.AffectedSensorCount = &v + return s +} + +// SetTotalNumberOfInvalidValues sets the TotalNumberOfInvalidValues field's value. +func (s *InvalidSensorData) SetTotalNumberOfInvalidValues(v int64) *InvalidSensorData { + s.TotalNumberOfInvalidValues = &v + return s +} + // Contains the configuration information for the S3 location being used to // hold label data. type LabelsInputConfiguration struct { @@ -5294,6 +5930,60 @@ func (s *LabelsS3InputConfiguration) SetPrefix(v string) *LabelsS3InputConfigura return s } +// Entity that comprises information on large gaps between consecutive timestamps +// in data. +type LargeTimestampGaps struct { + _ struct{} `type:"structure"` + + // Indicates the size of the largest timestamp gap, in days. + MaxTimestampGapInDays *int64 `type:"integer"` + + // Indicates the number of large timestamp gaps, if there are any. + NumberOfLargeTimestampGaps *int64 `type:"integer"` + + // Indicates whether there is a potential data issue related to large gaps in + // timestamps. + // + // Status is a required field + Status *string `type:"string" required:"true" enum:"StatisticalIssueStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LargeTimestampGaps) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LargeTimestampGaps) GoString() string { + return s.String() +} + +// SetMaxTimestampGapInDays sets the MaxTimestampGapInDays field's value. +func (s *LargeTimestampGaps) SetMaxTimestampGapInDays(v int64) *LargeTimestampGaps { + s.MaxTimestampGapInDays = &v + return s +} + +// SetNumberOfLargeTimestampGaps sets the NumberOfLargeTimestampGaps field's value. +func (s *LargeTimestampGaps) SetNumberOfLargeTimestampGaps(v int64) *LargeTimestampGaps { + s.NumberOfLargeTimestampGaps = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *LargeTimestampGaps) SetStatus(v string) *LargeTimestampGaps { + s.Status = &v + return s +} + type ListDataIngestionJobsInput struct { _ struct{} `type:"structure"` @@ -5909,14 +6599,25 @@ func (s *ListModelsOutput) SetNextToken(v string) *ListModelsOutput { return s } -type ListTagsForResourceInput struct { +type ListSensorStatisticsInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the resource (such as the dataset or model) - // that is the focus of the ListTagsForResource operation. + // The name of the dataset associated with the list of Sensor Statistics. // - // ResourceArn is a required field - ResourceArn *string `min:"1" type:"string" required:"true"` + // DatasetName is a required field + DatasetName *string `min:"1" type:"string" required:"true"` + + // The ingestion job id associated with the list of Sensor Statistics. To get + // sensor statistics for a particular ingestion job id, both dataset name and + // ingestion job id must be submitted as inputs. + IngestionJobId *string `type:"string"` + + // Specifies the maximum number of sensors for which to retrieve statistics. + MaxResults *int64 `min:"1" type:"integer"` + + // An opaque pagination token indicating where to continue the listing of sensor + // statistics. + NextToken *string `type:"string"` } // String returns the string representation. @@ -5924,7 +6625,7 @@ type ListTagsForResourceInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListTagsForResourceInput) String() string { +func (s ListSensorStatisticsInput) String() string { return awsutil.Prettify(s) } @@ -5933,18 +6634,21 @@ func (s ListTagsForResourceInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListTagsForResourceInput) GoString() string { +func (s ListSensorStatisticsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListTagsForResourceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} - if s.ResourceArn == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceArn")) +func (s *ListSensorStatisticsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListSensorStatisticsInput"} + if s.DatasetName == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetName")) } - if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + if s.DatasetName != nil && len(*s.DatasetName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetName", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } if invalidParams.Len() > 0 { @@ -5953,17 +6657,42 @@ func (s *ListTagsForResourceInput) Validate() error { return nil } -// SetResourceArn sets the ResourceArn field's value. -func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { - s.ResourceArn = &v +// SetDatasetName sets the DatasetName field's value. +func (s *ListSensorStatisticsInput) SetDatasetName(v string) *ListSensorStatisticsInput { + s.DatasetName = &v return s } -type ListTagsForResourceOutput struct { +// SetIngestionJobId sets the IngestionJobId field's value. +func (s *ListSensorStatisticsInput) SetIngestionJobId(v string) *ListSensorStatisticsInput { + s.IngestionJobId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListSensorStatisticsInput) SetMaxResults(v int64) *ListSensorStatisticsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSensorStatisticsInput) SetNextToken(v string) *ListSensorStatisticsInput { + s.NextToken = &v + return s +} + +type ListSensorStatisticsOutput struct { _ struct{} `type:"structure"` - // Any tags associated with the resource. - Tags []*Tag `type:"list"` + // An opaque pagination token indicating where to continue the listing of sensor + // statistics. + NextToken *string `type:"string"` + + // Provides ingestion-based statistics regarding the specified sensor with respect + // to various validation types, such as whether data exists, the number and + // percentage of missing values, and the number and percentage of duplicate + // timestamps. + SensorStatisticsSummaries []*SensorStatisticsSummary `type:"list"` } // String returns the string representation. @@ -5971,7 +6700,7 @@ type ListTagsForResourceOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListTagsForResourceOutput) String() string { +func (s ListSensorStatisticsOutput) String() string { return awsutil.Prettify(s) } @@ -5980,25 +6709,192 @@ func (s ListTagsForResourceOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListTagsForResourceOutput) GoString() string { +func (s ListSensorStatisticsOutput) GoString() string { return s.String() } -// SetTags sets the Tags field's value. -func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput { - s.Tags = v +// SetNextToken sets the NextToken field's value. +func (s *ListSensorStatisticsOutput) SetNextToken(v string) *ListSensorStatisticsOutput { + s.NextToken = &v return s } -// Provides information about the specified ML model, including dataset and -// model names and ARNs, as well as status. -type ModelSummary struct { +// SetSensorStatisticsSummaries sets the SensorStatisticsSummaries field's value. +func (s *ListSensorStatisticsOutput) SetSensorStatisticsSummaries(v []*SensorStatisticsSummary) *ListSensorStatisticsOutput { + s.SensorStatisticsSummaries = v + return s +} + +type ListTagsForResourceInput struct { _ struct{} `type:"structure"` - // The time at which the specific model was created. - CreatedAt *time.Time `type:"timestamp"` + // The Amazon Resource Name (ARN) of the resource (such as the dataset or model) + // that is the focus of the ListTagsForResource operation. + // + // ResourceArn is a required field + ResourceArn *string `min:"1" type:"string" required:"true"` +} - // The Amazon Resource Name (ARN) of the dataset used to create the model. +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { + s.ResourceArn = &v + return s +} + +type ListTagsForResourceOutput struct { + _ struct{} `type:"structure"` + + // Any tags associated with the resource. + Tags []*Tag `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) GoString() string { + return s.String() +} + +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput { + s.Tags = v + return s +} + +// Entity that comprises information on sensors that have sensor data completely +// missing. +type MissingCompleteSensorData struct { + _ struct{} `type:"structure"` + + // Indicates the number of sensors that have data missing completely. + // + // AffectedSensorCount is a required field + AffectedSensorCount *int64 `type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MissingCompleteSensorData) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MissingCompleteSensorData) GoString() string { + return s.String() +} + +// SetAffectedSensorCount sets the AffectedSensorCount field's value. +func (s *MissingCompleteSensorData) SetAffectedSensorCount(v int64) *MissingCompleteSensorData { + s.AffectedSensorCount = &v + return s +} + +// Entity that comprises aggregated information on sensors having missing data. +type MissingSensorData struct { + _ struct{} `type:"structure"` + + // Indicates the number of sensors that have atleast some data missing. + // + // AffectedSensorCount is a required field + AffectedSensorCount *int64 `type:"integer" required:"true"` + + // Indicates the total number of missing values across all the sensors. + // + // TotalNumberOfMissingValues is a required field + TotalNumberOfMissingValues *int64 `type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MissingSensorData) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MissingSensorData) GoString() string { + return s.String() +} + +// SetAffectedSensorCount sets the AffectedSensorCount field's value. +func (s *MissingSensorData) SetAffectedSensorCount(v int64) *MissingSensorData { + s.AffectedSensorCount = &v + return s +} + +// SetTotalNumberOfMissingValues sets the TotalNumberOfMissingValues field's value. +func (s *MissingSensorData) SetTotalNumberOfMissingValues(v int64) *MissingSensorData { + s.TotalNumberOfMissingValues = &v + return s +} + +// Provides information about the specified ML model, including dataset and +// model names and ARNs, as well as status. +type ModelSummary struct { + _ struct{} `type:"structure"` + + // The time at which the specific model was created. + CreatedAt *time.Time `type:"timestamp"` + + // The Amazon Resource Name (ARN) of the dataset used to create the model. DatasetArn *string `min:"20" type:"string"` // The name of the dataset being used for the ML model. @@ -6068,6 +6964,85 @@ func (s *ModelSummary) SetStatus(v string) *ModelSummary { return s } +// Entity that comprises information on monotonic values in the data. +type MonotonicValues struct { + _ struct{} `type:"structure"` + + // Indicates the monotonicity of values. Can be INCREASING, DECREASING, or STATIC. + Monotonicity *string `type:"string" enum:"Monotonicity"` + + // Indicates whether there is a potential data issue related to having monotonic + // values. + // + // Status is a required field + Status *string `type:"string" required:"true" enum:"StatisticalIssueStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MonotonicValues) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MonotonicValues) GoString() string { + return s.String() +} + +// SetMonotonicity sets the Monotonicity field's value. +func (s *MonotonicValues) SetMonotonicity(v string) *MonotonicValues { + s.Monotonicity = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *MonotonicValues) SetStatus(v string) *MonotonicValues { + s.Status = &v + return s +} + +// Entity that comprises information on operating modes in data. +type MultipleOperatingModes struct { + _ struct{} `type:"structure"` + + // Indicates whether there is a potential data issue related to having multiple + // operating modes. + // + // Status is a required field + Status *string `type:"string" required:"true" enum:"StatisticalIssueStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MultipleOperatingModes) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MultipleOperatingModes) GoString() string { + return s.String() +} + +// SetStatus sets the Status field's value. +func (s *MultipleOperatingModes) SetStatus(v string) *MultipleOperatingModes { + s.Status = &v + return s +} + // The resource requested could not be found. Verify the resource ID and retry // your request. type ResourceNotFoundException struct { @@ -6179,6 +7154,193 @@ func (s *S3Object) SetKey(v string) *S3Object { return s } +// Summary of ingestion statistics like whether data exists, number of missing +// values, number of invalid values and so on related to the particular sensor. +type SensorStatisticsSummary struct { + _ struct{} `type:"structure"` + + // Parameter that describes potential risk about whether data associated with + // the sensor is categorical. + CategoricalValues *CategoricalValues `type:"structure"` + + // Name of the component to which the particular sensor belongs for which the + // statistics belong to. + ComponentName *string `min:"1" type:"string"` + + // Indicates the time reference to indicate the end of valid data associated + // with the sensor that the statistics belong to. + DataEndTime *time.Time `type:"timestamp"` + + // Parameter that indicates whether data exists for the sensor that the statistics + // belong to. + DataExists *bool `type:"boolean"` + + // Indicates the time reference to indicate the beginning of valid data associated + // with the sensor that the statistics belong to. + DataStartTime *time.Time `type:"timestamp"` + + // Parameter that describes the total number of duplicate timestamp records + // associated with the sensor that the statistics belong to. + DuplicateTimestamps *CountPercent `type:"structure"` + + // Parameter that describes the total number of invalid date entries associated + // with the sensor that the statistics belong to. + InvalidDateEntries *CountPercent `type:"structure"` + + // Parameter that describes the total number of, and percentage of, values that + // are invalid for the sensor that the statistics belong to. + InvalidValues *CountPercent `type:"structure"` + + // Parameter that describes potential risk about whether data associated with + // the sensor contains one or more large gaps between consecutive timestamps. + LargeTimestampGaps *LargeTimestampGaps `type:"structure"` + + // Parameter that describes the total number of, and percentage of, values that + // are missing for the sensor that the statistics belong to. + MissingValues *CountPercent `type:"structure"` + + // Parameter that describes potential risk about whether data associated with + // the sensor is mostly monotonic. + MonotonicValues *MonotonicValues `type:"structure"` + + // Parameter that describes potential risk about whether data associated with + // the sensor has more than one operating mode. + MultipleOperatingModes *MultipleOperatingModes `type:"structure"` + + // Name of the sensor that the statistics belong to. + SensorName *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SensorStatisticsSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SensorStatisticsSummary) GoString() string { + return s.String() +} + +// SetCategoricalValues sets the CategoricalValues field's value. +func (s *SensorStatisticsSummary) SetCategoricalValues(v *CategoricalValues) *SensorStatisticsSummary { + s.CategoricalValues = v + return s +} + +// SetComponentName sets the ComponentName field's value. +func (s *SensorStatisticsSummary) SetComponentName(v string) *SensorStatisticsSummary { + s.ComponentName = &v + return s +} + +// SetDataEndTime sets the DataEndTime field's value. +func (s *SensorStatisticsSummary) SetDataEndTime(v time.Time) *SensorStatisticsSummary { + s.DataEndTime = &v + return s +} + +// SetDataExists sets the DataExists field's value. +func (s *SensorStatisticsSummary) SetDataExists(v bool) *SensorStatisticsSummary { + s.DataExists = &v + return s +} + +// SetDataStartTime sets the DataStartTime field's value. +func (s *SensorStatisticsSummary) SetDataStartTime(v time.Time) *SensorStatisticsSummary { + s.DataStartTime = &v + return s +} + +// SetDuplicateTimestamps sets the DuplicateTimestamps field's value. +func (s *SensorStatisticsSummary) SetDuplicateTimestamps(v *CountPercent) *SensorStatisticsSummary { + s.DuplicateTimestamps = v + return s +} + +// SetInvalidDateEntries sets the InvalidDateEntries field's value. +func (s *SensorStatisticsSummary) SetInvalidDateEntries(v *CountPercent) *SensorStatisticsSummary { + s.InvalidDateEntries = v + return s +} + +// SetInvalidValues sets the InvalidValues field's value. +func (s *SensorStatisticsSummary) SetInvalidValues(v *CountPercent) *SensorStatisticsSummary { + s.InvalidValues = v + return s +} + +// SetLargeTimestampGaps sets the LargeTimestampGaps field's value. +func (s *SensorStatisticsSummary) SetLargeTimestampGaps(v *LargeTimestampGaps) *SensorStatisticsSummary { + s.LargeTimestampGaps = v + return s +} + +// SetMissingValues sets the MissingValues field's value. +func (s *SensorStatisticsSummary) SetMissingValues(v *CountPercent) *SensorStatisticsSummary { + s.MissingValues = v + return s +} + +// SetMonotonicValues sets the MonotonicValues field's value. +func (s *SensorStatisticsSummary) SetMonotonicValues(v *MonotonicValues) *SensorStatisticsSummary { + s.MonotonicValues = v + return s +} + +// SetMultipleOperatingModes sets the MultipleOperatingModes field's value. +func (s *SensorStatisticsSummary) SetMultipleOperatingModes(v *MultipleOperatingModes) *SensorStatisticsSummary { + s.MultipleOperatingModes = v + return s +} + +// SetSensorName sets the SensorName field's value. +func (s *SensorStatisticsSummary) SetSensorName(v string) *SensorStatisticsSummary { + s.SensorName = &v + return s +} + +// Entity that comprises information on sensors that have shorter date range. +type SensorsWithShortDateRange struct { + _ struct{} `type:"structure"` + + // Indicates the number of sensors that have less than 90 days of data. + // + // AffectedSensorCount is a required field + AffectedSensorCount *int64 `type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SensorsWithShortDateRange) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SensorsWithShortDateRange) GoString() string { + return s.String() +} + +// SetAffectedSensorCount sets the AffectedSensorCount field's value. +func (s *SensorsWithShortDateRange) SetAffectedSensorCount(v int64) *SensorsWithShortDateRange { + s.AffectedSensorCount = &v + return s +} + // Resource limitations have been exceeded. type ServiceQuotaExceededException struct { _ struct{} `type:"structure"` @@ -6842,6 +8004,41 @@ func (s *ThrottlingException) RequestID() string { return s.RespMetadata.RequestID } +// Entity that comprises information abount unsupported timestamps in the dataset. +type UnsupportedTimestamps struct { + _ struct{} `type:"structure"` + + // Indicates the total number of unsupported timestamps across the ingested + // data. + // + // TotalNumberOfUnsupportedTimestamps is a required field + TotalNumberOfUnsupportedTimestamps *int64 `type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UnsupportedTimestamps) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UnsupportedTimestamps) GoString() string { + return s.String() +} + +// SetTotalNumberOfUnsupportedTimestamps sets the TotalNumberOfUnsupportedTimestamps field's value. +func (s *UnsupportedTimestamps) SetTotalNumberOfUnsupportedTimestamps(v int64) *UnsupportedTimestamps { + s.TotalNumberOfUnsupportedTimestamps = &v + return s +} + type UntagResourceInput struct { _ struct{} `type:"structure"` @@ -7269,6 +8466,42 @@ func ModelStatus_Values() []string { } } +const ( + // MonotonicityDecreasing is a Monotonicity enum value + MonotonicityDecreasing = "DECREASING" + + // MonotonicityIncreasing is a Monotonicity enum value + MonotonicityIncreasing = "INCREASING" + + // MonotonicityStatic is a Monotonicity enum value + MonotonicityStatic = "STATIC" +) + +// Monotonicity_Values returns all elements of the Monotonicity enum +func Monotonicity_Values() []string { + return []string{ + MonotonicityDecreasing, + MonotonicityIncreasing, + MonotonicityStatic, + } +} + +const ( + // StatisticalIssueStatusPotentialIssueDetected is a StatisticalIssueStatus enum value + StatisticalIssueStatusPotentialIssueDetected = "POTENTIAL_ISSUE_DETECTED" + + // StatisticalIssueStatusNoIssueDetected is a StatisticalIssueStatus enum value + StatisticalIssueStatusNoIssueDetected = "NO_ISSUE_DETECTED" +) + +// StatisticalIssueStatus_Values returns all elements of the StatisticalIssueStatus enum +func StatisticalIssueStatus_Values() []string { + return []string{ + StatisticalIssueStatusPotentialIssueDetected, + StatisticalIssueStatusNoIssueDetected, + } +} + const ( // TargetSamplingRatePt1s is a TargetSamplingRate enum value TargetSamplingRatePt1s = "PT1S" diff --git a/service/lookoutequipment/lookoutequipmentiface/interface.go b/service/lookoutequipment/lookoutequipmentiface/interface.go index 154b3b5cf29..82f2823625a 100644 --- a/service/lookoutequipment/lookoutequipmentiface/interface.go +++ b/service/lookoutequipment/lookoutequipmentiface/interface.go @@ -135,6 +135,13 @@ type LookoutEquipmentAPI interface { ListModelsPages(*lookoutequipment.ListModelsInput, func(*lookoutequipment.ListModelsOutput, bool) bool) error ListModelsPagesWithContext(aws.Context, *lookoutequipment.ListModelsInput, func(*lookoutequipment.ListModelsOutput, bool) bool, ...request.Option) error + ListSensorStatistics(*lookoutequipment.ListSensorStatisticsInput) (*lookoutequipment.ListSensorStatisticsOutput, error) + ListSensorStatisticsWithContext(aws.Context, *lookoutequipment.ListSensorStatisticsInput, ...request.Option) (*lookoutequipment.ListSensorStatisticsOutput, error) + ListSensorStatisticsRequest(*lookoutequipment.ListSensorStatisticsInput) (*request.Request, *lookoutequipment.ListSensorStatisticsOutput) + + ListSensorStatisticsPages(*lookoutequipment.ListSensorStatisticsInput, func(*lookoutequipment.ListSensorStatisticsOutput, bool) bool) error + ListSensorStatisticsPagesWithContext(aws.Context, *lookoutequipment.ListSensorStatisticsInput, func(*lookoutequipment.ListSensorStatisticsOutput, bool) bool, ...request.Option) error + ListTagsForResource(*lookoutequipment.ListTagsForResourceInput) (*lookoutequipment.ListTagsForResourceOutput, error) ListTagsForResourceWithContext(aws.Context, *lookoutequipment.ListTagsForResourceInput, ...request.Option) (*lookoutequipment.ListTagsForResourceOutput, error) ListTagsForResourceRequest(*lookoutequipment.ListTagsForResourceInput) (*request.Request, *lookoutequipment.ListTagsForResourceOutput) diff --git a/service/rekognition/api.go b/service/rekognition/api.go index 0d7cd377761..19601888995 100644 --- a/service/rekognition/api.go +++ b/service/rekognition/api.go @@ -132,7 +132,8 @@ func (c *Rekognition) CompareFacesRequest(input *CompareFacesInput) (req *reques // * ImageTooLargeException // The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, // the image size or resolution exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. // // * AccessDeniedException // You are not authorized to perform the action. @@ -262,7 +263,8 @@ func (c *Rekognition) CreateCollectionRequest(input *CreateCollectionInput) (req // // * ServiceQuotaExceededException // The size of the collection exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. // func (c *Rekognition) CreateCollection(input *CreateCollectionInput) (*CreateCollectionOutput, error) { req, out := c.CreateCollectionRequest(input) @@ -643,7 +645,8 @@ func (c *Rekognition) CreateProjectVersionRequest(input *CreateProjectVersionInp // // * ServiceQuotaExceededException // The size of the collection exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. // func (c *Rekognition) CreateProjectVersion(input *CreateProjectVersionInput) (*CreateProjectVersionOutput, error) { req, out := c.CreateProjectVersionRequest(input) @@ -709,22 +712,34 @@ func (c *Rekognition) CreateStreamProcessorRequest(input *CreateStreamProcessorI // CreateStreamProcessor API operation for Amazon Rekognition. // // Creates an Amazon Rekognition stream processor that you can use to detect -// and recognize faces in a streaming video. +// and recognize faces or to detect labels in a streaming video. // // Amazon Rekognition Video is a consumer of live video from Amazon Kinesis -// Video Streams. Amazon Rekognition Video sends analysis results to Amazon -// Kinesis Data Streams. +// Video Streams. There are two different settings for stream processors in +// Amazon Rekognition: detecting faces and detecting labels. +// +// * If you are creating a stream processor for detecting faces, you provide +// as input a Kinesis video stream (Input) and a Kinesis data stream (Output) +// stream. You also specify the face recognition criteria in Settings. For +// example, the collection containing faces that you want to recognize. After +// you have finished analyzing a streaming video, use StopStreamProcessor +// to stop processing. +// +// * If you are creating a stream processor to detect labels, you provide +// as input a Kinesis video stream (Input), Amazon S3 bucket information +// (Output), and an Amazon SNS topic ARN (NotificationChannel). You can also +// provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket. +// You specify what you want to detect in ConnectedHomeSettings, such as +// people, packages and people, or pets, people, and packages. You can also +// specify where in the frame you want Amazon Rekognition to monitor with +// RegionsOfInterest. When you run the StartStreamProcessor operation on +// a label detection stream processor, you input start and stop information +// to determine the length of the processing time. // -// You provide as input a Kinesis video stream (Input) and a Kinesis data stream -// (Output) stream. You also specify the face recognition criteria in Settings. -// For example, the collection containing faces that you want to recognize. // Use Name to assign an identifier for the stream processor. You use Name to // manage the stream processor. For example, you can start processing the source // video by calling StartStreamProcessor with the Name field. // -// After you have finished analyzing a streaming video, use StopStreamProcessor -// to stop processing. You can delete the stream processor by calling DeleteStreamProcessor. -// // This operation requires permissions to perform the rekognition:CreateStreamProcessor // action. If you want to tag your stream processor, you also require permission // to perform the rekognition:TagResource operation. @@ -767,7 +782,8 @@ func (c *Rekognition) CreateStreamProcessorRequest(input *CreateStreamProcessorI // // * ServiceQuotaExceededException // The size of the collection exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. // func (c *Rekognition) CreateStreamProcessor(input *CreateStreamProcessorInput) (*CreateStreamProcessorOutput, error) { req, out := c.CreateStreamProcessorRequest(input) @@ -833,7 +849,7 @@ func (c *Rekognition) DeleteCollectionRequest(input *DeleteCollectionInput) (req // DeleteCollection API operation for Amazon Rekognition. // // Deletes the specified collection. Note that this operation removes all faces -// in the collection. For an example, see delete-collection-procedure. +// in the collection. For an example, see Deleting a collection (https://docs.aws.amazon.com/rekognition/latest/dg/delete-collection-procedure.html). // // This operation requires permissions to perform the rekognition:DeleteCollection // action. @@ -2132,7 +2148,8 @@ func (c *Rekognition) DetectCustomLabelsRequest(input *DetectCustomLabelsInput) // * ImageTooLargeException // The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, // the image size or resolution exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. // // * LimitExceededException // An Amazon Rekognition service limit was exceeded. For example, if you start @@ -2262,7 +2279,8 @@ func (c *Rekognition) DetectFacesRequest(input *DetectFacesInput) (req *request. // * ImageTooLargeException // The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, // the image size or resolution exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. // // * AccessDeniedException // You are not authorized to perform the action. @@ -2349,7 +2367,7 @@ func (c *Rekognition) DetectLabelsRequest(input *DetectLabelsInput) (req *reques // wedding, graduation, and birthday party; and concepts like landscape, evening, // and nature. // -// For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the +// For an example, see Analyzing images stored in an Amazon S3 bucket in the // Amazon Rekognition Developer Guide. // // DetectLabels does not support the detection of activities. However, activity @@ -2432,7 +2450,8 @@ func (c *Rekognition) DetectLabelsRequest(input *DetectLabelsInput) (req *reques // * ImageTooLargeException // The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, // the image size or resolution exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. // // * AccessDeniedException // You are not authorized to perform the action. @@ -2548,7 +2567,8 @@ func (c *Rekognition) DetectModerationLabelsRequest(input *DetectModerationLabel // * ImageTooLargeException // The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, // the image size or resolution exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. // // * AccessDeniedException // You are not authorized to perform the action. @@ -2690,7 +2710,8 @@ func (c *Rekognition) DetectProtectiveEquipmentRequest(input *DetectProtectiveEq // * ImageTooLargeException // The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, // the image size or resolution exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. // // * AccessDeniedException // You are not authorized to perform the action. @@ -2802,7 +2823,7 @@ func (c *Rekognition) DetectTextRequest(input *DetectTextInput) (req *request.Re // To be detected, text must be within +/- 90 degrees orientation of the horizontal // axis. // -// For more information, see DetectText in the Amazon Rekognition Developer +// For more information, see Detecting text in the Amazon Rekognition Developer // Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2823,7 +2844,8 @@ func (c *Rekognition) DetectTextRequest(input *DetectTextInput) (req *request.Re // * ImageTooLargeException // The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, // the image size or resolution exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. // // * AccessDeniedException // You are not authorized to perform the action. @@ -3025,7 +3047,7 @@ func (c *Rekognition) GetCelebrityInfoRequest(input *GetCelebrityInfoInput) (req // of URLs. If there is no additional information about the celebrity, this // list is empty. // -// For more information, see Recognizing Celebrities in an Image in the Amazon +// For more information, see Getting information about a celebrity in the Amazon // Rekognition Developer Guide. // // This operation requires permissions to perform the rekognition:GetCelebrityInfo @@ -3363,7 +3385,7 @@ func (c *Rekognition) GetContentModerationRequest(input *GetContentModerationInp // and populate the NextToken request parameter with the value of NextToken // returned from the previous call to GetContentModeration. // -// For more information, see Content moderation in the Amazon Rekognition Developer +// For more information, see moderating content in the Amazon Rekognition Developer // Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -4280,7 +4302,7 @@ func (c *Rekognition) GetSegmentDetectionRequest(input *GetSegmentDetectionInput // and populate the NextToken request parameter with the token value returned // from the previous call to GetSegmentDetection. // -// For more information, see Detecting Video Segments in Stored Video in the +// For more information, see Detecting video segments in stored video in the // Amazon Rekognition Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -4619,7 +4641,7 @@ func (c *Rekognition) IndexFacesRequest(input *IndexFacesInput) (req *request.Re // when it performs face match and search operations using the SearchFaces and // SearchFacesByImage operations. // -// For more information, see Adding Faces to a Collection in the Amazon Rekognition +// For more information, see Adding faces to a collection in the Amazon Rekognition // Developer Guide. // // To get the number of faces in a collection, call DescribeCollection. @@ -4694,9 +4716,9 @@ func (c *Rekognition) IndexFacesRequest(input *IndexFacesInput) (req *request.Re // If you request all facial attributes (by using the detectionAttributes parameter), // Amazon Rekognition returns detailed facial attributes, such as facial landmarks // (for example, location of eye and mouth) and other facial attributes. If -// you provide the same image, specify the same collection, use the same external -// ID, and use the same model version in the IndexFaces operation, Amazon Rekognition -// doesn't save duplicate face metadata. +// you provide the same image, specify the same collection, and use the same +// external ID in the IndexFaces operation, Amazon Rekognition doesn't save +// duplicate face metadata. // // The input image is passed either as base64-encoded image bytes, or as a reference // to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon @@ -4724,7 +4746,8 @@ func (c *Rekognition) IndexFacesRequest(input *IndexFacesInput) (req *request.Re // * ImageTooLargeException // The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, // the image size or resolution exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. // // * AccessDeniedException // You are not authorized to perform the action. @@ -4748,7 +4771,8 @@ func (c *Rekognition) IndexFacesRequest(input *IndexFacesInput) (req *request.Re // // * ServiceQuotaExceededException // The size of the collection exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. // func (c *Rekognition) IndexFaces(input *IndexFacesInput) (*IndexFacesOutput, error) { req, out := c.IndexFacesRequest(input) @@ -4823,7 +4847,7 @@ func (c *Rekognition) ListCollectionsRequest(input *ListCollectionsInput) (req * // the response also provides a NextToken that you can use in the subsequent // request to fetch the next set of collection IDs. // -// For an example, see Listing Collections in the Amazon Rekognition Developer +// For an example, see Listing collections in the Amazon Rekognition Developer // Guide. // // This operation requires permissions to perform the rekognition:ListCollections @@ -5732,7 +5756,7 @@ func (c *Rekognition) RecognizeCelebritiesRequest(input *RecognizeCelebritiesInp // RecognizeCelebrities API operation for Amazon Rekognition. // // Returns an array of celebrities recognized in the input image. For more information, -// see Recognizing Celebrities in the Amazon Rekognition Developer Guide. +// see Recognizing celebrities in the Amazon Rekognition Developer Guide. // // RecognizeCelebrities returns the 64 largest faces in the image. It lists // the recognized celebrities in the CelebrityFaces array and any unrecognized @@ -5756,7 +5780,7 @@ func (c *Rekognition) RecognizeCelebritiesRequest(input *RecognizeCelebritiesInp // Rekognition operations, passing image bytes is not supported. The image must // be either a PNG or JPEG formatted file. // -// For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition +// For an example, see Recognizing celebrities in an image in the Amazon Rekognition // Developer Guide. // // This operation requires permissions to perform the rekognition:RecognizeCelebrities @@ -5783,7 +5807,8 @@ func (c *Rekognition) RecognizeCelebritiesRequest(input *RecognizeCelebritiesInp // * ImageTooLargeException // The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, // the image size or resolution exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. // // * AccessDeniedException // You are not authorized to perform the action. @@ -5879,7 +5904,7 @@ func (c *Rekognition) SearchFacesRequest(input *SearchFacesInput) (req *request. // response also includes a confidence value for each face match, indicating // the confidence that the specific face matches the input face. // -// For an example, see Searching for a Face Using Its Face ID in the Amazon +// For an example, see Searching for a face using its face ID in the Amazon // Rekognition Developer Guide. // // This operation requires permissions to perform the rekognition:SearchFaces @@ -6039,7 +6064,8 @@ func (c *Rekognition) SearchFacesByImageRequest(input *SearchFacesByImageInput) // * ImageTooLargeException // The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, // the image size or resolution exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. // // * AccessDeniedException // You are not authorized to perform the action. @@ -6137,7 +6163,7 @@ func (c *Rekognition) StartCelebrityRecognitionRequest(input *StartCelebrityReco // GetCelebrityRecognition and pass the job identifier (JobId) from the initial // call to StartCelebrityRecognition. // -// For more information, see Recognizing Celebrities in the Amazon Rekognition +// For more information, see Recognizing celebrities in the Amazon Rekognition // Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -6263,7 +6289,7 @@ func (c *Rekognition) StartContentModerationRequest(input *StartContentModeratio // published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration // and pass the job identifier (JobId) from the initial call to StartContentModeration. // -// For more information, see Content moderation in the Amazon Rekognition Developer +// For more information, see Moderating content in the Amazon Rekognition Developer // Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -6386,7 +6412,7 @@ func (c *Rekognition) StartFaceDetectionRequest(input *StartFaceDetectionInput) // the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass // the job identifier (JobId) from the initial call to StartFaceDetection. // -// For more information, see Detecting Faces in a Stored Video in the Amazon +// For more information, see Detecting faces in a stored video in the Amazon // Rekognition Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -6508,7 +6534,8 @@ func (c *Rekognition) StartFaceSearchRequest(input *StartFaceSearchInput) (req * // you specify in NotificationChannel. To get the search results, first check // that the status value published to the Amazon SNS topic is SUCCEEDED. If // so, call GetFaceSearch and pass the job identifier (JobId) from the initial -// call to StartFaceSearch. For more information, see procedure-person-search-videos. +// call to StartFaceSearch. For more information, see Searching stored videos +// for faces (https://docs.aws.amazon.com/rekognition/latest/dg/procedure-person-search-videos.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7005,7 +7032,7 @@ func (c *Rekognition) StartSegmentDetectionRequest(input *StartSegmentDetectionI // GetSegmentDetection and pass the job identifier (JobId) from the initial // call to StartSegmentDetection. // -// For more information, see Detecting Video Segments in Stored Video in the +// For more information, see Detecting video segments in stored video in the // Amazon Rekognition Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -7111,7 +7138,6 @@ func (c *Rekognition) StartStreamProcessorRequest(input *StartStreamProcessorInp output = &StartStreamProcessorOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } @@ -7121,6 +7147,10 @@ func (c *Rekognition) StartStreamProcessorRequest(input *StartStreamProcessorInp // CreateStreamProcessor. To tell StartStreamProcessor which stream processor // to start, use the value of the Name field specified in the call to CreateStreamProcessor. // +// If you are using a label detection stream processor to detect labels, you +// need to provide a Start selector and a Stop selector to determine the length +// of the stream processing time. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7559,7 +7589,8 @@ func (c *Rekognition) TagResourceRequest(input *TagResourceInput) (req *request. // // * ServiceQuotaExceededException // The size of the collection exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. // // * AccessDeniedException // You are not authorized to perform the action. @@ -7826,6 +7857,102 @@ func (c *Rekognition) UpdateDatasetEntriesWithContext(ctx aws.Context, input *Up return out, req.Send() } +const opUpdateStreamProcessor = "UpdateStreamProcessor" + +// UpdateStreamProcessorRequest generates a "aws/request.Request" representing the +// client's request for the UpdateStreamProcessor operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateStreamProcessor for more information on using the UpdateStreamProcessor +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateStreamProcessorRequest method. +// req, resp := client.UpdateStreamProcessorRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +func (c *Rekognition) UpdateStreamProcessorRequest(input *UpdateStreamProcessorInput) (req *request.Request, output *UpdateStreamProcessorOutput) { + op := &request.Operation{ + Name: opUpdateStreamProcessor, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateStreamProcessorInput{} + } + + output = &UpdateStreamProcessorOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateStreamProcessor API operation for Amazon Rekognition. +// +// Allows you to update a stream processor. You can change some settings and +// regions of interest and delete certain parameters. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Rekognition's +// API operation UpdateStreamProcessor for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You are not authorized to perform the action. +// +// * InternalServerError +// Amazon Rekognition experienced a service issue. Try your call again. +// +// * ThrottlingException +// Amazon Rekognition is temporarily unable to process the request. Try your +// call again. +// +// * InvalidParameterException +// Input parameter violated a constraint. Validate your parameter before calling +// the API operation again. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ProvisionedThroughputExceededException +// The number of requests exceeded your throughput limit. If you want to increase +// this limit, contact Amazon Rekognition. +// +func (c *Rekognition) UpdateStreamProcessor(input *UpdateStreamProcessorInput) (*UpdateStreamProcessorOutput, error) { + req, out := c.UpdateStreamProcessorRequest(input) + return out, req.Send() +} + +// UpdateStreamProcessorWithContext is the same as UpdateStreamProcessor with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateStreamProcessor for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Rekognition) UpdateStreamProcessorWithContext(ctx aws.Context, input *UpdateStreamProcessorInput, opts ...request.Option) (*UpdateStreamProcessorOutput, error) { + req, out := c.UpdateStreamProcessorRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + // You are not authorized to perform the action. type AccessDeniedException struct { _ struct{} `type:"structure"` @@ -8150,10 +8277,10 @@ func (s *BlackFrame) SetMinCoveragePercentage(v float64) *BlackFrame { return s } -// Identifies the bounding box around the label, face, text or personal protective -// equipment. The left (x-coordinate) and top (y-coordinate) are coordinates -// representing the top and left sides of the bounding box. Note that the upper-left -// corner of the image is the origin (0,0). +// Identifies the bounding box around the label, face, text, object of interest, +// or personal protective equipment. The left (x-coordinate) and top (y-coordinate) +// are coordinates representing the top and left sides of the bounding box. +// Note that the upper-left corner of the image is the origin (0,0). // // The top and left values returned are ratios of the overall image size. For // example, if the input image is 700x200 pixels, and the top-left coordinate @@ -8827,6 +8954,133 @@ func (s *ComparedSourceImageFace) SetConfidence(v float64) *ComparedSourceImageF return s } +// Label detection settings to use on a streaming video. Defining the settings +// is required in the request parameter for CreateStreamProcessor. Including +// this setting in the CreateStreamProcessor request enables you to use the +// stream processor for label detection. You can then select what you want the +// stream processor to detect, such as people or pets. When the stream processor +// has started, one notification is sent for each object class specified. For +// example, if packages and pets are selected, one SNS notification is published +// the first time a package is detected and one SNS notification is published +// the first time a pet is detected, as well as an end-of-session summary. +type ConnectedHomeSettings struct { + _ struct{} `type:"structure"` + + // Specifies what you want to detect in the video, such as people, packages, + // or pets. The current valid labels you can include in this list are: "PERSON", + // "PET", "PACKAGE", and "ALL". + // + // Labels is a required field + Labels []*string `min:"1" type:"list" required:"true"` + + // The minimum confidence required to label an object in the video. + MinConfidence *float64 `type:"float"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConnectedHomeSettings) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConnectedHomeSettings) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ConnectedHomeSettings) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ConnectedHomeSettings"} + if s.Labels == nil { + invalidParams.Add(request.NewErrParamRequired("Labels")) + } + if s.Labels != nil && len(s.Labels) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Labels", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLabels sets the Labels field's value. +func (s *ConnectedHomeSettings) SetLabels(v []*string) *ConnectedHomeSettings { + s.Labels = v + return s +} + +// SetMinConfidence sets the MinConfidence field's value. +func (s *ConnectedHomeSettings) SetMinConfidence(v float64) *ConnectedHomeSettings { + s.MinConfidence = &v + return s +} + +// The label detection settings you want to use in your stream processor. This +// includes the labels you want the stream processor to detect and the minimum +// confidence level allowed to label objects. +type ConnectedHomeSettingsForUpdate struct { + _ struct{} `type:"structure"` + + // Specifies what you want to detect in the video, such as people, packages, + // or pets. The current valid labels you can include in this list are: "PERSON", + // "PET", "PACKAGE", and "ALL". + Labels []*string `min:"1" type:"list"` + + // The minimum confidence required to label an object in the video. + MinConfidence *float64 `type:"float"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConnectedHomeSettingsForUpdate) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConnectedHomeSettingsForUpdate) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ConnectedHomeSettingsForUpdate) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ConnectedHomeSettingsForUpdate"} + if s.Labels != nil && len(s.Labels) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Labels", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLabels sets the Labels field's value. +func (s *ConnectedHomeSettingsForUpdate) SetLabels(v []*string) *ConnectedHomeSettingsForUpdate { + s.Labels = v + return s +} + +// SetMinConfidence sets the MinConfidence field's value. +func (s *ConnectedHomeSettingsForUpdate) SetMinConfidence(v float64) *ConnectedHomeSettingsForUpdate { + s.MinConfidence = &v + return s +} + // Information about an inappropriate, unwanted, or offensive content label // detection in a stored video. type ContentModerationDetection struct { @@ -8977,8 +9231,8 @@ type CreateCollectionOutput struct { // permissions on your resources. CollectionArn *string `type:"string"` - // Latest face model being used with the collection. For more information, see - // Model versioning (https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html). + // Version number of the face detection model associated with the collection + // you are creating. FaceModelVersion *string `type:"string"` // HTTP status code indicating the result of the operation. @@ -9410,32 +9664,78 @@ func (s *CreateProjectVersionOutput) SetProjectVersionArn(v string) *CreateProje type CreateStreamProcessorInput struct { _ struct{} `type:"structure"` + // Shows whether you are sharing data with Rekognition to improve model performance. + // You can choose this option at the account level or on a per-stream basis. + // Note that if you opt out at the account level this setting is ignored on + // individual streams. + DataSharingPreference *StreamProcessorDataSharingPreference `type:"structure"` + // Kinesis video stream stream that provides the source streaming video. If - // you are using the AWS CLI, the parameter name is StreamProcessorInput. + // you are using the AWS CLI, the parameter name is StreamProcessorInput. This + // is required for both face search and label detection stream processors. // // Input is a required field Input *StreamProcessorInput `type:"structure" required:"true"` + // The identifier for your AWS Key Management Service key (AWS KMS key). This + // is an optional parameter for label detection stream processors and should + // not be used to create a face search stream processor. You can supply the + // Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias + // for your KMS key, or an alias ARN. The key is used to encrypt results and + // data published to your Amazon S3 bucket, which includes image frames and + // hero images. Your source images are unaffected. + KmsKeyId *string `min:"1" type:"string"` + // An identifier you assign to the stream processor. You can use Name to manage // the stream processor. For example, you can get the current status of the // stream processor by calling DescribeStreamProcessor. Name is idempotent. + // This is required for both face search and label detection stream processors. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` - // Kinesis data stream stream to which Amazon Rekognition Video puts the analysis - // results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput. + // The Amazon Simple Notification Service topic to which Amazon Rekognition + // publishes the object detection results and completion status of a video analysis + // operation. + // + // Amazon Rekognition publishes a notification the first time an object of interest + // or a person is detected in the video stream. For example, if Amazon Rekognition + // detects a person at second 2, a pet at second 4, and a person again at second + // 5, Amazon Rekognition sends 2 object class detected notifications, one for + // a person at second 2 and one for a pet at second 4. + // + // Amazon Rekognition also publishes an an end-of-session notification with + // a summary when the stream processing session is complete. + NotificationChannel *StreamProcessorNotificationChannel `type:"structure"` + + // Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition + // Video puts the analysis results. If you are using the AWS CLI, the parameter + // name is StreamProcessorOutput. This must be a S3Destination of an Amazon + // S3 bucket that you own for a label detection stream processor or a Kinesis + // data stream ARN for a face search stream processor. // // Output is a required field Output *StreamProcessorOutput `type:"structure" required:"true"` - // ARN of the IAM role that allows access to the stream processor. + // Specifies locations in the frames where Amazon Rekognition checks for objects + // or people. You can specify up to 10 regions of interest. This is an optional + // parameter for label detection stream processors and should not be used to + // create a face search stream processor. + RegionsOfInterest []*RegionOfInterest `type:"list"` + + // The Amazon Resource Number (ARN) of the IAM role that allows access to the + // stream processor. The IAM role provides Rekognition read permissions for + // a Kinesis stream. It also provides write permissions to an Amazon S3 bucket + // and Amazon Simple Notification Service topic for a label detection stream + // processor. This is required for both face search and label detection stream + // processors. // // RoleArn is a required field RoleArn *string `type:"string" required:"true"` - // Face recognition input parameters to be used by the stream processor. Includes - // the collection to use for face recognition and the face attributes to detect. + // Input parameters used in a streaming video analyzed by a stream processor. + // You can use FaceSearch to recognize faces in a streaming video, or you can + // use ConnectedHome to detect labels. // // Settings is a required field Settings *StreamProcessorSettings `type:"structure" required:"true"` @@ -9468,6 +9768,9 @@ func (s *CreateStreamProcessorInput) Validate() error { if s.Input == nil { invalidParams.Add(request.NewErrParamRequired("Input")) } + if s.KmsKeyId != nil && len(*s.KmsKeyId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KmsKeyId", 1)) + } if s.Name == nil { invalidParams.Add(request.NewErrParamRequired("Name")) } @@ -9483,6 +9786,21 @@ func (s *CreateStreamProcessorInput) Validate() error { if s.Settings == nil { invalidParams.Add(request.NewErrParamRequired("Settings")) } + if s.DataSharingPreference != nil { + if err := s.DataSharingPreference.Validate(); err != nil { + invalidParams.AddNested("DataSharingPreference", err.(request.ErrInvalidParams)) + } + } + if s.NotificationChannel != nil { + if err := s.NotificationChannel.Validate(); err != nil { + invalidParams.AddNested("NotificationChannel", err.(request.ErrInvalidParams)) + } + } + if s.Output != nil { + if err := s.Output.Validate(); err != nil { + invalidParams.AddNested("Output", err.(request.ErrInvalidParams)) + } + } if s.Settings != nil { if err := s.Settings.Validate(); err != nil { invalidParams.AddNested("Settings", err.(request.ErrInvalidParams)) @@ -9495,24 +9813,48 @@ func (s *CreateStreamProcessorInput) Validate() error { return nil } +// SetDataSharingPreference sets the DataSharingPreference field's value. +func (s *CreateStreamProcessorInput) SetDataSharingPreference(v *StreamProcessorDataSharingPreference) *CreateStreamProcessorInput { + s.DataSharingPreference = v + return s +} + // SetInput sets the Input field's value. func (s *CreateStreamProcessorInput) SetInput(v *StreamProcessorInput) *CreateStreamProcessorInput { s.Input = v return s } +// SetKmsKeyId sets the KmsKeyId field's value. +func (s *CreateStreamProcessorInput) SetKmsKeyId(v string) *CreateStreamProcessorInput { + s.KmsKeyId = &v + return s +} + // SetName sets the Name field's value. func (s *CreateStreamProcessorInput) SetName(v string) *CreateStreamProcessorInput { s.Name = &v return s } +// SetNotificationChannel sets the NotificationChannel field's value. +func (s *CreateStreamProcessorInput) SetNotificationChannel(v *StreamProcessorNotificationChannel) *CreateStreamProcessorInput { + s.NotificationChannel = v + return s +} + // SetOutput sets the Output field's value. func (s *CreateStreamProcessorInput) SetOutput(v *StreamProcessorOutput) *CreateStreamProcessorInput { s.Output = v return s } +// SetRegionsOfInterest sets the RegionsOfInterest field's value. +func (s *CreateStreamProcessorInput) SetRegionsOfInterest(v []*RegionOfInterest) *CreateStreamProcessorInput { + s.RegionsOfInterest = v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *CreateStreamProcessorInput) SetRoleArn(v string) *CreateStreamProcessorInput { s.RoleArn = &v @@ -9534,7 +9876,7 @@ func (s *CreateStreamProcessorInput) SetTags(v map[string]*string) *CreateStream type CreateStreamProcessorOutput struct { _ struct{} `type:"structure"` - // ARN for the newly create stream processor. + // Amazon Resource Number for the newly created stream processor. StreamProcessorArn *string `type:"string"` } @@ -10597,7 +10939,7 @@ type DescribeCollectionOutput struct { // The version of the face model that's used by the collection for face detection. // - // For more information, see Model Versioning in the Amazon Rekognition Developer + // For more information, see Model versioning in the Amazon Rekognition Developer // Guide. FaceModelVersion *string `type:"string"` } @@ -11031,9 +11373,19 @@ type DescribeStreamProcessorOutput struct { // Date and time the stream processor was created CreationTimestamp *time.Time `type:"timestamp"` + // Shows whether you are sharing data with Rekognition to improve model performance. + // You can choose this option at the account level or on a per-stream basis. + // Note that if you opt out at the account level this setting is ignored on + // individual streams. + DataSharingPreference *StreamProcessorDataSharingPreference `type:"structure"` + // Kinesis video stream that provides the source streaming video. Input *StreamProcessorInput `type:"structure"` + // The identifier for your AWS Key Management Service key (AWS KMS key). This + // is an optional parameter for label detection stream processors. + KmsKeyId *string `min:"1" type:"string"` + // The time, in Unix format, the stream processor was last updated. For example, // when the stream processor moves from a running state to a failed state, or // when the user starts or stops the stream processor. @@ -11042,15 +11394,33 @@ type DescribeStreamProcessorOutput struct { // Name of the stream processor. Name *string `min:"1" type:"string"` + // The Amazon Simple Notification Service topic to which Amazon Rekognition + // publishes the object detection results and completion status of a video analysis + // operation. + // + // Amazon Rekognition publishes a notification the first time an object of interest + // or a person is detected in the video stream. For example, if Amazon Rekognition + // detects a person at second 2, a pet at second 4, and a person again at second + // 5, Amazon Rekognition sends 2 object class detected notifications, one for + // a person at second 2 and one for a pet at second 4. + // + // Amazon Rekognition also publishes an an end-of-session notification with + // a summary when the stream processing session is complete. + NotificationChannel *StreamProcessorNotificationChannel `type:"structure"` + // Kinesis data stream to which Amazon Rekognition Video puts the analysis results. Output *StreamProcessorOutput `type:"structure"` + // Specifies locations in the frames where Amazon Rekognition checks for objects + // or people. This is an optional parameter for label detection stream processors. + RegionsOfInterest []*RegionOfInterest `type:"list"` + // ARN of the IAM role that allows access to the stream processor. RoleArn *string `type:"string"` - // Face recognition input parameters that are being used by the stream processor. - // Includes the collection to use for face recognition and the face attributes - // to detect. + // Input parameters used in a streaming video analyzed by a stream processor. + // You can use FaceSearch to recognize faces in a streaming video, or you can + // use ConnectedHome to detect labels. Settings *StreamProcessorSettings `type:"structure"` // Current status of the stream processor. @@ -11087,12 +11457,24 @@ func (s *DescribeStreamProcessorOutput) SetCreationTimestamp(v time.Time) *Descr return s } +// SetDataSharingPreference sets the DataSharingPreference field's value. +func (s *DescribeStreamProcessorOutput) SetDataSharingPreference(v *StreamProcessorDataSharingPreference) *DescribeStreamProcessorOutput { + s.DataSharingPreference = v + return s +} + // SetInput sets the Input field's value. func (s *DescribeStreamProcessorOutput) SetInput(v *StreamProcessorInput) *DescribeStreamProcessorOutput { s.Input = v return s } +// SetKmsKeyId sets the KmsKeyId field's value. +func (s *DescribeStreamProcessorOutput) SetKmsKeyId(v string) *DescribeStreamProcessorOutput { + s.KmsKeyId = &v + return s +} + // SetLastUpdateTimestamp sets the LastUpdateTimestamp field's value. func (s *DescribeStreamProcessorOutput) SetLastUpdateTimestamp(v time.Time) *DescribeStreamProcessorOutput { s.LastUpdateTimestamp = &v @@ -11105,12 +11487,24 @@ func (s *DescribeStreamProcessorOutput) SetName(v string) *DescribeStreamProcess return s } +// SetNotificationChannel sets the NotificationChannel field's value. +func (s *DescribeStreamProcessorOutput) SetNotificationChannel(v *StreamProcessorNotificationChannel) *DescribeStreamProcessorOutput { + s.NotificationChannel = v + return s +} + // SetOutput sets the Output field's value. func (s *DescribeStreamProcessorOutput) SetOutput(v *StreamProcessorOutput) *DescribeStreamProcessorOutput { s.Output = v return s } +// SetRegionsOfInterest sets the RegionsOfInterest field's value. +func (s *DescribeStreamProcessorOutput) SetRegionsOfInterest(v []*RegionOfInterest) *DescribeStreamProcessorOutput { + s.RegionsOfInterest = v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *DescribeStreamProcessorOutput) SetRoleArn(v string) *DescribeStreamProcessorOutput { s.RoleArn = &v @@ -11168,8 +11562,8 @@ type DetectCustomLabelsInput struct { // property. // // For Amazon Rekognition to process an S3 object, the user must have permission - // to access the S3 object. For more information, see Resource Based Policies - // in the Amazon Rekognition Developer Guide. + // to access the S3 object. For more information, see How Amazon Rekognition + // works with IAM in the Amazon Rekognition Developer Guide. // // Image is a required field Image *Image `type:"structure" required:"true"` @@ -11980,8 +12374,8 @@ type DetectionFilter struct { MinBoundingBoxWidth *float64 `type:"float"` // Sets the confidence of word detection. Words with detection confidence below - // this will be excluded from the result. Values should be between 50 and 100 - // as Text in Video will not return any result below 50. + // this will be excluded from the result. Values should be between 0 and 100. + // The default MinConfidence is 80. MinConfidence *float64 `type:"float"` } @@ -12791,7 +13185,9 @@ func (s *FaceRecord) SetFaceDetail(v *FaceDetail) *FaceRecord { } // Input face recognition parameters for an Amazon Rekognition stream processor. -// FaceRecognitionSettings is a request parameter for CreateStreamProcessor. +// Includes the collection to use for face recognition and the face attributes +// to detect. Defining the settings is required in the request parameter for +// CreateStreamProcessor. type FaceSearchSettings struct { _ struct{} `type:"structure"` @@ -14341,8 +14737,8 @@ type GroundTruthManifest struct { // you use for Amazon Rekognition operations. // // For Amazon Rekognition to process an S3 object, the user must have permission - // to access the S3 object. For more information, see Resource-Based Policies - // in the Amazon Rekognition Developer Guide. + // to access the S3 object. For more information, see How Amazon Rekognition + // works with IAM in the Amazon Rekognition Developer Guide. S3Object *S3Object `type:"structure"` } @@ -14711,8 +15107,8 @@ func (s *IdempotentParameterMismatchException) RequestID() string { // property. // // For Amazon Rekognition to process an S3 object, the user must have permission -// to access the S3 object. For more information, see Resource Based Policies -// in the Amazon Rekognition Developer Guide. +// to access the S3 object. For more information, see How Amazon Rekognition +// works with IAM in the Amazon Rekognition Developer Guide. type Image struct { _ struct{} `type:"structure"` @@ -14817,7 +15213,8 @@ func (s *ImageQuality) SetSharpness(v float64) *ImageQuality { // The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, // the image size or resolution exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. type ImageTooLargeException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -15034,8 +15431,8 @@ func (s *IndexFacesInput) SetQualityFilter(v string) *IndexFacesInput { type IndexFacesOutput struct { _ struct{} `type:"structure"` - // Latest face model being used with the collection. For more information, see - // Model versioning (https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html). + // The version number of the face detection model that's associated with the + // input collection (CollectionId). FaceModelVersion *string `type:"string"` // An array of faces detected and added to the collection. For more information, @@ -15548,13 +15945,18 @@ func (s *KinesisVideoStream) SetArn(v string) *KinesisVideoStream { return s } -// The known gender identity for the celebrity that matches the provided ID. -// The known gender identity can be Male, Female, Nonbinary, or Unlisted. -type KnownGender struct { +// Specifies the starting point in a Kinesis stream to start processing. You +// can use the producer timestamp or the fragment number. For more information, +// see Fragment (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html). +type KinesisVideoStreamStartSelector struct { _ struct{} `type:"structure"` - // A string value of the KnownGender info about the Celebrity. - Type *string `type:"string" enum:"KnownGenderType"` + // The unique identifier of the fragment. This value monotonically increases + // based on the ingestion order. + FragmentNumber *string `min:"1" type:"string"` + + // The timestamp from the producer corresponding to the fragment. + ProducerTimestamp *int64 `type:"long"` } // String returns the string representation. @@ -15562,7 +15964,7 @@ type KnownGender struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s KnownGender) String() string { +func (s KinesisVideoStreamStartSelector) String() string { return awsutil.Prettify(s) } @@ -15571,18 +15973,70 @@ func (s KnownGender) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s KnownGender) GoString() string { +func (s KinesisVideoStreamStartSelector) GoString() string { return s.String() } -// SetType sets the Type field's value. -func (s *KnownGender) SetType(v string) *KnownGender { - s.Type = &v +// Validate inspects the fields of the type to determine if they are valid. +func (s *KinesisVideoStreamStartSelector) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "KinesisVideoStreamStartSelector"} + if s.FragmentNumber != nil && len(*s.FragmentNumber) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FragmentNumber", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFragmentNumber sets the FragmentNumber field's value. +func (s *KinesisVideoStreamStartSelector) SetFragmentNumber(v string) *KinesisVideoStreamStartSelector { + s.FragmentNumber = &v return s } -// Structure containing details about the detected label, including the name, -// detected instances, parent labels, and level of confidence. +// SetProducerTimestamp sets the ProducerTimestamp field's value. +func (s *KinesisVideoStreamStartSelector) SetProducerTimestamp(v int64) *KinesisVideoStreamStartSelector { + s.ProducerTimestamp = &v + return s +} + +// The known gender identity for the celebrity that matches the provided ID. +// The known gender identity can be Male, Female, Nonbinary, or Unlisted. +type KnownGender struct { + _ struct{} `type:"structure"` + + // A string value of the KnownGender info about the Celebrity. + Type *string `type:"string" enum:"KnownGenderType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KnownGender) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KnownGender) GoString() string { + return s.String() +} + +// SetType sets the Type field's value. +func (s *KnownGender) SetType(v string) *KnownGender { + s.Type = &v + return s +} + +// Structure containing details about the detected label, including the name, +// detected instances, parent labels, and level of confidence. type Label struct { _ struct{} `type:"structure"` @@ -15855,10 +16309,10 @@ type ListCollectionsOutput struct { // An array of collection IDs. CollectionIds []*string `type:"list"` - // Latest face models being used with the corresponding collections in the array. - // For more information, see Model versioning (https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html). - // For example, the value of FaceModelVersions[2] is the version number for - // the face detection model used by the collection in CollectionId[2]. + // Version numbers of the face detection models associated with the collections + // in the array CollectionIds. For example, the value of FaceModelVersions[2] + // is the version number for the face detection model used by the collection + // in CollectionId[2]. FaceModelVersions []*string `type:"list"` // If the result is truncated, the response provides a NextToken that you can @@ -16261,8 +16715,8 @@ func (s *ListFacesInput) SetNextToken(v string) *ListFacesInput { type ListFacesOutput struct { _ struct{} `type:"structure"` - // Latest face model being used with the collection. For more information, see - // Model versioning (https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html). + // Version number of the face detection model associated with the input collection + // (CollectionId). FaceModelVersion *string `type:"string"` // An array of Face objects. @@ -16634,10 +17088,11 @@ func (s *Mustache) SetValue(v bool) *Mustache { // The Amazon Simple Notification Service topic to which Amazon Rekognition // publishes the completion status of a video analysis operation. For more information, -// see api-video. Note that the Amazon SNS topic must have a topic name that -// begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole -// permissions policy to access the topic. For more information, see Giving -// access to multiple Amazon SNS topics (https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics). +// see Calling Amazon Rekognition Video operations (https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html). +// Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition +// if you are using the AmazonRekognitionServiceRole permissions policy to access +// the topic. For more information, see Giving access to multiple Amazon SNS +// topics (https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics). type NotificationChannel struct { _ struct{} `type:"structure"` @@ -16647,8 +17102,7 @@ type NotificationChannel struct { // RoleArn is a required field RoleArn *string `type:"string" required:"true"` - // The Amazon SNS topic to which Amazon Rekognition to posts the completion - // status. + // The Amazon SNS topic to which Amazon Rekognition posts the completion status. // // SNSTopicArn is a required field SNSTopicArn *string `type:"string" required:"true"` @@ -16942,14 +17396,15 @@ func (s *PersonMatch) SetTimestamp(v int64) *PersonMatch { return s } -// The X and Y coordinates of a point on an image. The X and Y values returned -// are ratios of the overall image size. For example, if the input image is -// 700x200 and the operation returns X=0.5 and Y=0.25, then the point is at -// the (350,50) pixel coordinate on the image. +// The X and Y coordinates of a point on an image or video frame. The X and +// Y values are ratios of the overall image size or video resolution. For example, +// if an input image is 700x200 and the values are X=0.5 and Y=0.25, then the +// point is at the (350,50) pixel coordinate on the image. // -// An array of Point objects, Polygon, is returned by DetectText and by DetectCustomLabels. -// Polygon represents a fine-grained polygon around a detected item. For more -// information, see Geometry in the Amazon Rekognition Developer Guide. +// An array of Point objects makes up a Polygon. A Polygon is returned by DetectText +// and by DetectCustomLabels Polygon represents a fine-grained polygon around +// a detected item. For more information, see Geometry in the Amazon Rekognition +// Developer Guide. type Point struct { _ struct{} `type:"structure"` @@ -17698,17 +18153,23 @@ func (s *RecognizeCelebritiesOutput) SetUnrecognizedFaces(v []*ComparedFace) *Re return s } -// Specifies a location within the frame that Rekognition checks for text. Uses -// a BoundingBox object to set a region of the screen. +// Specifies a location within the frame that Rekognition checks for objects +// of interest such as text, labels, or faces. It uses a BoundingBox or object +// or Polygon to set a region of the screen. // -// A word is included in the region if the word is more than half in that region. -// If there is more than one region, the word will be compared with all regions -// of the screen. Any word more than half in a region is kept in the results. +// A word, face, or label is included in the region if it is more than half +// in that region. If there is more than one region, the word, face, or label +// is compared with all regions of the screen. Any object of interest that is +// more than half in a region is kept in the results. type RegionOfInterest struct { _ struct{} `type:"structure"` // The box representing a region of interest on screen. BoundingBox *BoundingBox `type:"structure"` + + // Specifies a shape made up of up to 10 Point objects to define a region of + // interest. + Polygon []*Point `type:"list"` } // String returns the string representation. @@ -17735,6 +18196,12 @@ func (s *RegionOfInterest) SetBoundingBox(v *BoundingBox) *RegionOfInterest { return s } +// SetPolygon sets the Polygon field's value. +func (s *RegionOfInterest) SetPolygon(v []*Point) *RegionOfInterest { + s.Polygon = v + return s +} + // A resource with the specified ID already exists. type ResourceAlreadyExistsException struct { _ struct{} `type:"structure"` @@ -17992,14 +18459,73 @@ func (s *ResourceNotReadyException) RequestID() string { return s.RespMetadata.RequestID } +// The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed +// inference results of a video analysis operation. These results include the +// name of the stream processor resource, the session ID of the stream processing +// session, and labeled timestamps and bounding boxes for detected labels. +type S3Destination struct { + _ struct{} `type:"structure"` + + // The name of the Amazon S3 bucket you want to associate with the streaming + // video project. You must be the owner of the Amazon S3 bucket. + Bucket *string `min:"3" type:"string"` + + // The prefix value of the location within the bucket that you want the information + // to be published to. For more information, see Using prefixes (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html). + KeyPrefix *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3Destination) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s S3Destination) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *S3Destination) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "S3Destination"} + if s.Bucket != nil && len(*s.Bucket) < 3 { + invalidParams.Add(request.NewErrParamMinLen("Bucket", 3)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBucket sets the Bucket field's value. +func (s *S3Destination) SetBucket(v string) *S3Destination { + s.Bucket = &v + return s +} + +// SetKeyPrefix sets the KeyPrefix field's value. +func (s *S3Destination) SetKeyPrefix(v string) *S3Destination { + s.KeyPrefix = &v + return s +} + // Provides the S3 bucket name and object name. // // The region for the S3 bucket containing the S3 object must match the region // you use for Amazon Rekognition operations. // // For Amazon Rekognition to process an S3 object, the user must have permission -// to access the S3 object. For more information, see Resource-Based Policies -// in the Amazon Rekognition Developer Guide. +// to access the S3 object. For more information, see How Amazon Rekognition +// works with IAM in the Amazon Rekognition Developer Guide. type S3Object struct { _ struct{} `type:"structure"` @@ -18193,8 +18719,8 @@ type SearchFacesByImageOutput struct { // the match. FaceMatches []*FaceMatch `type:"list"` - // Latest face model being used with the collection. For more information, see - // Model versioning (https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html). + // Version number of the face detection model associated with the input collection + // (CollectionId). FaceModelVersion *string `type:"string"` // The bounding box around the face in the input image that Amazon Rekognition @@ -18341,8 +18867,8 @@ type SearchFacesOutput struct { // in the match. FaceMatches []*FaceMatch `type:"list"` - // Latest face model being used with the collection. For more information, see - // Model versioning (https://docs.aws.amazon.com/rekognition/latest/dg/face-detection-model.html). + // Version number of the face detection model associated with the input collection + // (CollectionId). FaceModelVersion *string `type:"string"` // ID of the face that was searched for matches in a collection. @@ -18572,7 +19098,8 @@ func (s *SegmentTypeInfo) SetType(v string) *SegmentTypeInfo { } // The size of the collection exceeds the allowed limit. For more information, -// see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. +// see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition +// Developer Guide. type ServiceQuotaExceededException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -19966,6 +20493,21 @@ type StartStreamProcessorInput struct { // // Name is a required field Name *string `min:"1" type:"string" required:"true"` + + // Specifies the starting point in the Kinesis stream to start processing. You + // can use the producer timestamp or the fragment number. For more information, + // see Fragment (https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html). + // + // This is a required parameter for label detection stream processors and should + // not be used to start a face search stream processor. + StartSelector *StreamProcessingStartSelector `type:"structure"` + + // Specifies when to stop processing the stream. You can specify a maximum amount + // of time to process the video. + // + // This is a required parameter for label detection stream processors and should + // not be used to start a face search stream processor. + StopSelector *StreamProcessingStopSelector `type:"structure"` } // String returns the string representation. @@ -19995,6 +20537,16 @@ func (s *StartStreamProcessorInput) Validate() error { if s.Name != nil && len(*s.Name) < 1 { invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } + if s.StartSelector != nil { + if err := s.StartSelector.Validate(); err != nil { + invalidParams.AddNested("StartSelector", err.(request.ErrInvalidParams)) + } + } + if s.StopSelector != nil { + if err := s.StopSelector.Validate(); err != nil { + invalidParams.AddNested("StopSelector", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -20008,8 +20560,23 @@ func (s *StartStreamProcessorInput) SetName(v string) *StartStreamProcessorInput return s } +// SetStartSelector sets the StartSelector field's value. +func (s *StartStreamProcessorInput) SetStartSelector(v *StreamProcessingStartSelector) *StartStreamProcessorInput { + s.StartSelector = v + return s +} + +// SetStopSelector sets the StopSelector field's value. +func (s *StartStreamProcessorInput) SetStopSelector(v *StreamProcessingStopSelector) *StartStreamProcessorInput { + s.StopSelector = v + return s +} + type StartStreamProcessorOutput struct { _ struct{} `type:"structure"` + + // A unique identifier for the stream processing session. + SessionId *string `type:"string"` } // String returns the string representation. @@ -20030,6 +20597,12 @@ func (s StartStreamProcessorOutput) GoString() string { return s.String() } +// SetSessionId sets the SessionId field's value. +func (s *StartStreamProcessorOutput) SetSessionId(v string) *StartStreamProcessorOutput { + s.SessionId = &v + return s +} + // Filters for the technical segments returned by GetSegmentDetection. For more // information, see StartSegmentDetectionFilters. type StartTechnicalCueDetectionFilter struct { @@ -20160,10 +20733,11 @@ type StartTextDetectionInput struct { // The Amazon Simple Notification Service topic to which Amazon Rekognition // publishes the completion status of a video analysis operation. For more information, - // see api-video. Note that the Amazon SNS topic must have a topic name that - // begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole - // permissions policy to access the topic. For more information, see Giving - // access to multiple Amazon SNS topics (https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics). + // see Calling Amazon Rekognition Video operations (https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html). + // Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition + // if you are using the AmazonRekognitionServiceRole permissions policy to access + // the topic. For more information, see Giving access to multiple Amazon SNS + // topics (https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics). NotificationChannel *NotificationChannel `type:"structure"` // Video file stored in an Amazon S3 bucket. Amazon Rekognition video start @@ -20437,11 +21011,106 @@ func (s StopStreamProcessorOutput) GoString() string { return s.String() } -// An object that recognizes faces in a streaming video. An Amazon Rekognition -// stream processor is created by a call to CreateStreamProcessor. The request -// parameters for CreateStreamProcessor describe the Kinesis video stream source -// for the streaming video, face recognition parameters, and where to stream -// the analysis resullts. +type StreamProcessingStartSelector struct { + _ struct{} `type:"structure"` + + // Specifies the starting point in the stream to start processing. This can + // be done with a timestamp or a fragment number in a Kinesis stream. + KVSStreamStartSelector *KinesisVideoStreamStartSelector `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamProcessingStartSelector) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamProcessingStartSelector) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StreamProcessingStartSelector) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StreamProcessingStartSelector"} + if s.KVSStreamStartSelector != nil { + if err := s.KVSStreamStartSelector.Validate(); err != nil { + invalidParams.AddNested("KVSStreamStartSelector", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKVSStreamStartSelector sets the KVSStreamStartSelector field's value. +func (s *StreamProcessingStartSelector) SetKVSStreamStartSelector(v *KinesisVideoStreamStartSelector) *StreamProcessingStartSelector { + s.KVSStreamStartSelector = v + return s +} + +// Specifies when to stop processing the stream. You can specify a maximum amount +// of time to process the video. +type StreamProcessingStopSelector struct { + _ struct{} `type:"structure"` + + // Specifies the maximum amount of time in seconds that you want the stream + // to be processed. The largest amount of time is 2 minutes. The default is + // 10 seconds. + MaxDurationInSeconds *int64 `min:"1" type:"long"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamProcessingStopSelector) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamProcessingStopSelector) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StreamProcessingStopSelector) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StreamProcessingStopSelector"} + if s.MaxDurationInSeconds != nil && *s.MaxDurationInSeconds < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxDurationInSeconds", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxDurationInSeconds sets the MaxDurationInSeconds field's value. +func (s *StreamProcessingStopSelector) SetMaxDurationInSeconds(v int64) *StreamProcessingStopSelector { + s.MaxDurationInSeconds = &v + return s +} + +// An object that recognizes faces or labels in a streaming video. An Amazon +// Rekognition stream processor is created by a call to CreateStreamProcessor. +// The request parameters for CreateStreamProcessor describe the Kinesis video +// stream source for the streaming video, face recognition parameters, and where +// to stream the analysis resullts. type StreamProcessor struct { _ struct{} `type:"structure"` @@ -20482,6 +21151,57 @@ func (s *StreamProcessor) SetStatus(v string) *StreamProcessor { return s } +// Allows you to opt in or opt out to share data with Rekognition to improve +// model performance. You can choose this option at the account level or on +// a per-stream basis. Note that if you opt out at the account level this setting +// is ignored on individual streams. +type StreamProcessorDataSharingPreference struct { + _ struct{} `type:"structure"` + + // If this option is set to true, you choose to share data with Rekognition + // to improve model performance. + // + // OptIn is a required field + OptIn *bool `type:"boolean" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamProcessorDataSharingPreference) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamProcessorDataSharingPreference) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StreamProcessorDataSharingPreference) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StreamProcessorDataSharingPreference"} + if s.OptIn == nil { + invalidParams.Add(request.NewErrParamRequired("OptIn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetOptIn sets the OptIn field's value. +func (s *StreamProcessorDataSharingPreference) SetOptIn(v bool) *StreamProcessorDataSharingPreference { + s.OptIn = &v + return s +} + // Information about the source streaming video. type StreamProcessorInput struct { _ struct{} `type:"structure"` @@ -20514,6 +21234,65 @@ func (s *StreamProcessorInput) SetKinesisVideoStream(v *KinesisVideoStream) *Str return s } +// The Amazon Simple Notification Service topic to which Amazon Rekognition +// publishes the object detection results and completion status of a video analysis +// operation. +// +// Amazon Rekognition publishes a notification the first time an object of interest +// or a person is detected in the video stream. For example, if Amazon Rekognition +// detects a person at second 2, a pet at second 4, and a person again at second +// 5, Amazon Rekognition sends 2 object class detected notifications, one for +// a person at second 2 and one for a pet at second 4. +// +// Amazon Rekognition also publishes an an end-of-session notification with +// a summary when the stream processing session is complete. +type StreamProcessorNotificationChannel struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Number (ARN) of the Amazon Amazon Simple Notification + // Service topic to which Amazon Rekognition posts the completion status. + // + // SNSTopicArn is a required field + SNSTopicArn *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamProcessorNotificationChannel) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamProcessorNotificationChannel) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StreamProcessorNotificationChannel) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StreamProcessorNotificationChannel"} + if s.SNSTopicArn == nil { + invalidParams.Add(request.NewErrParamRequired("SNSTopicArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetSNSTopicArn sets the SNSTopicArn field's value. +func (s *StreamProcessorNotificationChannel) SetSNSTopicArn(v string) *StreamProcessorNotificationChannel { + s.SNSTopicArn = &v + return s +} + // Information about the Amazon Kinesis Data Streams stream to which a Amazon // Rekognition Video stream processor streams the results of a video analysis. // For more information, see CreateStreamProcessor in the Amazon Rekognition @@ -20524,6 +21303,10 @@ type StreamProcessorOutput struct { // The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream // processor streams the analysis results. KinesisDataStream *KinesisDataStream `type:"structure"` + + // The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed + // inference results of a video analysis operation. + S3Destination *S3Destination `type:"structure"` } // String returns the string representation. @@ -20544,17 +21327,50 @@ func (s StreamProcessorOutput) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *StreamProcessorOutput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StreamProcessorOutput"} + if s.S3Destination != nil { + if err := s.S3Destination.Validate(); err != nil { + invalidParams.AddNested("S3Destination", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetKinesisDataStream sets the KinesisDataStream field's value. func (s *StreamProcessorOutput) SetKinesisDataStream(v *KinesisDataStream) *StreamProcessorOutput { s.KinesisDataStream = v return s } -// Input parameters used to recognize faces in a streaming video analyzed by -// a Amazon Rekognition stream processor. +// SetS3Destination sets the S3Destination field's value. +func (s *StreamProcessorOutput) SetS3Destination(v *S3Destination) *StreamProcessorOutput { + s.S3Destination = v + return s +} + +// Input parameters used in a streaming video analyzed by a Amazon Rekognition +// stream processor. You can use FaceSearch to recognize faces in a streaming +// video, or you can use ConnectedHome to detect labels. type StreamProcessorSettings struct { _ struct{} `type:"structure"` + // Label detection settings to use on a streaming video. Defining the settings + // is required in the request parameter for CreateStreamProcessor. Including + // this setting in the CreateStreamProcessor request enables you to use the + // stream processor for label detection. You can then select what you want the + // stream processor to detect, such as people or pets. When the stream processor + // has started, one notification is sent for each object class specified. For + // example, if packages and pets are selected, one SNS notification is published + // the first time a package is detected and one SNS notification is published + // the first time a pet is detected, as well as an end-of-session summary. + ConnectedHome *ConnectedHomeSettings `type:"structure"` + // Face search settings to use on a streaming video. FaceSearch *FaceSearchSettings `type:"structure"` } @@ -20580,6 +21396,11 @@ func (s StreamProcessorSettings) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *StreamProcessorSettings) Validate() error { invalidParams := request.ErrInvalidParams{Context: "StreamProcessorSettings"} + if s.ConnectedHome != nil { + if err := s.ConnectedHome.Validate(); err != nil { + invalidParams.AddNested("ConnectedHome", err.(request.ErrInvalidParams)) + } + } if s.FaceSearch != nil { if err := s.FaceSearch.Validate(); err != nil { invalidParams.AddNested("FaceSearch", err.(request.ErrInvalidParams)) @@ -20592,12 +21413,66 @@ func (s *StreamProcessorSettings) Validate() error { return nil } +// SetConnectedHome sets the ConnectedHome field's value. +func (s *StreamProcessorSettings) SetConnectedHome(v *ConnectedHomeSettings) *StreamProcessorSettings { + s.ConnectedHome = v + return s +} + // SetFaceSearch sets the FaceSearch field's value. func (s *StreamProcessorSettings) SetFaceSearch(v *FaceSearchSettings) *StreamProcessorSettings { s.FaceSearch = v return s } +// The stream processor settings that you want to update. ConnectedHome settings +// can be updated to detect different labels with a different minimum confidence. +type StreamProcessorSettingsForUpdate struct { + _ struct{} `type:"structure"` + + // The label detection settings you want to use for your stream processor. + ConnectedHomeForUpdate *ConnectedHomeSettingsForUpdate `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamProcessorSettingsForUpdate) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamProcessorSettingsForUpdate) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StreamProcessorSettingsForUpdate) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StreamProcessorSettingsForUpdate"} + if s.ConnectedHomeForUpdate != nil { + if err := s.ConnectedHomeForUpdate.Validate(); err != nil { + invalidParams.AddNested("ConnectedHomeForUpdate", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetConnectedHomeForUpdate sets the ConnectedHomeForUpdate field's value. +func (s *StreamProcessorSettingsForUpdate) SetConnectedHomeForUpdate(v *ConnectedHomeSettingsForUpdate) *StreamProcessorSettingsForUpdate { + s.ConnectedHomeForUpdate = v + return s +} + // The S3 bucket that contains the training summary. The training summary includes // aggregated evaluation metrics for the entire testing dataset and metrics // for each individual label. @@ -20612,8 +21487,8 @@ type Summary struct { // you use for Amazon Rekognition operations. // // For Amazon Rekognition to process an S3 object, the user must have permission - // to access the S3 object. For more information, see Resource-Based Policies - // in the Amazon Rekognition Developer Guide. + // to access the S3 object. For more information, see How Amazon Rekognition + // works with IAM in the Amazon Rekognition Developer Guide. S3Object *S3Object `type:"structure"` } @@ -20940,7 +21815,7 @@ func (s *TestingDataResult) SetValidation(v *ValidationData) *TestingDataResult // the word appears. The word Id is also an index for the word within a line // of words. // -// For more information, see Detecting Text in the Amazon Rekognition Developer +// For more information, see Detecting text in the Amazon Rekognition Developer // Guide. type TextDetection struct { _ struct{} `type:"structure"` @@ -21470,6 +22345,128 @@ func (s UpdateDatasetEntriesOutput) GoString() string { return s.String() } +type UpdateStreamProcessorInput struct { + _ struct{} `type:"structure"` + + // Shows whether you are sharing data with Rekognition to improve model performance. + // You can choose this option at the account level or on a per-stream basis. + // Note that if you opt out at the account level this setting is ignored on + // individual streams. + DataSharingPreferenceForUpdate *StreamProcessorDataSharingPreference `type:"structure"` + + // Name of the stream processor that you want to update. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // A list of parameters you want to delete from the stream processor. + ParametersToDelete []*string `type:"list" enum:"StreamProcessorParameterToDelete"` + + // Specifies locations in the frames where Amazon Rekognition checks for objects + // or people. This is an optional parameter for label detection stream processors. + RegionsOfInterestForUpdate []*RegionOfInterest `type:"list"` + + // The stream processor settings that you want to update. Label detection settings + // can be updated to detect different labels with a different minimum confidence. + SettingsForUpdate *StreamProcessorSettingsForUpdate `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateStreamProcessorInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateStreamProcessorInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateStreamProcessorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateStreamProcessorInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.DataSharingPreferenceForUpdate != nil { + if err := s.DataSharingPreferenceForUpdate.Validate(); err != nil { + invalidParams.AddNested("DataSharingPreferenceForUpdate", err.(request.ErrInvalidParams)) + } + } + if s.SettingsForUpdate != nil { + if err := s.SettingsForUpdate.Validate(); err != nil { + invalidParams.AddNested("SettingsForUpdate", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDataSharingPreferenceForUpdate sets the DataSharingPreferenceForUpdate field's value. +func (s *UpdateStreamProcessorInput) SetDataSharingPreferenceForUpdate(v *StreamProcessorDataSharingPreference) *UpdateStreamProcessorInput { + s.DataSharingPreferenceForUpdate = v + return s +} + +// SetName sets the Name field's value. +func (s *UpdateStreamProcessorInput) SetName(v string) *UpdateStreamProcessorInput { + s.Name = &v + return s +} + +// SetParametersToDelete sets the ParametersToDelete field's value. +func (s *UpdateStreamProcessorInput) SetParametersToDelete(v []*string) *UpdateStreamProcessorInput { + s.ParametersToDelete = v + return s +} + +// SetRegionsOfInterestForUpdate sets the RegionsOfInterestForUpdate field's value. +func (s *UpdateStreamProcessorInput) SetRegionsOfInterestForUpdate(v []*RegionOfInterest) *UpdateStreamProcessorInput { + s.RegionsOfInterestForUpdate = v + return s +} + +// SetSettingsForUpdate sets the SettingsForUpdate field's value. +func (s *UpdateStreamProcessorInput) SetSettingsForUpdate(v *StreamProcessorSettingsForUpdate) *UpdateStreamProcessorInput { + s.SettingsForUpdate = v + return s +} + +type UpdateStreamProcessorOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateStreamProcessorOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateStreamProcessorOutput) GoString() string { + return s.String() +} + // Contains the Amazon S3 bucket location of the validation data for a model // training job. // @@ -22342,6 +23339,22 @@ func SegmentType_Values() []string { } } +const ( + // StreamProcessorParameterToDeleteConnectedHomeMinConfidence is a StreamProcessorParameterToDelete enum value + StreamProcessorParameterToDeleteConnectedHomeMinConfidence = "ConnectedHomeMinConfidence" + + // StreamProcessorParameterToDeleteRegionsOfInterest is a StreamProcessorParameterToDelete enum value + StreamProcessorParameterToDeleteRegionsOfInterest = "RegionsOfInterest" +) + +// StreamProcessorParameterToDelete_Values returns all elements of the StreamProcessorParameterToDelete enum +func StreamProcessorParameterToDelete_Values() []string { + return []string{ + StreamProcessorParameterToDeleteConnectedHomeMinConfidence, + StreamProcessorParameterToDeleteRegionsOfInterest, + } +} + const ( // StreamProcessorStatusStopped is a StreamProcessorStatus enum value StreamProcessorStatusStopped = "STOPPED" @@ -22357,6 +23370,9 @@ const ( // StreamProcessorStatusStopping is a StreamProcessorStatus enum value StreamProcessorStatusStopping = "STOPPING" + + // StreamProcessorStatusUpdating is a StreamProcessorStatus enum value + StreamProcessorStatusUpdating = "UPDATING" ) // StreamProcessorStatus_Values returns all elements of the StreamProcessorStatus enum @@ -22367,6 +23383,7 @@ func StreamProcessorStatus_Values() []string { StreamProcessorStatusRunning, StreamProcessorStatusFailed, StreamProcessorStatusStopping, + StreamProcessorStatusUpdating, } } diff --git a/service/rekognition/doc.go b/service/rekognition/doc.go index c63abde6883..689c7d006fd 100644 --- a/service/rekognition/doc.go +++ b/service/rekognition/doc.go @@ -3,7 +3,130 @@ // Package rekognition provides the client and types for making API // requests to Amazon Rekognition. // -// This is the Amazon Rekognition API reference. +// This is the API Reference for Amazon Rekognition Image (https://docs.aws.amazon.com/rekognition/latest/dg/images.html), +// Amazon Rekognition Custom Labels (https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html), +// Amazon Rekognition Stored Video (https://docs.aws.amazon.com/rekognition/latest/dg/video.html), +// Amazon Rekognition Streaming Video (https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html). +// It provides descriptions of actions, data types, common parameters, and common +// errors. +// +// Amazon Rekognition Image +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// Amazon Rekognition Custom Labels +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// Amazon Rekognition Video Stored Video +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * +// +// Amazon Rekognition Video Streaming Video +// +// * +// +// * +// +// * +// +// * +// +// * +// +// * // // See rekognition package documentation for more information. // https://docs.aws.amazon.com/sdk-for-go/api/service/rekognition/ diff --git a/service/rekognition/errors.go b/service/rekognition/errors.go index 984921bbacb..edb869897a1 100644 --- a/service/rekognition/errors.go +++ b/service/rekognition/errors.go @@ -34,7 +34,8 @@ const ( // // The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, // the image size or resolution exceeds the allowed limit. For more information, - // see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. + // see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition + // Developer Guide. ErrCodeImageTooLargeException = "ImageTooLargeException" // ErrCodeInternalServerError for service response error code @@ -114,7 +115,8 @@ const ( // "ServiceQuotaExceededException". // // The size of the collection exceeds the allowed limit. For more information, - // see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide. + // see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition + // Developer Guide. ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" // ErrCodeThrottlingException for service response error code diff --git a/service/rekognition/rekognitioniface/interface.go b/service/rekognition/rekognitioniface/interface.go index 076b089645f..498b9f81f27 100644 --- a/service/rekognition/rekognitioniface/interface.go +++ b/service/rekognition/rekognitioniface/interface.go @@ -337,6 +337,10 @@ type RekognitionAPI interface { UpdateDatasetEntriesWithContext(aws.Context, *rekognition.UpdateDatasetEntriesInput, ...request.Option) (*rekognition.UpdateDatasetEntriesOutput, error) UpdateDatasetEntriesRequest(*rekognition.UpdateDatasetEntriesInput) (*request.Request, *rekognition.UpdateDatasetEntriesOutput) + UpdateStreamProcessor(*rekognition.UpdateStreamProcessorInput) (*rekognition.UpdateStreamProcessorOutput, error) + UpdateStreamProcessorWithContext(aws.Context, *rekognition.UpdateStreamProcessorInput, ...request.Option) (*rekognition.UpdateStreamProcessorOutput, error) + UpdateStreamProcessorRequest(*rekognition.UpdateStreamProcessorInput) (*request.Request, *rekognition.UpdateStreamProcessorOutput) + WaitUntilProjectVersionRunning(*rekognition.DescribeProjectVersionsInput) error WaitUntilProjectVersionRunningWithContext(aws.Context, *rekognition.DescribeProjectVersionsInput, ...request.WaiterOption) error diff --git a/service/sagemaker/api.go b/service/sagemaker/api.go index 3f06b85d485..1d2e599f435 100644 --- a/service/sagemaker/api.go +++ b/service/sagemaker/api.go @@ -74,8 +74,8 @@ func (c *SageMaker) AddAssociationRequest(input *AddAssociationInput) (req *requ // Resource being access is not found. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/AddAssociation func (c *SageMaker) AddAssociation(input *AddAssociationInput) (*AddAssociationOutput, error) { @@ -143,7 +143,7 @@ func (c *SageMaker) AddTagsRequest(input *AddTagsInput) (req *request.Request, o // AddTags API operation for Amazon SageMaker Service. // -// Adds or overwrites one or more tags for the specified Amazon SageMaker resource. +// Adds or overwrites one or more tags for the specified SageMaker resource. // You can add tags to notebook instances, training jobs, hyperparameter tuning // jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, // and endpoints. @@ -257,8 +257,8 @@ func (c *SageMaker) AssociateTrialComponentRequest(input *AssociateTrialComponen // Resource being access is not found. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/AssociateTrialComponent func (c *SageMaker) AssociateTrialComponent(input *AssociateTrialComponentInput) (*AssociateTrialComponentOutput, error) { @@ -414,8 +414,8 @@ func (c *SageMaker) CreateActionRequest(input *CreateActionInput) (req *request. // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateAction func (c *SageMaker) CreateAction(input *CreateActionInput) (*CreateActionOutput, error) { @@ -483,8 +483,8 @@ func (c *SageMaker) CreateAlgorithmRequest(input *CreateAlgorithmInput) (req *re // CreateAlgorithm API operation for Amazon SageMaker Service. // -// Create a machine learning algorithm that you can use in Amazon SageMaker -// and list in the Amazon Web Services Marketplace. +// Create a machine learning algorithm that you can use in SageMaker and list +// in the Amazon Web Services Marketplace. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -572,8 +572,8 @@ func (c *SageMaker) CreateAppRequest(input *CreateAppInput) (req *request.Reques // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceInUse // Resource being accessed is in use. @@ -739,8 +739,8 @@ func (c *SageMaker) CreateArtifactRequest(input *CreateArtifactInput) (req *requ // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateArtifact func (c *SageMaker) CreateArtifact(input *CreateArtifactInput) (*CreateArtifactOutput, error) { @@ -827,8 +827,8 @@ func (c *SageMaker) CreateAutoMLJobRequest(input *CreateAutoMLJobInput) (req *re // Resource being accessed is in use. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateAutoMLJob func (c *SageMaker) CreateAutoMLJob(input *CreateAutoMLJobInput) (*CreateAutoMLJobOutput, error) { @@ -896,12 +896,12 @@ func (c *SageMaker) CreateCodeRepositoryRequest(input *CreateCodeRepositoryInput // CreateCodeRepository API operation for Amazon SageMaker Service. // -// Creates a Git repository as a resource in your Amazon SageMaker account. -// You can associate the repository with notebook instances so that you can -// use Git source control for the notebooks you create. The Git repository is -// a resource in your Amazon SageMaker account, so it can be associated with -// more than one notebook instance, and it persists independently from the lifecycle -// of any notebook instances it is associated with. +// Creates a Git repository as a resource in your SageMaker account. You can +// associate the repository with notebook instances so that you can use Git +// source control for the notebooks you create. The Git repository is a resource +// in your SageMaker account, so it can be associated with more than one notebook +// instance, and it persists independently from the lifecycle of any notebook +// instances it is associated with. // // The repository can be hosted either in Amazon Web Services CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) // or in any other Git repository. @@ -1019,8 +1019,8 @@ func (c *SageMaker) CreateCompilationJobRequest(input *CreateCompilationJobInput // Resource being accessed is in use. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateCompilationJob func (c *SageMaker) CreateCompilationJob(input *CreateCompilationJobInput) (*CreateCompilationJobOutput, error) { @@ -1102,8 +1102,8 @@ func (c *SageMaker) CreateContextRequest(input *CreateContextInput) (req *reques // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateContext func (c *SageMaker) CreateContext(input *CreateContextInput) (*CreateContextOutput, error) { @@ -1183,8 +1183,8 @@ func (c *SageMaker) CreateDataQualityJobDefinitionRequest(input *CreateDataQuali // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceInUse // Resource being accessed is in use. @@ -1270,8 +1270,8 @@ func (c *SageMaker) CreateDeviceFleetRequest(input *CreateDeviceFleetInput) (req // Resource being accessed is in use. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateDeviceFleet func (c *SageMaker) CreateDeviceFleet(input *CreateDeviceFleetInput) (*CreateDeviceFleetOutput, error) { @@ -1391,8 +1391,8 @@ func (c *SageMaker) CreateDomainRequest(input *CreateDomainInput) (req *request. // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceInUse // Resource being accessed is in use. @@ -1478,8 +1478,8 @@ func (c *SageMaker) CreateEdgePackagingJobRequest(input *CreateEdgePackagingJobI // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateEdgePackagingJob func (c *SageMaker) CreateEdgePackagingJob(input *CreateEdgePackagingJobInput) (*CreateEdgePackagingJobOutput, error) { @@ -1548,12 +1548,12 @@ func (c *SageMaker) CreateEndpointRequest(input *CreateEndpointInput) (req *requ // CreateEndpoint API operation for Amazon SageMaker Service. // // Creates an endpoint using the endpoint configuration specified in the request. -// Amazon SageMaker uses the endpoint to provision resources and deploy models. -// You create the endpoint configuration with the CreateEndpointConfig API. +// SageMaker uses the endpoint to provision resources and deploy models. You +// create the endpoint configuration with the CreateEndpointConfig API. // -// Use this API to deploy models using Amazon SageMaker hosting services. +// Use this API to deploy models using SageMaker hosting services. // -// For an example that calls this method when deploying a model to Amazon SageMaker +// For an example that calls this method when deploying a model to SageMaker // hosting services, see the Create Endpoint example notebook. (https://github.com/aws/amazon-sagemaker-examples/blob/master/sagemaker-fundamentals/create-endpoint/create_endpoint.ipynb) // // You must not delete an EndpointConfig that is in use by an endpoint that @@ -1563,8 +1563,8 @@ func (c *SageMaker) CreateEndpointRequest(input *CreateEndpointInput) (req *requ // The endpoint name must be unique within an Amazon Web Services Region in // your Amazon Web Services account. // -// When it receives the request, Amazon SageMaker creates the endpoint, launches -// the resources (ML compute instances), and deploys the model(s) on them. +// When it receives the request, SageMaker creates the endpoint, launches the +// resources (ML compute instances), and deploys the model(s) on them. // // When you call CreateEndpoint, a load call is made to DynamoDB to verify that // your endpoint configuration exists. When you read data from a DynamoDB table @@ -1577,14 +1577,14 @@ func (c *SageMaker) CreateEndpointRequest(input *CreateEndpointInput) (req *requ // that customers call DescribeEndpointConfig before calling CreateEndpoint // to minimize the potential impact of a DynamoDB eventually consistent read. // -// When Amazon SageMaker receives the request, it sets the endpoint status to -// Creating. After it creates the endpoint, it sets the status to InService. -// Amazon SageMaker can then process incoming requests for inferences. To check -// the status of an endpoint, use the DescribeEndpoint API. +// When SageMaker receives the request, it sets the endpoint status to Creating. +// After it creates the endpoint, it sets the status to InService. SageMaker +// can then process incoming requests for inferences. To check the status of +// an endpoint, use the DescribeEndpoint API. // // If any of the models hosted at this endpoint get model data from an Amazon -// S3 location, Amazon SageMaker uses Amazon Web Services Security Token Service -// to download model artifacts from the S3 path you provided. Amazon Web Services +// S3 location, SageMaker uses Amazon Web Services Security Token Service to +// download model artifacts from the S3 path you provided. Amazon Web Services // STS is activated in your IAM user account by default. If you previously deactivated // Amazon Web Services STS for a region, you need to reactivate Amazon Web Services // STS for that region. For more information, see Activating and Deactivating @@ -1616,8 +1616,8 @@ func (c *SageMaker) CreateEndpointRequest(input *CreateEndpointInput) (req *requ // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateEndpoint func (c *SageMaker) CreateEndpoint(input *CreateEndpointInput) (*CreateEndpointOutput, error) { @@ -1685,24 +1685,24 @@ func (c *SageMaker) CreateEndpointConfigRequest(input *CreateEndpointConfigInput // CreateEndpointConfig API operation for Amazon SageMaker Service. // -// Creates an endpoint configuration that Amazon SageMaker hosting services -// uses to deploy models. In the configuration, you identify one or more models, -// created using the CreateModel API, to deploy and the resources that you want -// Amazon SageMaker to provision. Then you call the CreateEndpoint API. +// Creates an endpoint configuration that SageMaker hosting services uses to +// deploy models. In the configuration, you identify one or more models, created +// using the CreateModel API, to deploy and the resources that you want SageMaker +// to provision. Then you call the CreateEndpoint API. // -// Use this API if you want to use Amazon SageMaker hosting services to deploy -// models into production. +// Use this API if you want to use SageMaker hosting services to deploy models +// into production. // // In the request, you define a ProductionVariant, for each model that you want // to deploy. Each ProductionVariant parameter also describes the resources -// that you want Amazon SageMaker to provision. This includes the number and -// type of ML compute instances to deploy. +// that you want SageMaker to provision. This includes the number and type of +// ML compute instances to deploy. // // If you are hosting multiple models, you also assign a VariantWeight to specify // how much traffic you want to allocate to each model. For example, suppose // that you want to host two models, A and B, and you assign traffic weight -// 2 for model A and 1 for model B. Amazon SageMaker distributes two-thirds -// of the traffic to Model A, and one-third to model B. +// 2 for model A and 1 for model B. SageMaker distributes two-thirds of the +// traffic to Model A, and one-third to model B. // // When you call CreateEndpoint, a load call is made to DynamoDB to verify that // your endpoint configuration exists. When you read data from a DynamoDB table @@ -1724,8 +1724,8 @@ func (c *SageMaker) CreateEndpointConfigRequest(input *CreateEndpointConfigInput // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateEndpointConfig func (c *SageMaker) CreateEndpointConfig(input *CreateEndpointConfigInput) (*CreateEndpointConfigOutput, error) { @@ -1828,8 +1828,8 @@ func (c *SageMaker) CreateExperimentRequest(input *CreateExperimentInput) (req * // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateExperiment func (c *SageMaker) CreateExperiment(input *CreateExperimentInput) (*CreateExperimentOutput, error) { @@ -1921,8 +1921,8 @@ func (c *SageMaker) CreateFeatureGroupRequest(input *CreateFeatureGroupInput) (r // Resource being accessed is in use. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateFeatureGroup func (c *SageMaker) CreateFeatureGroup(input *CreateFeatureGroupInput) (*CreateFeatureGroupOutput, error) { @@ -2001,8 +2001,8 @@ func (c *SageMaker) CreateFlowDefinitionRequest(input *CreateFlowDefinitionInput // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceInUse // Resource being accessed is in use. @@ -2086,8 +2086,8 @@ func (c *SageMaker) CreateHumanTaskUiRequest(input *CreateHumanTaskUiInput) (req // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceInUse // Resource being accessed is in use. @@ -2176,8 +2176,8 @@ func (c *SageMaker) CreateHyperParameterTuningJobRequest(input *CreateHyperParam // Resource being accessed is in use. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateHyperParameterTuningJob func (c *SageMaker) CreateHyperParameterTuningJob(input *CreateHyperParameterTuningJobInput) (*CreateHyperParameterTuningJobOutput, error) { @@ -2246,9 +2246,9 @@ func (c *SageMaker) CreateImageRequest(input *CreateImageInput) (req *request.Re // CreateImage API operation for Amazon SageMaker Service. // // Creates a custom SageMaker image. A SageMaker image is a set of image versions. -// Each image version represents a container image stored in Amazon Container -// Registry (ECR). For more information, see Bring your own SageMaker image -// (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html). +// Each image version represents a container image stored in Amazon Elastic +// Container Registry (ECR). For more information, see Bring your own SageMaker +// image (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2262,8 +2262,8 @@ func (c *SageMaker) CreateImageRequest(input *CreateImageInput) (req *request.Re // Resource being accessed is in use. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateImage func (c *SageMaker) CreateImage(input *CreateImageInput) (*CreateImageOutput, error) { @@ -2332,7 +2332,7 @@ func (c *SageMaker) CreateImageVersionRequest(input *CreateImageVersionInput) (r // CreateImageVersion API operation for Amazon SageMaker Service. // // Creates a version of the SageMaker image specified by ImageName. The version -// represents the Amazon Container Registry (ECR) container image specified +// represents the Amazon Elastic Container Registry (ECR) container image specified // by BaseImage. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2347,8 +2347,8 @@ func (c *SageMaker) CreateImageVersionRequest(input *CreateImageVersionInput) (r // Resource being accessed is in use. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceNotFound // Resource being access is not found. @@ -2434,8 +2434,8 @@ func (c *SageMaker) CreateInferenceRecommendationsJobRequest(input *CreateInfere // Resource being accessed is in use. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateInferenceRecommendationsJob func (c *SageMaker) CreateInferenceRecommendationsJob(input *CreateInferenceRecommendationsJobInput) (*CreateInferenceRecommendationsJobOutput, error) { @@ -2554,8 +2554,8 @@ func (c *SageMaker) CreateLabelingJobRequest(input *CreateLabelingJobInput) (req // Resource being accessed is in use. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateLabelingJob func (c *SageMaker) CreateLabelingJob(input *CreateLabelingJobInput) (*CreateLabelingJobOutput, error) { @@ -2623,33 +2623,30 @@ func (c *SageMaker) CreateModelRequest(input *CreateModelInput) (req *request.Re // CreateModel API operation for Amazon SageMaker Service. // -// Creates a model in Amazon SageMaker. In the request, you name the model and -// describe a primary container. For the primary container, you specify the -// Docker image that contains inference code, artifacts (from prior training), -// and a custom environment map that the inference code uses when you deploy -// the model for predictions. +// Creates a model in SageMaker. In the request, you name the model and describe +// a primary container. For the primary container, you specify the Docker image +// that contains inference code, artifacts (from prior training), and a custom +// environment map that the inference code uses when you deploy the model for +// predictions. // -// Use this API to create a model if you want to use Amazon SageMaker hosting -// services or run a batch transform job. +// Use this API to create a model if you want to use SageMaker hosting services +// or run a batch transform job. // // To host your model, you create an endpoint configuration with the CreateEndpointConfig -// API, and then create an endpoint with the CreateEndpoint API. Amazon SageMaker -// then deploys all of the containers that you defined for the model in the -// hosting environment. +// API, and then create an endpoint with the CreateEndpoint API. SageMaker then +// deploys all of the containers that you defined for the model in the hosting +// environment. // -// For an example that calls this method when deploying a model to Amazon SageMaker +// For an example that calls this method when deploying a model to SageMaker // hosting services, see Deploy the Model to Amazon SageMaker Hosting Services // (Amazon Web Services SDK for Python (Boto 3)). (https://docs.aws.amazon.com/sagemaker/latest/dg/ex1-deploy-model.html#ex1-deploy-model-boto) // // To run a batch transform using your model, you start a job with the CreateTransformJob -// API. Amazon SageMaker uses your model and your dataset to get inferences -// which are then saved to a specified S3 location. -// -// In the CreateModel request, you must define a container with the PrimaryContainer -// parameter. +// API. SageMaker uses your model and your dataset to get inferences which are +// then saved to a specified S3 location. // -// In the request, you also provide an IAM role that Amazon SageMaker can assume -// to access model artifacts and docker image for deployment on ML compute hosting +// In the request, you also provide an IAM role that SageMaker can assume to +// access model artifacts and docker image for deployment on ML compute hosting // instances or for batch transform jobs. In addition, you also use the IAM // role to manage permissions the inference code needs. For example, if the // inference code access any other Amazon Web Services resources, you grant @@ -2664,8 +2661,8 @@ func (c *SageMaker) CreateModelRequest(input *CreateModelInput) (req *request.Re // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateModel func (c *SageMaker) CreateModel(input *CreateModelInput) (*CreateModelOutput, error) { @@ -2744,8 +2741,8 @@ func (c *SageMaker) CreateModelBiasJobDefinitionRequest(input *CreateModelBiasJo // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceInUse // Resource being accessed is in use. @@ -2827,8 +2824,8 @@ func (c *SageMaker) CreateModelExplainabilityJobDefinitionRequest(input *CreateM // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceInUse // Resource being accessed is in use. @@ -2899,10 +2896,10 @@ func (c *SageMaker) CreateModelPackageRequest(input *CreateModelPackageInput) (r // CreateModelPackage API operation for Amazon SageMaker Service. // -// Creates a model package that you can use to create Amazon SageMaker models -// or list on Amazon Web Services Marketplace, or a versioned model that is -// part of a model group. Buyers can subscribe to model packages listed on Amazon -// Web Services Marketplace to create models in Amazon SageMaker. +// Creates a model package that you can use to create SageMaker models or list +// on Amazon Web Services Marketplace, or a versioned model that is part of +// a model group. Buyers can subscribe to model packages listed on Amazon Web +// Services Marketplace to create models in SageMaker. // // To create a model package by specifying a Docker container that contains // your inference code and the Amazon S3 location of your model artifacts, provide @@ -2929,8 +2926,8 @@ func (c *SageMaker) CreateModelPackageRequest(input *CreateModelPackageInput) (r // as an Experiment or Artifact. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateModelPackage func (c *SageMaker) CreateModelPackage(input *CreateModelPackageInput) (*CreateModelPackageOutput, error) { @@ -3009,8 +3006,8 @@ func (c *SageMaker) CreateModelPackageGroupRequest(input *CreateModelPackageGrou // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateModelPackageGroup func (c *SageMaker) CreateModelPackageGroup(input *CreateModelPackageGroupInput) (*CreateModelPackageGroupOutput, error) { @@ -3090,8 +3087,8 @@ func (c *SageMaker) CreateModelQualityJobDefinitionRequest(input *CreateModelQua // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceInUse // Resource being accessed is in use. @@ -3174,8 +3171,8 @@ func (c *SageMaker) CreateMonitoringScheduleRequest(input *CreateMonitoringSched // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceInUse // Resource being accessed is in use. @@ -3246,42 +3243,42 @@ func (c *SageMaker) CreateNotebookInstanceRequest(input *CreateNotebookInstanceI // CreateNotebookInstance API operation for Amazon SageMaker Service. // -// Creates an Amazon SageMaker notebook instance. A notebook instance is a machine +// Creates an SageMaker notebook instance. A notebook instance is a machine // learning (ML) compute instance running on a Jupyter notebook. // // In a CreateNotebookInstance request, specify the type of ML compute instance -// that you want to run. Amazon SageMaker launches the instance, installs common -// libraries that you can use to explore datasets for model training, and attaches -// an ML storage volume to the notebook instance. +// that you want to run. SageMaker launches the instance, installs common libraries +// that you can use to explore datasets for model training, and attaches an +// ML storage volume to the notebook instance. // -// Amazon SageMaker also provides a set of example notebooks. Each notebook -// demonstrates how to use Amazon SageMaker with a specific algorithm or with -// a machine learning framework. +// SageMaker also provides a set of example notebooks. Each notebook demonstrates +// how to use SageMaker with a specific algorithm or with a machine learning +// framework. // -// After receiving the request, Amazon SageMaker does the following: +// After receiving the request, SageMaker does the following: // -// Creates a network interface in the Amazon SageMaker VPC. +// Creates a network interface in the SageMaker VPC. // -// (Option) If you specified SubnetId, Amazon SageMaker creates a network interface +// (Option) If you specified SubnetId, SageMaker creates a network interface // in your own VPC, which is inferred from the subnet ID that you provide in -// the input. When creating this network interface, Amazon SageMaker attaches -// the security group that you specified in the request to the network interface -// that it creates in your VPC. +// the input. When creating this network interface, SageMaker attaches the security +// group that you specified in the request to the network interface that it +// creates in your VPC. // -// Launches an EC2 instance of the type specified in the request in the Amazon -// SageMaker VPC. If you specified SubnetId of your VPC, Amazon SageMaker specifies -// both network interfaces when launching this instance. This enables inbound -// traffic from your own VPC to the notebook instance, assuming that the security -// groups allow it. +// Launches an EC2 instance of the type specified in the request in the SageMaker +// VPC. If you specified SubnetId of your VPC, SageMaker specifies both network +// interfaces when launching this instance. This enables inbound traffic from +// your own VPC to the notebook instance, assuming that the security groups +// allow it. // -// After creating the notebook instance, Amazon SageMaker returns its Amazon -// Resource Name (ARN). You can't change the name of a notebook instance after -// you create it. +// After creating the notebook instance, SageMaker returns its Amazon Resource +// Name (ARN). You can't change the name of a notebook instance after you create +// it. // -// After Amazon SageMaker creates the notebook instance, you can connect to -// the Jupyter server and work in Jupyter notebooks. For example, you can write -// code to explore a dataset that you can use for model training, train a model, -// host models by creating Amazon SageMaker endpoints, and validate hosted models. +// After SageMaker creates the notebook instance, you can connect to the Jupyter +// server and work in Jupyter notebooks. For example, you can write code to +// explore a dataset that you can use for model training, train a model, host +// models by creating SageMaker endpoints, and validate hosted models. // // For more information, see How It Works (https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html). // @@ -3294,8 +3291,8 @@ func (c *SageMaker) CreateNotebookInstanceRequest(input *CreateNotebookInstanceI // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateNotebookInstance func (c *SageMaker) CreateNotebookInstance(input *CreateNotebookInstanceInput) (*CreateNotebookInstanceOutput, error) { @@ -3391,8 +3388,8 @@ func (c *SageMaker) CreateNotebookInstanceLifecycleConfigRequest(input *CreateNo // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateNotebookInstanceLifecycleConfig func (c *SageMaker) CreateNotebookInstanceLifecycleConfig(input *CreateNotebookInstanceLifecycleConfigInput) (*CreateNotebookInstanceLifecycleConfigOutput, error) { @@ -3474,8 +3471,8 @@ func (c *SageMaker) CreatePipelineRequest(input *CreatePipelineInput) (req *requ // Resource being access is not found. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreatePipeline func (c *SageMaker) CreatePipeline(input *CreatePipelineInput) (*CreatePipelineOutput, error) { @@ -3643,10 +3640,10 @@ func (c *SageMaker) CreatePresignedNotebookInstanceUrlRequest(input *CreatePresi // CreatePresignedNotebookInstanceUrl API operation for Amazon SageMaker Service. // // Returns a URL that you can use to connect to the Jupyter server from a notebook -// instance. In the Amazon SageMaker console, when you choose Open next to a -// notebook instance, Amazon SageMaker opens a new tab showing the Jupyter server -// home page from the notebook instance. The console uses this API to get the -// URL and show the page. +// instance. In the SageMaker console, when you choose Open next to a notebook +// instance, SageMaker opens a new tab showing the Jupyter server home page +// from the notebook instance. The console uses this API to get the URL and +// show the page. // // The IAM role or user used to call this API defines the permissions to access // the notebook instance. Once the presigned URL is created, no additional permission @@ -3750,8 +3747,8 @@ func (c *SageMaker) CreateProcessingJobRequest(input *CreateProcessingJobInput) // Resource being accessed is in use. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceNotFound // Resource being access is not found. @@ -3834,8 +3831,8 @@ func (c *SageMaker) CreateProjectRequest(input *CreateProjectInput) (req *reques // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateProject func (c *SageMaker) CreateProject(input *CreateProjectInput) (*CreateProjectOutput, error) { @@ -3982,13 +3979,13 @@ func (c *SageMaker) CreateTrainingJobRequest(input *CreateTrainingJobInput) (req // CreateTrainingJob API operation for Amazon SageMaker Service. // -// Starts a model training job. After training completes, Amazon SageMaker saves -// the resulting model artifacts to an Amazon S3 location that you specify. +// Starts a model training job. After training completes, SageMaker saves the +// resulting model artifacts to an Amazon S3 location that you specify. // -// If you choose to host your model using Amazon SageMaker hosting services, -// you can use the resulting model artifacts as part of the model. You can also -// use the artifacts in a machine learning service other than Amazon SageMaker, -// provided that you know how to use them for inference. +// If you choose to host your model using SageMaker hosting services, you can +// use the resulting model artifacts as part of the model. You can also use +// the artifacts in a machine learning service other than SageMaker, provided +// that you know how to use them for inference. // // In the request body, you provide the following: // @@ -3997,14 +3994,13 @@ func (c *SageMaker) CreateTrainingJobRequest(input *CreateTrainingJobInput) (req // * HyperParameters - Specify these algorithm-specific parameters to enable // the estimation of model parameters during training. Hyperparameters can // be tuned to optimize this learning process. For a list of hyperparameters -// for each training algorithm provided by Amazon SageMaker, see Algorithms -// (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). +// for each training algorithm provided by SageMaker, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). // // * InputDataConfig - Describes the training dataset and the Amazon S3, // EFS, or FSx location where it is stored. // -// * OutputDataConfig - Identifies the Amazon S3 bucket where you want Amazon -// SageMaker to save the results of model training. +// * OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker +// to save the results of model training. // // * ResourceConfig - Identifies the resources, ML compute instances, and // ML storage volumes to deploy for model training. In distributed training, @@ -4014,10 +4010,10 @@ func (c *SageMaker) CreateTrainingJobRequest(input *CreateTrainingJobInput) (req // models by up to 80% by using Amazon EC2 Spot instances. For more information, // see Managed Spot Training (https://docs.aws.amazon.com/sagemaker/latest/dg/model-managed-spot-training.html). // -// * RoleArn - The Amazon Resource Name (ARN) that Amazon SageMaker assumes -// to perform tasks on your behalf during model training. You must grant -// this role the necessary permissions so that Amazon SageMaker can successfully -// complete model training. +// * RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform +// tasks on your behalf during model training. You must grant this role the +// necessary permissions so that SageMaker can successfully complete model +// training. // // * StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds // to set a time limit for training. Use MaxWaitTimeInSeconds to specify @@ -4028,7 +4024,7 @@ func (c *SageMaker) CreateTrainingJobRequest(input *CreateTrainingJobInput) (req // * RetryStrategy - The number of times to retry the job when the job fails // due to an InternalServerError. // -// For more information about Amazon SageMaker, see How It Works (https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html). +// For more information about SageMaker, see How It Works (https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4042,8 +4038,8 @@ func (c *SageMaker) CreateTrainingJobRequest(input *CreateTrainingJobInput) (req // Resource being accessed is in use. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceNotFound // Resource being access is not found. @@ -4154,8 +4150,8 @@ func (c *SageMaker) CreateTransformJobRequest(input *CreateTransformJobInput) (r // Resource being accessed is in use. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceNotFound // Resource being access is not found. @@ -4254,8 +4250,8 @@ func (c *SageMaker) CreateTrialRequest(input *CreateTrialInput) (req *request.Re // Resource being access is not found. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateTrial func (c *SageMaker) CreateTrial(input *CreateTrialInput) (*CreateTrialOutput, error) { @@ -4347,8 +4343,8 @@ func (c *SageMaker) CreateTrialComponentRequest(input *CreateTrialComponentInput // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateTrialComponent func (c *SageMaker) CreateTrialComponent(input *CreateTrialComponentInput) (*CreateTrialComponentOutput, error) { @@ -4434,8 +4430,8 @@ func (c *SageMaker) CreateUserProfileRequest(input *CreateUserProfileInput) (req // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceInUse // Resource being accessed is in use. @@ -4615,8 +4611,8 @@ func (c *SageMaker) CreateWorkteamRequest(input *CreateWorkteamInput) (req *requ // Resource being accessed is in use. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateWorkteam func (c *SageMaker) CreateWorkteam(input *CreateWorkteamInput) (*CreateWorkteamOutput, error) { @@ -5560,13 +5556,19 @@ func (c *SageMaker) DeleteEndpointRequest(input *DeleteEndpointInput) (req *requ // DeleteEndpoint API operation for Amazon SageMaker Service. // -// Deletes an endpoint. Amazon SageMaker frees up all of the resources that -// were deployed when the endpoint was created. +// Deletes an endpoint. SageMaker frees up all of the resources that were deployed +// when the endpoint was created. // -// Amazon SageMaker retires any custom KMS key grants associated with the endpoint, +// SageMaker retires any custom KMS key grants associated with the endpoint, // meaning you don't need to use the RevokeGrant (http://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html) // API call. // +// When you delete your endpoint, SageMaker asynchronously deletes associated +// endpoint resources such as KMS key grants. You might still see these resources +// in your account for a few minutes after deleting your endpoint. Do not delete +// or revoke the permissions for your ExecutionRoleArn (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html#sagemaker-CreateModel-request-ExecutionRoleArn) +// , otherwise SageMaker cannot delete these resources. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6227,9 +6229,9 @@ func (c *SageMaker) DeleteModelRequest(input *DeleteModelInput) (req *request.Re // DeleteModel API operation for Amazon SageMaker Service. // // Deletes a model. The DeleteModel API deletes only the model entry that was -// created in Amazon SageMaker when you called the CreateModel API. It does -// not delete model artifacts, inference code, or the IAM role that you specified -// when creating the model. +// created in SageMaker when you called the CreateModel API. It does not delete +// model artifacts, inference code, or the IAM role that you specified when +// creating the model. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6466,9 +6468,9 @@ func (c *SageMaker) DeleteModelPackageRequest(input *DeleteModelPackageInput) (r // // Deletes a model package. // -// A model package is used to create Amazon SageMaker models or list on Amazon -// Web Services Marketplace. Buyers can subscribe to model packages listed on -// Amazon Web Services Marketplace to create models in Amazon SageMaker. +// A model package is used to create SageMaker models or list on Amazon Web +// Services Marketplace. Buyers can subscribe to model packages listed on Amazon +// Web Services Marketplace to create models in SageMaker. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6867,10 +6869,10 @@ func (c *SageMaker) DeleteNotebookInstanceRequest(input *DeleteNotebookInstanceI // DeleteNotebookInstance API operation for Amazon SageMaker Service. // -// Deletes an Amazon SageMaker notebook instance. Before you can delete a notebook +// Deletes an SageMaker notebook instance. Before you can delete a notebook // instance, you must call the StopNotebookInstance API. // -// When you delete a notebook instance, you lose all of your data. Amazon SageMaker +// When you delete a notebook instance, you lose all of your data. SageMaker // removes the ML compute instance, and deletes the ML storage volume and the // network interface associated with the notebook instance. // @@ -7271,7 +7273,7 @@ func (c *SageMaker) DeleteTagsRequest(input *DeleteTagsInput) (req *request.Requ // DeleteTags API operation for Amazon SageMaker Service. // -// Deletes the specified tags from an Amazon SageMaker resource. +// Deletes the specified tags from an SageMaker resource. // // To list a resource's tags, use the ListTags API. // @@ -7696,8 +7698,8 @@ func (c *SageMaker) DeleteWorkteamRequest(input *DeleteWorkteamInput) (req *requ // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteWorkteam func (c *SageMaker) DeleteWorkteam(input *DeleteWorkteamInput) (*DeleteWorkteamOutput, error) { @@ -17502,8 +17504,8 @@ func (c *SageMaker) ListNotebookInstancesRequest(input *ListNotebookInstancesInp // ListNotebookInstances API operation for Amazon SageMaker Service. // -// Returns a list of the Amazon SageMaker notebook instances in the requester's -// account in an Amazon Web Services Region. +// Returns a list of the SageMaker notebook instances in the requester's account +// in an Amazon Web Services Region. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -18713,7 +18715,7 @@ func (c *SageMaker) ListTagsRequest(input *ListTagsInput) (req *request.Request, // ListTags API operation for Amazon SageMaker Service. // -// Returns the tags for the specified Amazon SageMaker resource. +// Returns the tags for the specified SageMaker resource. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -20174,8 +20176,8 @@ func (c *SageMaker) RegisterDevicesRequest(input *RegisterDevicesInput) (req *re // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/RegisterDevices func (c *SageMaker) RegisterDevices(input *RegisterDevicesInput) (*RegisterDevicesOutput, error) { @@ -20336,8 +20338,8 @@ func (c *SageMaker) RetryPipelineExecutionRequest(input *RetryPipelineExecutionI // Resource being access is not found. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ConflictException // There was a conflict when you attempted to modify a SageMaker entity such @@ -20564,8 +20566,8 @@ func (c *SageMaker) SendPipelineExecutionStepFailureRequest(input *SendPipelineE // Resource being access is not found. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/SendPipelineExecutionStepFailure func (c *SageMaker) SendPipelineExecutionStepFailure(input *SendPipelineExecutionStepFailureInput) (*SendPipelineExecutionStepFailureOutput, error) { @@ -20650,8 +20652,8 @@ func (c *SageMaker) SendPipelineExecutionStepSuccessRequest(input *SendPipelineE // Resource being access is not found. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/SendPipelineExecutionStepSuccess func (c *SageMaker) SendPipelineExecutionStepSuccess(input *SendPipelineExecutionStepSuccessInput) (*SendPipelineExecutionStepSuccessOutput, error) { @@ -20805,9 +20807,8 @@ func (c *SageMaker) StartNotebookInstanceRequest(input *StartNotebookInstanceInp // // Launches an ML compute instance with the latest version of the libraries // and attaches your ML storage volume. After configuring the notebook instance, -// Amazon SageMaker sets the notebook instance status to InService. A notebook -// instance's status must be InService before you can connect to your Jupyter -// notebook. +// SageMaker sets the notebook instance status to InService. A notebook instance's +// status must be InService before you can connect to your Jupyter notebook. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -20818,8 +20819,8 @@ func (c *SageMaker) StartNotebookInstanceRequest(input *StartNotebookInstanceInp // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StartNotebookInstance func (c *SageMaker) StartNotebookInstance(input *StartNotebookInstanceInput) (*StartNotebookInstanceOutput, error) { @@ -20901,8 +20902,8 @@ func (c *SageMaker) StartPipelineExecutionRequest(input *StartPipelineExecutionI // Resource being access is not found. // // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StartPipelineExecution func (c *SageMaker) StartPipelineExecution(input *StartPipelineExecutionInput) (*StartPipelineExecutionOutput, error) { @@ -21543,10 +21544,10 @@ func (c *SageMaker) StopNotebookInstanceRequest(input *StopNotebookInstanceInput // StopNotebookInstance API operation for Amazon SageMaker Service. // -// Terminates the ML compute instance. Before terminating the instance, Amazon -// SageMaker disconnects the ML storage volume from it. Amazon SageMaker preserves -// the ML storage volume. Amazon SageMaker stops charging you for the ML compute -// instance when you call StopNotebookInstance. +// Terminates the ML compute instance. Before terminating the instance, SageMaker +// disconnects the ML storage volume from it. SageMaker preserves the ML storage +// volume. SageMaker stops charging you for the ML compute instance when you +// call StopNotebookInstance. // // To access data on the ML storage volume for a notebook instance that has // been terminated, call the StartNotebookInstance API. StartNotebookInstance @@ -21810,14 +21811,14 @@ func (c *SageMaker) StopTrainingJobRequest(input *StopTrainingJobInput) (req *re // StopTrainingJob API operation for Amazon SageMaker Service. // -// Stops a training job. To stop a job, Amazon SageMaker sends the algorithm -// the SIGTERM signal, which delays job termination for 120 seconds. Algorithms -// might use this 120-second window to save the model artifacts, so the results -// of the training is not lost. +// Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM +// signal, which delays job termination for 120 seconds. Algorithms might use +// this 120-second window to save the model artifacts, so the results of the +// training is not lost. // -// When it receives a StopTrainingJob request, Amazon SageMaker changes the -// status of the job to Stopping. After Amazon SageMaker stops the job, it sets -// the status to Stopped. +// When it receives a StopTrainingJob request, SageMaker changes the status +// of the job to Stopping. After SageMaker stops the job, it sets the status +// to Stopped. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -22549,8 +22550,8 @@ func (c *SageMaker) UpdateDomainRequest(input *UpdateDomainInput) (req *request. // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceInUse // Resource being accessed is in use. @@ -22628,9 +22629,9 @@ func (c *SageMaker) UpdateEndpointRequest(input *UpdateEndpointInput) (req *requ // newly created endpoint, and then deletes resources provisioned for the endpoint // using the previous EndpointConfig (there is no availability loss). // -// When Amazon SageMaker receives the request, it sets the endpoint status to -// Updating. After updating the endpoint, it sets the status to InService. To -// check the status of an endpoint, use the DescribeEndpoint API. +// When SageMaker receives the request, it sets the endpoint status to Updating. +// After updating the endpoint, it sets the status to InService. To check the +// status of an endpoint, use the DescribeEndpoint API. // // You must not delete an EndpointConfig in use by an endpoint that is live // or while the UpdateEndpoint or CreateEndpoint operations are being performed @@ -22649,8 +22650,8 @@ func (c *SageMaker) UpdateEndpointRequest(input *UpdateEndpointInput) (req *requ // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateEndpoint func (c *SageMaker) UpdateEndpoint(input *UpdateEndpointInput) (*UpdateEndpointOutput, error) { @@ -22720,9 +22721,9 @@ func (c *SageMaker) UpdateEndpointWeightsAndCapacitiesRequest(input *UpdateEndpo // // Updates variant weight of one or more variants associated with an existing // endpoint, or capacity of one variant associated with an existing endpoint. -// When it receives the request, Amazon SageMaker sets the endpoint status to -// Updating. After updating the endpoint, it sets the status to InService. To -// check the status of an endpoint, use the DescribeEndpoint API. +// When it receives the request, SageMaker sets the endpoint status to Updating. +// After updating the endpoint, it sets the status to InService. To check the +// status of an endpoint, use the DescribeEndpoint API. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -22733,8 +22734,8 @@ func (c *SageMaker) UpdateEndpointWeightsAndCapacitiesRequest(input *UpdateEndpo // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateEndpointWeightsAndCapacities func (c *SageMaker) UpdateEndpointWeightsAndCapacities(input *UpdateEndpointWeightsAndCapacitiesInput) (*UpdateEndpointWeightsAndCapacitiesOutput, error) { @@ -23054,8 +23055,8 @@ func (c *SageMaker) UpdateMonitoringScheduleRequest(input *UpdateMonitoringSched // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceNotFound // Resource being access is not found. @@ -23140,8 +23141,8 @@ func (c *SageMaker) UpdateNotebookInstanceRequest(input *UpdateNotebookInstanceI // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateNotebookInstance func (c *SageMaker) UpdateNotebookInstance(input *UpdateNotebookInstanceInput) (*UpdateNotebookInstanceOutput, error) { @@ -23222,8 +23223,8 @@ func (c *SageMaker) UpdateNotebookInstanceLifecycleConfigRequest(input *UpdateNo // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateNotebookInstanceLifecycleConfig func (c *SageMaker) UpdateNotebookInstanceLifecycleConfig(input *UpdateNotebookInstanceLifecycleConfigInput) (*UpdateNotebookInstanceLifecycleConfigOutput, error) { @@ -23784,8 +23785,8 @@ func (c *SageMaker) UpdateUserProfileRequest(input *UpdateUserProfileInput) (req // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // * ResourceInUse // Resource being accessed is in use. @@ -23966,8 +23967,8 @@ func (c *SageMaker) UpdateWorkteamRequest(input *UpdateWorkteamInput) (req *requ // // Returned Error Types: // * ResourceLimitExceeded -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateWorkteam func (c *SageMaker) UpdateWorkteam(input *UpdateWorkteamInput) (*UpdateWorkteamOutput, error) { @@ -24344,7 +24345,7 @@ func (s *AddTagsInput) SetTags(v []*Tag) *AddTagsInput { type AddTagsOutput struct { _ struct{} `type:"structure"` - // A list of tags associated with the Amazon SageMaker resource. + // A list of tags associated with the SageMaker resource. Tags []*Tag `type:"list"` } @@ -24595,7 +24596,7 @@ func (s *Alarm) SetAlarmName(v string) *Alarm { // Specifies the training algorithm to use in a CreateTrainingJob request. // -// For more information about algorithms provided by Amazon SageMaker, see Algorithms +// For more information about algorithms provided by SageMaker, see Algorithms // (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). For information // about using your own algorithms, see Using Your Own Algorithms with Amazon // SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html). @@ -24612,10 +24613,9 @@ type AlgorithmSpecification struct { // default is false and time-series metrics aren't generated except in the following // cases: // - // * You use one of the Amazon SageMaker built-in algorithms + // * You use one of the SageMaker built-in algorithms // - // * You use one of the following Prebuilt Amazon SageMaker Docker Images - // (https://docs.aws.amazon.com/sagemaker/latest/dg/pre-built-containers-frameworks-deep-learning.html): + // * You use one of the following Prebuilt SageMaker Docker Images (https://docs.aws.amazon.com/sagemaker/latest/dg/pre-built-containers-frameworks-deep-learning.html): // Tensorflow (version >= 1.15) MXNet (version >= 1.6) PyTorch (version >= // 1.3) // @@ -24623,14 +24623,14 @@ type AlgorithmSpecification struct { EnableSageMakerMetricsTimeSeries *bool `type:"boolean"` // A list of metric definition objects. Each object specifies the metric name - // and regular expressions used to parse algorithm logs. Amazon SageMaker publishes + // and regular expressions used to parse algorithm logs. SageMaker publishes // each metric to Amazon CloudWatch. MetricDefinitions []*MetricDefinition `type:"list"` // The registry path of the Docker image that contains the training algorithm. // For information about docker registry paths for built-in algorithms, see // Algorithms Provided by Amazon SageMaker: Common Parameters (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html). - // Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] + // SageMaker supports both registry/repository[:tag] and registry/repository[@digest] // image path formats. For more information, see Using Your Own Algorithms with // Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html). TrainingImage *string `type:"string"` @@ -24921,8 +24921,8 @@ func (s *AlgorithmSummary) SetCreationTime(v time.Time) *AlgorithmSummary { return s } -// Defines a training job and a batch transform job that Amazon SageMaker runs -// to validate your algorithm. +// Defines a training job and a batch transform job that SageMaker runs to validate +// your algorithm. // // The data provided in the validation profile is made available to your buyers // on Amazon Web Services Marketplace. @@ -24935,14 +24935,14 @@ type AlgorithmValidationProfile struct { // ProfileName is a required field ProfileName *string `min:"1" type:"string" required:"true"` - // The TrainingJobDefinition object that describes the training job that Amazon - // SageMaker runs to validate your algorithm. + // The TrainingJobDefinition object that describes the training job that SageMaker + // runs to validate your algorithm. // // TrainingJobDefinition is a required field TrainingJobDefinition *TrainingJobDefinition `type:"structure" required:"true"` - // The TransformJobDefinition object that describes the transform job that Amazon - // SageMaker runs to validate your algorithm. + // The TransformJobDefinition object that describes the transform job that SageMaker + // runs to validate your algorithm. TransformJobDefinition *TransformJobDefinition `type:"structure"` } @@ -25011,19 +25011,19 @@ func (s *AlgorithmValidationProfile) SetTransformJobDefinition(v *TransformJobDe return s } -// Specifies configurations for one or more training jobs that Amazon SageMaker -// runs to test the algorithm. +// Specifies configurations for one or more training jobs that SageMaker runs +// to test the algorithm. type AlgorithmValidationSpecification struct { _ struct{} `type:"structure"` // An array of AlgorithmValidationProfile objects, each of which specifies a - // training job and batch transform job that Amazon SageMaker runs to validate - // your algorithm. + // training job and batch transform job that SageMaker runs to validate your + // algorithm. // // ValidationProfiles is a required field ValidationProfiles []*AlgorithmValidationProfile `min:"1" type:"list" required:"true"` - // The IAM roles that Amazon SageMaker uses to run the training jobs. + // The IAM roles that SageMaker uses to run the training jobs. // // ValidationRole is a required field ValidationRole *string `min:"20" type:"string" required:"true"` @@ -26404,14 +26404,14 @@ func (s *AssociationSummary) SetSourceType(v string) *AssociationSummary { return s } -// Configures the behavior of the client used by Amazon SageMaker to interact -// with the model container during asynchronous inference. +// Configures the behavior of the client used by SageMaker to interact with +// the model container during asynchronous inference. type AsyncInferenceClientConfig struct { _ struct{} `type:"structure"` // The maximum number of concurrent requests sent by the SageMaker client to - // the model container. If no value is provided, Amazon SageMaker will choose - // an optimal value for you. + // the model container. If no value is provided, SageMaker chooses an optimal + // value. MaxConcurrentInvocationsPerInstance *int64 `min:"1" type:"integer"` } @@ -26456,8 +26456,8 @@ func (s *AsyncInferenceClientConfig) SetMaxConcurrentInvocationsPerInstance(v in type AsyncInferenceConfig struct { _ struct{} `type:"structure"` - // Configures the behavior of the client used by Amazon SageMaker to interact - // with the model container during asynchronous inference. + // Configures the behavior of the client used by SageMaker to interact with + // the model container during asynchronous inference. ClientConfig *AsyncInferenceClientConfig `type:"structure"` // Specifies the configuration for asynchronous inference invocation outputs. @@ -26568,8 +26568,8 @@ type AsyncInferenceOutputConfig struct { _ struct{} `type:"structure"` // The Amazon Web Services Key Management Service (Amazon Web Services KMS) - // key that Amazon SageMaker uses to encrypt the asynchronous inference output - // in Amazon S3. + // key that SageMaker uses to encrypt the asynchronous inference output in Amazon + // S3. KmsKeyId *string `type:"string"` // Specifies the configuration for notifications of inference results for asynchronous @@ -26966,11 +26966,19 @@ func (s *AutoMLCandidateStep) SetCandidateStepType(v string) *AutoMLCandidateSte return s } -// A channel is a named input source that training algorithms can consume. For -// more information, see . +// A channel is a named input source that training algorithms can consume. The +// validation dataset size is limited to less than 2 GB. The training dataset +// size must be less than 100 GB. For more information, see . +// +// A validation dataset must contain the same headers as the training dataset. type AutoMLChannel struct { _ struct{} `type:"structure"` + // The channel type (optional) is an enum string. The default value is training. + // Channels for training and validation must share the same ContentType and + // TargetAttributeName. + ChannelType *string `type:"string" enum:"AutoMLChannelType"` + // You can use Gzip or None. The default value is None. CompressionType *string `type:"string" enum:"CompressionType"` @@ -27032,6 +27040,12 @@ func (s *AutoMLChannel) Validate() error { return nil } +// SetChannelType sets the ChannelType field's value. +func (s *AutoMLChannel) SetChannelType(v string) *AutoMLChannel { + s.ChannelType = &v + return s +} + // SetCompressionType sets the CompressionType field's value. func (s *AutoMLChannel) SetCompressionType(v string) *AutoMLChannel { s.CompressionType = &v @@ -27167,6 +27181,43 @@ func (s *AutoMLDataSource) SetS3DataSource(v *AutoMLS3DataSource) *AutoMLDataSou return s } +// This structure specifies how to split the data into train and test datasets. +// The validation and training datasets must contain the same headers. The validation +// dataset must be less than 2 GB in size. +type AutoMLDataSplitConfig struct { + _ struct{} `type:"structure"` + + // The validation fraction (optional) is a float that specifies the portion + // of the training dataset to be used for validation. The default value is 0.2, + // and values can range from 0 to 1. We recommend setting this value to be less + // than 0.5. + ValidationFraction *float64 `type:"float"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AutoMLDataSplitConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AutoMLDataSplitConfig) GoString() string { + return s.String() +} + +// SetValidationFraction sets the ValidationFraction field's value. +func (s *AutoMLDataSplitConfig) SetValidationFraction(v float64) *AutoMLDataSplitConfig { + s.ValidationFraction = &v + return s +} + // The artifacts that are generated during an AutoML job. type AutoMLJobArtifacts struct { _ struct{} `type:"structure"` @@ -27294,6 +27345,11 @@ type AutoMLJobConfig struct { // allowed to generate. CompletionCriteria *AutoMLJobCompletionCriteria `type:"structure"` + // The configuration for splitting the input training dataset. + // + // Type: AutoMLDataSplitConfig + DataSplitConfig *AutoMLDataSplitConfig `type:"structure"` + // The security configuration for traffic encryption or Amazon VPC settings. SecurityConfig *AutoMLSecurityConfig `type:"structure"` } @@ -27342,6 +27398,12 @@ func (s *AutoMLJobConfig) SetCompletionCriteria(v *AutoMLJobCompletionCriteria) return s } +// SetDataSplitConfig sets the DataSplitConfig field's value. +func (s *AutoMLJobConfig) SetDataSplitConfig(v *AutoMLDataSplitConfig) *AutoMLJobConfig { + s.DataSplitConfig = v + return s +} + // SetSecurityConfig sets the SecurityConfig field's value. func (s *AutoMLJobConfig) SetSecurityConfig(v *AutoMLSecurityConfig) *AutoMLJobConfig { s.SecurityConfig = v @@ -28778,11 +28840,11 @@ type Channel struct { DataSource *DataSource `type:"structure" required:"true"` // (Optional) The input mode to use for the data channel in a training job. - // If you don't set a value for InputMode, Amazon SageMaker uses the value set - // for TrainingInputMode. Use this parameter to override the TrainingInputMode - // setting in a AlgorithmSpecification request when you have a channel that - // needs a different input mode from the training job's general setting. To - // download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned + // If you don't set a value for InputMode, SageMaker uses the value set for + // TrainingInputMode. Use this parameter to override the TrainingInputMode setting + // in a AlgorithmSpecification request when you have a channel that needs a + // different input mode from the training job's general setting. To download + // the data from Amazon Simple Storage Service (Amazon S3) to the provisioned // ML storage volume, and mount the directory to a Docker volume, use File input // mode. To stream data directly from Amazon S3 to the container, choose Pipe // input mode. @@ -28791,9 +28853,9 @@ type Channel struct { InputMode *string `type:"string" enum:"TrainingInputMode"` // Specify RecordIO as the value when input data is in raw format but the training - // algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps - // each individual S3 object in a RecordIO record. If the input data is already - // in RecordIO format, you don't need to set this attribute. For more information, + // algorithm requires the RecordIO format. In this case, SageMaker wraps each + // individual S3 object in a RecordIO record. If the input data is already in + // RecordIO format, you don't need to set this attribute. For more information, // see Create a Dataset Using RecordIO (https://mxnet.apache.org/api/architecture/note_data_loading#data-format). // // In File mode, leave this field unset or set it to None. @@ -29029,8 +29091,8 @@ type CheckpointConfig struct { // directory is /opt/ml/checkpoints/. LocalPath *string `type:"string"` - // Identifies the S3 path where you want Amazon SageMaker to store checkpoints. - // For example, s3://bucket-name/key-name-prefix. + // Identifies the S3 path where you want SageMaker to store checkpoints. For + // example, s3://bucket-name/key-name-prefix. // // S3Uri is a required field S3Uri *string `type:"string" required:"true"` @@ -29733,11 +29795,10 @@ type ContainerDefinition struct { // The path where inference code is stored. This can be either in Amazon EC2 // Container Registry or in a Docker registry that is accessible from the same // VPC that you configure for your endpoint. If you are using your own custom - // algorithm instead of an algorithm provided by Amazon SageMaker, the inference - // code must meet Amazon SageMaker requirements. Amazon SageMaker supports both - // registry/repository[:tag] and registry/repository[@digest] image path formats. - // For more information, see Using Your Own Algorithms with Amazon SageMaker - // (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html) + // algorithm instead of an algorithm provided by SageMaker, the inference code + // must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] + // and registry/repository[@digest] image path formats. For more information, + // see Using Your Own Algorithms with Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html) Image *string `type:"string"` // Specifies whether the model container is in Amazon ECR or a private Docker @@ -29754,24 +29815,24 @@ type ContainerDefinition struct { // The S3 path where the model artifacts, which result from model training, // are stored. This path must point to a single gzip compressed tar archive - // (.tar.gz suffix). The S3 path is required for Amazon SageMaker built-in algorithms, + // (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, // but not if you use your own algorithms. For more information on built-in // algorithms, see Common Parameters (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html). // // The model artifacts must be in an S3 bucket that is in the same region as // the model or endpoint you are creating. // - // If you provide a value for this parameter, Amazon SageMaker uses Amazon Web - // Services Security Token Service to download model artifacts from the S3 path - // you provide. Amazon Web Services STS is activated in your IAM user account - // by default. If you previously deactivated Amazon Web Services STS for a region, - // you need to reactivate Amazon Web Services STS for that region. For more - // information, see Activating and Deactivating Amazon Web Services STS in an - // Amazon Web Services Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) + // If you provide a value for this parameter, SageMaker uses Amazon Web Services + // Security Token Service to download model artifacts from the S3 path you provide. + // Amazon Web Services STS is activated in your IAM user account by default. + // If you previously deactivated Amazon Web Services STS for a region, you need + // to reactivate Amazon Web Services STS for that region. For more information, + // see Activating and Deactivating Amazon Web Services STS in an Amazon Web + // Services Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) // in the Amazon Web Services Identity and Access Management User Guide. // - // If you use a built-in algorithm to create a model, Amazon SageMaker requires - // that you provide a S3 path to the model artifacts in ModelDataUrl. + // If you use a built-in algorithm to create a model, SageMaker requires that + // you provide a S3 path to the model artifacts in ModelDataUrl. ModelDataUrl *string `type:"string"` // The name or Amazon Resource Name (ARN) of the model package to use to create @@ -30046,7 +30107,7 @@ type ContinuousParameterRange struct { // // Auto // - // Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. + // SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. // // Linear // @@ -30418,10 +30479,9 @@ type CreateAlgorithmInput struct { // TrainingSpecification is a required field TrainingSpecification *TrainingSpecification `type:"structure" required:"true"` - // Specifies configurations for one or more training jobs and that Amazon SageMaker + // Specifies configurations for one or more training jobs and that SageMaker // runs to test the algorithm's training code and, optionally, one or more batch - // transform jobs that Amazon SageMaker runs to test the algorithm's inference - // code. + // transform jobs that SageMaker runs to test the algorithm's inference code. ValidationSpecification *AlgorithmValidationSpecification `type:"structure"` } @@ -32539,8 +32599,8 @@ type CreateEndpointConfigInput struct { EndpointConfigName *string `type:"string" required:"true"` // The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service - // key that Amazon SageMaker uses to encrypt data on the storage volume attached - // to the ML compute instance that hosts the endpoint. + // key that SageMaker uses to encrypt data on the storage volume attached to + // the ML compute instance that hosts the endpoint. // // The KmsKeyId can be any of the following formats: // @@ -33727,8 +33787,8 @@ func (s *CreateHyperParameterTuningJobInput) SetWarmStartConfig(v *HyperParamete type CreateHyperParameterTuningJobOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the tuning job. Amazon SageMaker assigns - // an ARN to a hyperparameter tuning job when you create it. + // The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN + // to a hyperparameter tuning job when you create it. // // HyperParameterTuningJobArn is a required field HyperParameterTuningJobArn *string `type:"string" required:"true"` @@ -33903,8 +33963,8 @@ type CreateImageVersionInput struct { _ struct{} `type:"structure"` // The registry path of the container image to use as the starting point for - // this version. The path is an Amazon Container Registry (ECR) URI in the following - // format: + // this version. The path is an Amazon Elastic Container Registry (ECR) URI + // in the following format: // // .dkr.ecr..amazonaws.com/ // @@ -35025,14 +35085,13 @@ type CreateModelInput struct { // made to or from the model container. EnableNetworkIsolation *bool `type:"boolean"` - // The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can - // assume to access model artifacts and docker image for deployment on ML compute - // instances or for batch transform jobs. Deploying on ML compute instances - // is part of model hosting. For more information, see Amazon SageMaker Roles - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). + // The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume + // to access model artifacts and docker image for deployment on ML compute instances + // or for batch transform jobs. Deploying on ML compute instances is part of + // model hosting. For more information, see SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). // - // To be able to pass this role to Amazon SageMaker, the caller of this API - // must have the iam:PassRole permission. + // To be able to pass this role to SageMaker, the caller of this API must have + // the iam:PassRole permission. // // ExecutionRoleArn is a required field ExecutionRoleArn *string `min:"20" type:"string" required:"true"` @@ -35188,7 +35247,7 @@ func (s *CreateModelInput) SetVpcConfig(v *VpcConfig) *CreateModelInput { type CreateModelOutput struct { _ struct{} `type:"structure"` - // The ARN of the model created in Amazon SageMaker. + // The ARN of the model created in SageMaker. // // ModelArn is a required field ModelArn *string `min:"20" type:"string" required:"true"` @@ -35423,8 +35482,8 @@ type CreateModelPackageInput struct { // learning tasks include object detection and image classification. Task *string `type:"string"` - // Specifies configurations for one or more transform jobs that Amazon SageMaker - // runs to test the model package. + // Specifies configurations for one or more transform jobs that SageMaker runs + // to test the model package. ValidationSpecification *ModelPackageValidationSpecification `type:"structure"` } @@ -36035,8 +36094,7 @@ type CreateNotebookInstanceInput struct { // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or // in any other Git repository. These repositories are cloned at the same level // as the default repository of your notebook instance. For more information, - // see Associating Git Repositories with Amazon SageMaker Notebook Instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + // see Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). AdditionalCodeRepositories []*string `type:"list"` // A Git repository to associate with the notebook instance as its default code @@ -36045,13 +36103,13 @@ type CreateNotebookInstanceInput struct { // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or // in any other Git repository. When you open a notebook instance, it opens // in the directory that contains this repository. For more information, see - // Associating Git Repositories with Amazon SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + // Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). DefaultCodeRepository *string `min:"1" type:"string"` - // Sets whether Amazon SageMaker provides internet access to the notebook instance. + // Sets whether SageMaker provides internet access to the notebook instance. // If you set this to Disabled this notebook instance is able to access resources - // only in your VPC, and is not be able to connect to Amazon SageMaker training - // and endpoint services unless you configure a NAT Gateway in your VPC. + // only in your VPC, and is not be able to connect to SageMaker training and + // endpoint services unless you configure a NAT Gateway in your VPC. // // For more information, see Notebook Instances Are Internet-Enabled by Default // (https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access). @@ -36065,8 +36123,8 @@ type CreateNotebookInstanceInput struct { InstanceType *string `type:"string" required:"true" enum:"InstanceType"` // The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service - // key that Amazon SageMaker uses to encrypt data on the storage volume attached - // to your notebook instance. The KMS key you provide must be enabled. For information, + // key that SageMaker uses to encrypt data on the storage volume attached to + // your notebook instance. The KMS key you provide must be enabled. For information, // see Enabling and Disabling Keys (https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html) // in the Amazon Web Services Key Management Service Developer Guide. KmsKeyId *string `type:"string"` @@ -36085,14 +36143,14 @@ type CreateNotebookInstanceInput struct { PlatformIdentifier *string `type:"string"` // When you send any requests to Amazon Web Services resources from the notebook - // instance, Amazon SageMaker assumes this role to perform tasks on your behalf. - // You must grant this role necessary permissions so Amazon SageMaker can perform - // these tasks. The policy must allow the Amazon SageMaker service principal - // (sagemaker.amazonaws.com) permissions to assume this role. For more information, - // see Amazon SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). + // instance, SageMaker assumes this role to perform tasks on your behalf. You + // must grant this role necessary permissions so SageMaker can perform these + // tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) + // permissions to assume this role. For more information, see SageMaker Roles + // (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). // - // To be able to pass this role to Amazon SageMaker, the caller of this API - // must have the iam:PassRole permission. + // To be able to pass this role to SageMaker, the caller of this API must have + // the iam:PassRole permission. // // RoleArn is a required field RoleArn *string `min:"20" type:"string" required:"true"` @@ -37355,7 +37413,7 @@ type CreateTrainingJobInput struct { // The registry path of the Docker image that contains the training algorithm // and algorithm-specific metadata, including the input mode. For more information - // about algorithms provided by Amazon SageMaker, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). + // about algorithms provided by SageMaker, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). // For information about providing your own algorithms, see Using Your Own Algorithms // with Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html). // @@ -37399,9 +37457,9 @@ type CreateTrainingJobInput struct { // Isolates the training container. No inbound or outbound network calls can // be made, except for calls between peers within a training cluster for distributed // training. If you enable network isolation for training jobs that are configured - // to use a VPC, Amazon SageMaker downloads and uploads customer data and model - // artifacts through the specified VPC, but the training container does not - // have network access. + // to use a VPC, SageMaker downloads and uploads customer data and model artifacts + // through the specified VPC, but the training container does not have network + // access. EnableNetworkIsolation *bool `type:"boolean"` // The environment variables to set in the Docker container. @@ -37419,8 +37477,8 @@ type CreateTrainingJobInput struct { // Algorithm-specific parameters that influence the quality of the model. You // set hyperparameters before you start the learning process. For a list of - // hyperparameters for each training algorithm provided by Amazon SageMaker, - // see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). + // hyperparameters for each training algorithm provided by SageMaker, see Algorithms + // (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html). // // You can specify a maximum of 100 hyperparameters. Each hyperparameter is // a key-value pair. Each key and value is limited to 256 characters, as specified @@ -37437,15 +37495,15 @@ type CreateTrainingJobInput struct { // data: the MIME type, compression method, and whether the data is wrapped // in RecordIO format. // - // Depending on the input mode that the algorithm supports, Amazon SageMaker - // either copies input data files from an S3 bucket to a local directory in - // the Docker container, or makes it available as input streams. For example, - // if you specify an EFS location, input data files will be made available as - // input streams. They do not need to be downloaded. + // Depending on the input mode that the algorithm supports, SageMaker either + // copies input data files from an S3 bucket to a local directory in the Docker + // container, or makes it available as input streams. For example, if you specify + // an EFS location, input data files are available as input streams. They do + // not need to be downloaded. InputDataConfig []*Channel `min:"1" type:"list"` // Specifies the path to the S3 location where you want to store model artifacts. - // Amazon SageMaker creates subfolders for the artifacts. + // SageMaker creates subfolders for the artifacts. // // OutputDataConfig is a required field OutputDataConfig *OutputDataConfig `type:"structure" required:"true"` @@ -37463,9 +37521,9 @@ type CreateTrainingJobInput struct { // // ML storage volumes store model artifacts and incremental states. Training // algorithms might also use ML storage volumes for scratch space. If you want - // Amazon SageMaker to use the ML storage volume to store the training data, - // choose File as the TrainingInputMode in the algorithm specification. For - // distributed training algorithms, specify an instance count greater than 1. + // SageMaker to use the ML storage volume to store the training data, choose + // File as the TrainingInputMode in the algorithm specification. For distributed + // training algorithms, specify an instance count greater than 1. // // ResourceConfig is a required field ResourceConfig *ResourceConfig `type:"structure" required:"true"` @@ -37473,30 +37531,29 @@ type CreateTrainingJobInput struct { // The number of times to retry the job when the job fails due to an InternalServerError. RetryStrategy *RetryStrategy `type:"structure"` - // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume - // to perform tasks on your behalf. + // The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to + // perform tasks on your behalf. // - // During model training, Amazon SageMaker needs your permission to read input - // data from an S3 bucket, download a Docker image that contains training code, - // write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, - // and publish metrics to Amazon CloudWatch. You grant permissions for all of - // these tasks to an IAM role. For more information, see Amazon SageMaker Roles - // (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). + // During model training, SageMaker needs your permission to read input data + // from an S3 bucket, download a Docker image that contains training code, write + // model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and + // publish metrics to Amazon CloudWatch. You grant permissions for all of these + // tasks to an IAM role. For more information, see SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). // - // To be able to pass this role to Amazon SageMaker, the caller of this API - // must have the iam:PassRole permission. + // To be able to pass this role to SageMaker, the caller of this API must have + // the iam:PassRole permission. // // RoleArn is a required field RoleArn *string `min:"20" type:"string" required:"true"` // Specifies a limit to how long a model training job can run. It also specifies // how long a managed Spot training job has to complete. When the job reaches - // the time limit, Amazon SageMaker ends the training job. Use this API to cap - // model training costs. + // the time limit, SageMaker ends the training job. Use this API to cap model + // training costs. // - // To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which - // delays job termination for 120 seconds. Algorithms can use this 120-second - // window to save the model artifacts, so the results of training are not lost. + // To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays + // job termination for 120 seconds. Algorithms can use this 120-second window + // to save the model artifacts, so the results of training are not lost. // // StoppingCondition is a required field StoppingCondition *StoppingCondition `type:"structure" required:"true"` @@ -37894,6 +37951,10 @@ type CreateTransformJobInput struct { // ensure that the records fit within the maximum payload size, we recommend // using a slightly larger value. The default value is 6 MB. // + // The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify + // the MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms + // * MaxPayloadInMB) also cannot exceed 100 MB. + // // For cases where the payload might be arbitrarily large and is transmitted // using HTTP chunked encoding, set the value to 0. This feature works only // in supported algorithms. Currently, Amazon SageMaker built-in algorithms @@ -39317,8 +39378,8 @@ type DataProcessing struct { // A JSONPath (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators) // expression used to select a portion of the input data to pass to the algorithm. // Use the InputFilter parameter to exclude fields, such as an ID column, from - // the input. If you want Amazon SageMaker to pass the entire input dataset - // to the algorithm, accept the default value $. + // the input. If you want SageMaker to pass the entire input dataset to the + // algorithm, accept the default value $. // // Examples: "$", "$[1:]", "$.features" InputFilter *string `type:"string"` @@ -39348,10 +39409,10 @@ type DataProcessing struct { // A JSONPath (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html#data-processing-operators) // expression used to select a portion of the joined dataset to save in the - // output file for a batch transform job. If you want Amazon SageMaker to store - // the entire input dataset in the output file, leave the default value, $. - // If you specify indexes that aren't within the dimension size of the joined - // dataset, you get an error. + // output file for a batch transform job. If you want SageMaker to store the + // entire input dataset in the output file, leave the default value, $. If you + // specify indexes that aren't within the dimension size of the joined dataset, + // you get an error. // // Examples: "$", "$[0,5:]", "$['id','SageMakerOutput']" OutputFilter *string `type:"string"` @@ -42089,7 +42150,7 @@ func (s DeleteMonitoringScheduleOutput) GoString() string { type DeleteNotebookInstanceInput struct { _ struct{} `type:"structure"` - // The name of the Amazon SageMaker notebook instance to delete. + // The name of the SageMaker notebook instance to delete. // // NotebookInstanceName is a required field NotebookInstanceName *string `type:"string" required:"true"` @@ -43435,7 +43496,7 @@ type DescribeAlgorithmOutput struct { // TrainingSpecification is a required field TrainingSpecification *TrainingSpecification `type:"structure" required:"true"` - // Details about configurations for one or more training jobs that Amazon SageMaker + // Details about configurations for one or more training jobs that SageMaker // runs to test the algorithm. ValidationSpecification *AlgorithmValidationSpecification `type:"structure"` } @@ -45958,7 +46019,7 @@ type DescribeEndpointConfigOutput struct { // EndpointConfigArn is a required field EndpointConfigArn *string `min:"20" type:"string" required:"true"` - // Name of the Amazon SageMaker endpoint configuration. + // Name of the SageMaker endpoint configuration. // // EndpointConfigName is a required field EndpointConfigName *string `type:"string" required:"true"` @@ -47863,8 +47924,8 @@ type DescribeLabelingJobOutput struct { // OutputConfig is a required field OutputConfig *LabelingJobOutputConfig `type:"structure" required:"true"` - // The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks - // on your behalf during data labeling. + // The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on + // your behalf during data labeling. // // RoleArn is a required field RoleArn *string `min:"20" type:"string" required:"true"` @@ -48607,7 +48668,7 @@ type DescribeModelOutput struct { // ModelArn is a required field ModelArn *string `min:"20" type:"string" required:"true"` - // Name of the Amazon SageMaker model. + // Name of the SageMaker model. // // ModelName is a required field ModelName *string `type:"string" required:"true"` @@ -48697,7 +48758,7 @@ func (s *DescribeModelOutput) SetVpcConfig(v *VpcConfig) *DescribeModelOutput { type DescribeModelPackageGroupInput struct { _ struct{} `type:"structure"` - // The name of the model group to describe. + // The name of gthe model group to describe. // // ModelPackageGroupName is a required field ModelPackageGroupName *string `min:"1" type:"string" required:"true"` @@ -48928,7 +48989,7 @@ type DescribeModelPackageOutput struct { // trial component, lineage group, or project. LastModifiedBy *UserContext `type:"structure"` - // The last time the model package was modified. + // The last time that the model package was modified. LastModifiedTime *time.Time `type:"timestamp"` // Metadata properties of the tracking entity, trial, or trial component. @@ -49713,8 +49774,7 @@ type DescribeNotebookInstanceOutput struct { // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or // in any other Git repository. These repositories are cloned at the same level // as the default repository of your notebook instance. For more information, - // see Associating Git Repositories with Amazon SageMaker Notebook Instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + // see Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). AdditionalCodeRepositories []*string `type:"list"` // A timestamp. Use this parameter to return the time when the notebook instance @@ -49727,13 +49787,12 @@ type DescribeNotebookInstanceOutput struct { // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or // in any other Git repository. When you open a notebook instance, it opens // in the directory that contains this repository. For more information, see - // Associating Git Repositories with Amazon SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + // Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). DefaultCodeRepository *string `min:"1" type:"string"` - // Describes whether Amazon SageMaker provides internet access to the notebook - // instance. If this value is set to Disabled, the notebook instance does not - // have internet access, and cannot connect to Amazon SageMaker training and - // endpoint services. + // Describes whether SageMaker provides internet access to the notebook instance. + // If this value is set to Disabled, the notebook instance does not have internet + // access, and cannot connect to SageMaker training and endpoint services. // // For more information, see Notebook Instances Are Internet-Enabled by Default // (https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access). @@ -49745,15 +49804,15 @@ type DescribeNotebookInstanceOutput struct { // The type of ML compute instance running on the notebook instance. InstanceType *string `type:"string" enum:"InstanceType"` - // The Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data - // when storing it on the ML storage volume attached to the instance. + // The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing + // it on the ML storage volume attached to the instance. KmsKeyId *string `type:"string"` // A timestamp. Use this parameter to retrieve the time when the notebook instance // was last modified. LastModifiedTime *time.Time `type:"timestamp"` - // The network interface IDs that Amazon SageMaker created at the time of creating + // The network interface IDs that SageMaker created at the time of creating // the instance. NetworkInterfaceId *string `type:"string"` @@ -49766,7 +49825,7 @@ type DescribeNotebookInstanceOutput struct { // 2.1: (Optional) Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) NotebookInstanceLifecycleConfigName *string `type:"string"` - // The name of the Amazon SageMaker notebook instance. + // The name of the SageMaker notebook instance. NotebookInstanceName *string `type:"string"` // The status of the notebook instance. @@ -51129,8 +51188,8 @@ type DescribeTrainingJobOutput struct { // time. // // Multiply BillableTimeInSeconds by the number of instances (InstanceCount) - // in your training cluster to get the total compute time SageMaker will bill - // you if you run distributed training. The formula is as follows: BillableTimeInSeconds + // in your training cluster to get the total compute time SageMaker bills you + // if you run distributed training. The formula is as follows: BillableTimeInSeconds // * InstanceCount . // // You can calculate the savings from using managed spot training using the @@ -51174,9 +51233,9 @@ type DescribeTrainingJobOutput struct { // If you want to allow inbound or outbound network calls, except for calls // between peers within a training cluster for distributed training, choose // True. If you enable network isolation for training jobs that are configured - // to use a VPC, Amazon SageMaker downloads and uploads customer data and model - // artifacts through the specified VPC, but the training container does not - // have network access. + // to use a VPC, SageMaker downloads and uploads customer data and model artifacts + // through the specified VPC, but the training container does not have network + // access. EnableNetworkIsolation *bool `type:"boolean"` // The environment variables to set in the Docker container. @@ -51205,8 +51264,8 @@ type DescribeTrainingJobOutput struct { // An array of Channel objects that describes each data input channel. InputDataConfig []*Channel `min:"1" type:"list"` - // The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling - // job that created the transform or training job. + // The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job + // that created the transform or training job. LabelingJobArn *string `type:"string"` // A timestamp that indicates when the status of the training job was last modified. @@ -51219,7 +51278,7 @@ type DescribeTrainingJobOutput struct { ModelArtifacts *ModelArtifacts `type:"structure" required:"true"` // The S3 path where model artifacts that you configured when creating the job - // are stored. Amazon SageMaker creates subfolders for model artifacts. + // are stored. SageMaker creates subfolders for model artifacts. OutputDataConfig *OutputDataConfig `type:"structure"` // Configuration information for Debugger system monitoring, framework profiling, @@ -51253,8 +51312,8 @@ type DescribeTrainingJobOutput struct { // information on the secondary status of the training job, see StatusMessage // under SecondaryStatusTransition. // - // Amazon SageMaker provides primary statuses and secondary statuses that apply - // to each of them: + // SageMaker provides primary statuses and secondary statuses that apply to + // each of them: // // InProgress // @@ -51314,12 +51373,12 @@ type DescribeTrainingJobOutput struct { // Specifies a limit to how long a model training job can run. It also specifies // how long a managed Spot training job has to complete. When the job reaches - // the time limit, Amazon SageMaker ends the training job. Use this API to cap - // model training costs. + // the time limit, SageMaker ends the training job. Use this API to cap model + // training costs. // - // To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which - // delays job termination for 120 seconds. Algorithms can use this 120-second - // window to save the model artifacts, so the results of training are not lost. + // To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays + // job termination for 120 seconds. Algorithms can use this 120-second window + // to save the model artifacts, so the results of training are not lost. // // StoppingCondition is a required field StoppingCondition *StoppingCondition `type:"structure" required:"true"` @@ -51330,7 +51389,7 @@ type DescribeTrainingJobOutput struct { // Indicates the time when the training job ends on training instances. You // are billed for the time interval between the value of TrainingStartTime and // this time. For successful jobs and stopped jobs, this is the time after model - // artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker + // artifacts are uploaded. For failed jobs, this is the time when SageMaker // detects a job failure. TrainingEndTime *time.Time `type:"timestamp"` @@ -51346,7 +51405,7 @@ type DescribeTrainingJobOutput struct { // The status of the training job. // - // Amazon SageMaker provides the following training job statuses: + // SageMaker provides the following training job statuses: // // * InProgress - The training is in progress. // @@ -58469,7 +58528,7 @@ type HyperParameterAlgorithmSpecification struct { // The registry path of the Docker image that contains the training algorithm. // For information about Docker registry paths for built-in algorithms, see // Algorithms Provided by Amazon SageMaker: Common Parameters (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html). - // Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] + // SageMaker supports both registry/repository[:tag] and registry/repository[@digest] // image path formats. For more information, see Using Your Own Algorithms with // Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html). TrainingImage *string `type:"string"` @@ -58728,9 +58787,9 @@ type HyperParameterTrainingJobDefinition struct { // Isolates the training container. No inbound or outbound network calls can // be made, except for calls between peers within a training cluster for distributed // training. If network isolation is used for training jobs that are configured - // to use a VPC, Amazon SageMaker downloads and uploads customer data and model - // artifacts through the specified VPC, but the training container does not - // have network access. + // to use a VPC, SageMaker downloads and uploads customer data and model artifacts + // through the specified VPC, but the training container does not have network + // access. EnableNetworkIsolation *bool `type:"boolean"` // Specifies ranges of integer, continuous, and categorical hyperparameters @@ -58759,10 +58818,10 @@ type HyperParameterTrainingJobDefinition struct { // for the training jobs that the tuning job launches. // // Storage volumes store model artifacts and incremental states. Training algorithms - // might also use storage volumes for scratch space. If you want Amazon SageMaker - // to use the storage volume to store the training data, choose File as the - // TrainingInputMode in the algorithm specification. For distributed training - // algorithms, specify an instance count greater than 1. + // might also use storage volumes for scratch space. If you want SageMaker to + // use the storage volume to store the training data, choose File as the TrainingInputMode + // in the algorithm specification. For distributed training algorithms, specify + // an instance count greater than 1. // // ResourceConfig is a required field ResourceConfig *ResourceConfig `type:"structure" required:"true"` @@ -58782,8 +58841,8 @@ type HyperParameterTrainingJobDefinition struct { // Specifies a limit to how long a model hyperparameter training job can run. // It also specifies how long a managed spot training job has to complete. When - // the job reaches the time limit, Amazon SageMaker ends the training job. Use - // this API to cap model training costs. + // the job reaches the time limit, SageMaker ends the training job. Use this + // API to cap model training costs. // // StoppingCondition is a required field StoppingCondition *StoppingCondition `type:"structure" required:"true"` @@ -59004,7 +59063,7 @@ func (s *HyperParameterTrainingJobDefinition) SetVpcConfig(v *VpcConfig) *HyperP return s } -// Specifies summary information about a training job. +// The container for the summary information about a training job. type HyperParameterTrainingJobSummary struct { _ struct{} `type:"structure"` @@ -59038,7 +59097,7 @@ type HyperParameterTrainingJobSummary struct { // Specifies the time when the training job ends on training instances. You // are billed for the time interval between the value of TrainingStartTime and // this time. For successful jobs and stopped jobs, this is the time after model - // artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker + // artifacts are uploaded. For failed jobs, this is the time when SageMaker // detects a job failure. TrainingEndTime *time.Time `type:"timestamp"` @@ -59200,9 +59259,9 @@ type HyperParameterTuningJobConfig struct { // // AUTO // - // Amazon SageMaker stops training jobs launched by the hyperparameter tuning - // job when they are unlikely to perform better than previously completed training - // jobs. For more information, see Stop Training Jobs Early (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html). + // SageMaker stops training jobs launched by the hyperparameter tuning job when + // they are unlikely to perform better than previously completed training jobs. + // For more information, see Stop Training Jobs Early (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html). TrainingJobEarlyStoppingType *string `type:"string" enum:"TrainingJobEarlyStoppingType"` // The tuning job's completion criteria. @@ -60477,7 +60536,7 @@ type IntegerParameterRange struct { // // Auto // - // Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. + // SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. // // Linear // @@ -60621,11 +60680,16 @@ type JupyterServerAppSettings struct { _ struct{} `type:"structure"` // The default instance type and the Amazon Resource Name (ARN) of the default - // SageMaker image used by the JupyterServer app. + // SageMaker image used by the JupyterServer app. If you use the LifecycleConfigArns + // parameter, then this parameter is also required. DefaultResourceSpec *ResourceSpec `type:"structure"` // The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to - // the JupyterServerApp. + // the JupyterServerApp. If you use this parameter, the DefaultResourceSpec + // parameter is also required. + // + // To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty + // list. LifecycleConfigArns []*string `type:"list"` } @@ -60669,10 +60733,18 @@ type KernelGatewayAppSettings struct { // The default instance type and the Amazon Resource Name (ARN) of the default // SageMaker image used by the KernelGateway app. + // + // The Amazon SageMaker Studio UI does not use the default instance type value + // set here. The default instance type set here is used when Apps are created + // using the Amazon Web Services Command Line Interface or Amazon Web Services + // CloudFormation and the instance type parameter value is not passed. DefaultResourceSpec *ResourceSpec `type:"structure"` // The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to // the the user profile or domain. + // + // To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty + // list. LifecycleConfigArns []*string `type:"list"` } @@ -61064,8 +61136,8 @@ type LabelingJobDataAttributes struct { _ struct{} `type:"structure"` // Declares that your content is free of personally identifiable information - // or adult content. Amazon SageMaker may restrict the Amazon Mechanical Turk - // workers that can view your task based on this information. + // or adult content. SageMaker may restrict the Amazon Mechanical Turk workers + // that can view your task based on this information. ContentClassifiers []*string `type:"list" enum:"ContentClassifier"` } @@ -61315,8 +61387,8 @@ func (s *LabelingJobInputConfig) SetDataSource(v *LabelingJobDataSource) *Labeli type LabelingJobOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) for the most recent Amazon SageMaker model - // trained as part of automated data labeling. + // The Amazon Resource Name (ARN) for the most recent SageMaker model trained + // as part of automated data labeling. FinalActiveLearningModelArn *string `min:"20" type:"string"` // The Amazon S3 bucket location of the manifest file for labeled data. @@ -62186,8 +62258,8 @@ type ListAlgorithmsOutput struct { // AlgorithmSummaryList is a required field AlgorithmSummaryList []*AlgorithmSummary `type:"list" required:"true"` - // If the response is truncated, Amazon SageMaker returns this token. To retrieve - // the next set of algorithms, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of algorithms, use it in the subsequent request. NextToken *string `type:"string"` } @@ -64475,8 +64547,8 @@ type ListEndpointConfigsOutput struct { // EndpointConfigs is a required field EndpointConfigs []*EndpointConfigSummary `type:"list" required:"true"` - // If the response is truncated, Amazon SageMaker returns this token. To retrieve - // the next set of endpoint configurations, use it in the subsequent request + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of endpoint configurations, use it in the subsequent request NextToken *string `type:"string"` } @@ -64651,8 +64723,8 @@ type ListEndpointsOutput struct { // Endpoints is a required field Endpoints []*EndpointSummary `type:"list" required:"true"` - // If the response is truncated, Amazon SageMaker returns this token. To retrieve - // the next set of training jobs, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of training jobs, use it in the subsequent request. NextToken *string `type:"string"` } @@ -66041,8 +66113,8 @@ type ListLabelingJobsForWorkteamOutput struct { // LabelingJobSummaryList is a required field LabelingJobSummaryList []*LabelingJobForWorkteamSummary `type:"list" required:"true"` - // If the response is truncated, Amazon SageMaker returns this token. To retrieve - // the next set of labeling jobs, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of labeling jobs, use it in the subsequent request. NextToken *string `type:"string"` } @@ -66214,8 +66286,8 @@ type ListLabelingJobsOutput struct { // An array of LabelingJobSummary objects, each describing a labeling job. LabelingJobSummaryList []*LabelingJobSummary `type:"list"` - // If the response is truncated, Amazon SageMaker returns this token. To retrieve - // the next set of labeling jobs, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of labeling jobs, use it in the subsequent request. NextToken *string `type:"string"` } @@ -67103,8 +67175,8 @@ type ListModelPackagesOutput struct { // ModelPackageSummaryList is a required field ModelPackageSummaryList []*ModelPackageSummary `type:"list" required:"true"` - // If the response is truncated, Amazon SageMaker returns this token. To retrieve - // the next set of model packages, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of model packages, use it in the subsequent request. NextToken *string `type:"string"` } @@ -67405,8 +67477,8 @@ type ListModelsOutput struct { // Models is a required field Models []*ModelSummary `type:"list" required:"true"` - // If the response is truncated, Amazon SageMaker returns this token. To retrieve - // the next set of models, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of models, use it in the subsequent request. NextToken *string `type:"string"` } @@ -67999,8 +68071,8 @@ func (s *ListNotebookInstanceLifecycleConfigsInput) SetSortOrder(v string) *List type ListNotebookInstanceLifecycleConfigsOutput struct { _ struct{} `type:"structure"` - // If the response is truncated, Amazon SageMaker returns this token. To get - // the next set of lifecycle configurations, use it in the next request. + // If the response is truncated, SageMaker returns this token. To get the next + // set of lifecycle configurations, use it in the next request. NextToken *string `type:"string"` // An array of NotebookInstanceLifecycleConfiguration objects, each listing @@ -68214,8 +68286,8 @@ type ListNotebookInstancesOutput struct { _ struct{} `type:"structure"` // If the response to the previous ListNotebookInstances request was truncated, - // Amazon SageMaker returns this token. To retrieve the next set of notebook - // instances, use the token in the next request. + // SageMaker returns this token. To retrieve the next set of notebook instances, + // use the token in the next request. NextToken *string `type:"string"` // An array of NotebookInstanceSummary objects, one for each notebook instance. @@ -69395,7 +69467,7 @@ type ListTagsInput struct { // Maximum number of tags to return. MaxResults *int64 `min:"50" type:"integer"` - // If the response to the previous ListTags request is truncated, Amazon SageMaker + // If the response to the previous ListTags request is truncated, SageMaker // returns this token. To retrieve the next set of tags, use it in the subsequent // request. NextToken *string `type:"string"` @@ -69461,8 +69533,8 @@ func (s *ListTagsInput) SetResourceArn(v string) *ListTagsInput { type ListTagsOutput struct { _ struct{} `type:"structure"` - // If response is truncated, Amazon SageMaker includes a token in the response. - // You can use this token in your subsequent request to fetch next set of tokens. + // If response is truncated, SageMaker includes a token in the response. You + // can use this token in your subsequent request to fetch next set of tokens. NextToken *string `type:"string"` // An array of Tag objects, each with a tag key and a value. @@ -69781,8 +69853,8 @@ func (s *ListTrainingJobsInput) SetStatusEquals(v string) *ListTrainingJobsInput type ListTrainingJobsOutput struct { _ struct{} `type:"structure"` - // If the response is truncated, Amazon SageMaker returns this token. To retrieve - // the next set of training jobs, use it in the subsequent request. + // If the response is truncated, SageMaker returns this token. To retrieve the + // next set of training jobs, use it in the subsequent request. NextToken *string `type:"string"` // An array of TrainingJobSummary objects, each listing a training job. @@ -70930,7 +71002,7 @@ func (s *MetricDatum) SetValue(v float64) *MetricDatum { } // Specifies a metric that the training algorithm writes to stderr or stdout. -// Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify +// SageMakerhyperparameter tuning captures all defined metrics. You specify // one metric that a hyperparameter tuning job uses as its objective metric // to choose the best training job. type MetricDefinition struct { @@ -71301,10 +71373,12 @@ func (s *ModelBiasJobInput) SetGroundTruthS3Input(v *MonitoringGroundTruthS3Inpu type ModelClientConfig struct { _ struct{} `type:"structure"` - // The maximum number of retries when invocation requests are failing. + // The maximum number of retries when invocation requests are failing. The default + // value is 3. InvocationsMaxRetries *int64 `type:"integer"` - // The timeout value in seconds for an invocation request. + // The timeout value in seconds for an invocation request. The default value + // is 600. InvocationsTimeoutInSeconds *int64 `min:"1" type:"integer"` } @@ -72232,8 +72306,8 @@ type ModelPackage struct { // learning tasks include object detection and image classification. Task *string `type:"string"` - // Specifies batch transform jobs that Amazon SageMaker runs to validate your - // model package. + // Specifies batch transform jobs that SageMaker runs to validate your model + // package. ValidationSpecification *ModelPackageValidationSpecification `type:"structure"` } @@ -72433,8 +72507,8 @@ type ModelPackageContainerDefinition struct { // is stored. // // If you are using your own custom algorithm instead of an algorithm provided - // by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. - // Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] + // by SageMaker, the inference code must meet SageMaker requirements. SageMaker + // supports both registry/repository[:tag] and registry/repository[@digest] // image path formats. For more information, see Using Your Own Algorithms with // Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html). // @@ -73022,13 +73096,13 @@ func (s *ModelPackageValidationProfile) SetTransformJobDefinition(v *TransformJo return s } -// Specifies batch transform jobs that Amazon SageMaker runs to validate your -// model package. +// Specifies batch transform jobs that SageMaker runs to validate your model +// package. type ModelPackageValidationSpecification struct { _ struct{} `type:"structure"` // An array of ModelPackageValidationProfile objects, each of which specifies - // a batch transform job that Amazon SageMaker runs to validate your model package. + // a batch transform job that SageMaker runs to validate your model package. // // ValidationProfiles is a required field ValidationProfiles []*ModelPackageValidationProfile `min:"1" type:"list" required:"true"` @@ -75364,7 +75438,7 @@ func (s *NotebookInstanceLifecycleHook) SetContent(v string) *NotebookInstanceLi return s } -// Provides summary information for an Amazon SageMaker notebook instance. +// Provides summary information for an SageMaker notebook instance. type NotebookInstanceSummary struct { _ struct{} `type:"structure"` @@ -75374,8 +75448,7 @@ type NotebookInstanceSummary struct { // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or // in any other Git repository. These repositories are cloned at the same level // as the default repository of your notebook instance. For more information, - // see Associating Git Repositories with Amazon SageMaker Notebook Instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + // see Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). AdditionalCodeRepositories []*string `type:"list"` // A timestamp that shows when the notebook instance was created. @@ -75387,7 +75460,7 @@ type NotebookInstanceSummary struct { // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or // in any other Git repository. When you open a notebook instance, it opens // in the directory that contains this repository. For more information, see - // Associating Git Repositories with Amazon SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + // Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). DefaultCodeRepository *string `min:"1" type:"string"` // The type of ML compute instance that the notebook instance is running on. @@ -75416,7 +75489,7 @@ type NotebookInstanceSummary struct { // The status of the notebook instance. NotebookInstanceStatus *string `type:"string" enum:"NotebookInstanceStatus"` - // The URL that you use to connect to the Jupyter instance running in your notebook + // The URL that you use to connect to the Jupyter notebook running in your notebook // instance. Url *string `type:"string"` } @@ -76318,9 +76391,8 @@ type OutputDataConfig struct { _ struct{} `type:"structure"` // The Amazon Web Services Key Management Service (Amazon Web Services KMS) - // key that Amazon SageMaker uses to encrypt the model artifacts at rest using - // Amazon S3 server-side encryption. The KmsKeyId can be any of the following - // formats: + // key that SageMaker uses to encrypt the model artifacts at rest using Amazon + // S3 server-side encryption. The KmsKeyId can be any of the following formats: // // * // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // @@ -76330,14 +76402,14 @@ type OutputDataConfig struct { // // * // Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" // - // If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker - // execution role must include permissions to call kms:Encrypt. If you don't - // provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon - // S3 for your role's account. Amazon SageMaker uses server-side encryption - // with KMS-managed keys for OutputDataConfig. If you use a bucket policy with - // an s3:PutObject permission that only allows objects with server-side encryption, - // set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For - // more information, see KMS-Managed Encryption Keys (https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html) + // If you use a KMS key ID or an alias of your KMS key, the SageMaker execution + // role must include permissions to call kms:Encrypt. If you don't provide a + // KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's + // account. SageMaker uses server-side encryption with KMS-managed keys for + // OutputDataConfig. If you use a bucket policy with an s3:PutObject permission + // that only allows objects with server-side encryption, set the condition key + // of s3:x-amz-server-side-encryption to "aws:kms". For more information, see + // KMS-Managed Encryption Keys (https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html) // in the Amazon Simple Storage Service Developer Guide. // // The KMS key policy must grant permission to the IAM role that you specify @@ -76347,8 +76419,8 @@ type OutputDataConfig struct { // in the Amazon Web Services Key Management Service Developer Guide. KmsKeyId *string `type:"string"` - // Identifies the S3 path where you want Amazon SageMaker to store the model - // artifacts. For example, s3://bucket-name/key-name-prefix. + // Identifies the S3 path where you want SageMaker to store the model artifacts. + // For example, s3://bucket-name/key-name-prefix. // // S3OutputPath is a required field S3OutputPath *string `type:"string" required:"true"` @@ -76915,9 +76987,6 @@ type PendingProductionVariantSummary struct { CurrentInstanceCount *int64 `type:"integer"` // The serverless configuration for the endpoint. - // - // Serverless Inference is in preview release for Amazon SageMaker and is subject - // to change. We do not recommend using this feature in production environments. CurrentServerlessConfig *ProductionVariantServerlessConfig `type:"structure"` // The weight associated with the variant. @@ -76934,9 +77003,6 @@ type PendingProductionVariantSummary struct { // The serverless configuration requested for this deployment, as specified // in the endpoint configuration for the endpoint. - // - // Serverless Inference is in preview release for Amazon SageMaker and is subject - // to change. We do not recommend using this feature in production environments. DesiredServerlessConfig *ProductionVariantServerlessConfig `type:"structure"` // The requested weight for the variant in this deployment, as specified in @@ -79080,8 +79146,8 @@ func (s *ProcessingStoppingCondition) SetMaxRuntimeInSeconds(v int64) *Processin } // Identifies a model that you want to host and the resources chosen to deploy -// for hosting it. If you are deploying multiple models, tell Amazon SageMaker -// how to distribute traffic among the models by specifying variant weights. +// for hosting it. If you are deploying multiple models, tell SageMaker how +// to distribute traffic among the models by specifying variant weights. type ProductionVariant struct { _ struct{} `type:"structure"` @@ -79114,9 +79180,6 @@ type ProductionVariant struct { // The serverless configuration for an endpoint. Specifies a serverless endpoint // configuration instead of an instance-based endpoint configuration. - // - // Serverless Inference is in preview release for Amazon SageMaker and is subject - // to change. We do not recommend using this feature in production environments. ServerlessConfig *ProductionVariantServerlessConfig `type:"structure"` // The name of the production variant. @@ -79231,9 +79294,8 @@ type ProductionVariantCoreDumpConfig struct { DestinationS3Uri *string `type:"string" required:"true"` // The Amazon Web Services Key Management Service (Amazon Web Services KMS) - // key that Amazon SageMaker uses to encrypt the core dump data at rest using - // Amazon S3 server-side encryption. The KmsKeyId can be any of the following - // formats: + // key that SageMaker uses to encrypt the core dump data at rest using Amazon + // S3 server-side encryption. The KmsKeyId can be any of the following formats: // // * // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // @@ -79243,14 +79305,14 @@ type ProductionVariantCoreDumpConfig struct { // // * // Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" // - // If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker - // execution role must include permissions to call kms:Encrypt. If you don't - // provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon - // S3 for your role's account. Amazon SageMaker uses server-side encryption - // with KMS-managed keys for OutputDataConfig. If you use a bucket policy with - // an s3:PutObject permission that only allows objects with server-side encryption, - // set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For - // more information, see KMS-Managed Encryption Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) + // If you use a KMS key ID or an alias of your KMS key, the SageMaker execution + // role must include permissions to call kms:Encrypt. If you don't provide a + // KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's + // account. SageMaker uses server-side encryption with KMS-managed keys for + // OutputDataConfig. If you use a bucket policy with an s3:PutObject permission + // that only allows objects with server-side encryption, set the condition key + // of s3:x-amz-server-side-encryption to "aws:kms". For more information, see + // KMS-Managed Encryption Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) // in the Amazon Simple Storage Service Developer Guide. // // The KMS key policy must grant permission to the IAM role that you specify @@ -79303,10 +79365,6 @@ func (s *ProductionVariantCoreDumpConfig) SetKmsKeyId(v string) *ProductionVaria return s } -// -// Serverless Inference is in preview release for Amazon SageMaker and is subject -// to change. We do not recommend using this feature in production environments. -// // Specifies the serverless configuration for an endpoint variant. type ProductionVariantServerlessConfig struct { _ struct{} `type:"structure"` @@ -79451,9 +79509,6 @@ type ProductionVariantSummary struct { CurrentInstanceCount *int64 `type:"integer"` // The serverless configuration for the endpoint. - // - // Serverless Inference is in preview release for Amazon SageMaker and is subject - // to change. We do not recommend using this feature in production environments. CurrentServerlessConfig *ProductionVariantServerlessConfig `type:"structure"` // The weight associated with the variant. @@ -79468,9 +79523,6 @@ type ProductionVariantSummary struct { DesiredInstanceCount *int64 `type:"integer"` // The serverless configuration requested for the endpoint update. - // - // Serverless Inference is in preview release for Amazon SageMaker and is subject - // to change. We do not recommend using this feature in production environments. DesiredServerlessConfig *ProductionVariantServerlessConfig `type:"structure"` // The requested weight, as specified in the UpdateEndpointWeightsAndCapacities @@ -80722,8 +80774,8 @@ type QueryFilters struct { ModifiedBefore *time.Time `type:"timestamp"` // Filter the lineage entities connected to the StartArn(s) by a set if property - // key value pairs. If multiple pairs are provided, an entity will be included - // in the results if it matches any of the provided pairs. + // key value pairs. If multiple pairs are provided, an entity is included in + // the results if it matches any of the provided pairs. Properties map[string]*string `type:"map"` // Filter the lineage entities connected to the StartArn by type. For example: @@ -80794,8 +80846,8 @@ func (s *QueryFilters) SetTypes(v []*string) *QueryFilters { type QueryLineageInput struct { _ struct{} `type:"structure"` - // Associations between lineage entities are directed. This parameter determines - // the direction from the StartArn(s) the query will look. + // Associations between lineage entities have a direction. This parameter determines + // the direction from the StartArn(s) that the query traverses. Direction *string `type:"string" enum:"Direction"` // A set of filtering parameters that allow you to specify which entities should @@ -80813,15 +80865,15 @@ type QueryLineageInput struct { // * ModifiedAfter - Filter entities modified after this date. Filters *QueryFilters `type:"structure"` - // Setting this value to True will retrieve not only the entities of interest - // but also the Associations (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking-entities.html) + // Setting this value to True retrieves not only the entities of interest but + // also the Associations (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking-entities.html) // and lineage entities on the path. Set to False to only return lineage entities // that match your query. IncludeEdges *bool `type:"boolean"` - // The maximum depth in lineage relationships from the StartArns that will be - // traversed. Depth is a measure of the number of Associations from the StartArn - // entity to the matched results. + // The maximum depth in lineage relationships from the StartArns that are traversed. + // Depth is a measure of the number of Associations from the StartArn entity + // to the matched results. MaxDepth *int64 `type:"integer"` // Limits the number of vertices in the results. Use the NextToken in a response @@ -82267,9 +82319,9 @@ type ResourceConfig struct { // InstanceType is a required field InstanceType *string `type:"string" required:"true" enum:"TrainingInstanceType"` - // The Amazon Web Services KMS key that Amazon SageMaker uses to encrypt data - // on the storage volume attached to the ML compute instance(s) that run the - // training job. + // The Amazon Web Services KMS key that SageMaker uses to encrypt data on the + // storage volume attached to the ML compute instance(s) that run the training + // job. // // Certain Nitro-based instances include local storage, dependent on the instance // type. Local storage volumes are encrypted using a hardware module on the @@ -82298,14 +82350,13 @@ type ResourceConfig struct { // // You must specify sufficient ML storage for your scenario. // - // Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume - // type. + // SageMaker supports only the General Purpose SSD (gp2) ML storage volume type. // // Certain Nitro-based instances include local storage with a fixed total size, // dependent on the instance type. When using these instances for training, - // Amazon SageMaker mounts the local instance storage instead of Amazon EBS - // gp2 storage. You can't request a VolumeSizeInGB greater than the total size - // of the local instance storage. + // SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. + // You can't request a VolumeSizeInGB greater than the total size of the local + // instance storage. // // For a list of instance types that support local instance storage, including // the total size per instance type, see Instance Store Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes). @@ -82445,8 +82496,8 @@ func (s *ResourceInUse) RequestID() string { return s.RespMetadata.RequestID } -// You have exceeded an Amazon SageMaker resource limit. For example, you might -// have too many training jobs created. +// You have exceeded an SageMaker resource limit. For example, you might have +// too many training jobs created. type ResourceLimitExceeded struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -82650,6 +82701,10 @@ type ResourceSpec struct { _ struct{} `type:"structure"` // The instance type that the image version runs on. + // + // JupyterServer Apps only support the system value. KernelGateway Apps do not + // support the system value, but support all other values for available instance + // types. InstanceType *string `type:"string" enum:"AppInstanceType"` // The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to @@ -82908,14 +82963,14 @@ type S3DataSource struct { // augmented manifest file. AttributeNames []*string `type:"list"` - // If you want Amazon SageMaker to replicate the entire dataset on each ML compute + // If you want SageMaker to replicate the entire dataset on each ML compute // instance that is launched for model training, specify FullyReplicated. // - // If you want Amazon SageMaker to replicate a subset of data on each ML compute - // instance that is launched for model training, specify ShardedByS3Key. If - // there are n ML compute instances launched for a training job, each instance - // gets approximately 1/n of the number of S3 objects. In this case, model training - // on each machine uses only the subset of training data. + // If you want SageMaker to replicate a subset of data on each ML compute instance + // that is launched for model training, specify ShardedByS3Key. If there are + // n ML compute instances launched for a training job, each instance gets approximately + // 1/n of the number of S3 objects. In this case, model training on each machine + // uses only the subset of training data. // // Don't choose more ML compute instances for training than available S3 objects. // If you do, some nodes won't get any data and you will pay for nodes that @@ -82928,12 +82983,12 @@ type S3DataSource struct { // copies 1/n of the number of objects. S3DataDistributionType *string `type:"string" enum:"S3DataDistribution"` - // If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker - // uses all objects that match the specified key name prefix for model training. + // If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses + // all objects that match the specified key name prefix for model training. // // If you choose ManifestFile, S3Uri identifies an object that is a manifest - // file containing a list of object keys that you want Amazon SageMaker to use - // for model training. + // file containing a list of object keys that you want SageMaker to use for + // model training. // // If you choose AugmentedManifestFile, S3Uri identifies an object that is an // augmented manifest file in JSON lines format. This file contains the data @@ -82961,7 +83016,7 @@ type S3DataSource struct { // s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N // The complete set of S3Uri in this manifest is the input data for the channel // for this data source. The object that each S3Uri points to must be readable - // by the IAM role that Amazon SageMaker uses to perform tasks on your behalf. + // by the IAM role that SageMaker uses to perform tasks on your behalf. // // S3Uri is a required field S3Uri *string `type:"string" required:"true"` @@ -83589,7 +83644,7 @@ func (s *SearchRecord) SetTrialComponent(v *TrialComponent) *SearchRecord { // It provides additional details about a status that the training job has transitioned // through. A training job can be in one of several states, for example, starting, // downloading, training, or uploading. Within each state, there are a number -// of intermediate states. For example, within the starting state, Amazon SageMaker +// of intermediate states. For example, within the starting state, SageMaker // could be starting the training job or launching the ML instances. These transitional // states are referred to as the job's secondary status. type SecondaryStatusTransition struct { @@ -83656,8 +83711,8 @@ type SecondaryStatusTransition struct { // A detailed description of the progress within a secondary status. // - // Amazon SageMaker provides secondary statuses and status messages that apply - // to each of them: + // SageMaker provides secondary statuses and status messages that apply to each + // of them: // // Starting // @@ -84289,14 +84344,14 @@ func (s *ShuffleConfig) SetSeed(v int64) *ShuffleConfig { } // Specifies an algorithm that was used to create the model package. The algorithm -// must be either an algorithm resource in your Amazon SageMaker account or -// an algorithm in Amazon Web Services Marketplace that you are subscribed to. +// must be either an algorithm resource in your SageMaker account or an algorithm +// in Amazon Web Services Marketplace that you are subscribed to. type SourceAlgorithm struct { _ struct{} `type:"structure"` // The name of an algorithm that was used to create the model package. The algorithm - // must be either an algorithm resource in your Amazon SageMaker account or - // an algorithm in Amazon Web Services Marketplace that you are subscribed to. + // must be either an algorithm resource in your SageMaker account or an algorithm + // in Amazon Web Services Marketplace that you are subscribed to. // // AlgorithmName is a required field AlgorithmName *string `min:"1" type:"string" required:"true"` @@ -85629,20 +85684,19 @@ func (s StopTransformJobOutput) GoString() string { // Specifies a limit to how long a model training job or model compilation job // can run. It also specifies how long a managed spot training job has to complete. -// When the job reaches the time limit, Amazon SageMaker ends the training or -// compilation job. Use this API to cap model training costs. +// When the job reaches the time limit, SageMaker ends the training or compilation +// job. Use this API to cap model training costs. // -// To stop a training job, Amazon SageMaker sends the algorithm the SIGTERM -// signal, which delays job termination for 120 seconds. Algorithms can use -// this 120-second window to save the model artifacts, so the results of training -// are not lost. +// To stop a training job, SageMaker sends the algorithm the SIGTERM signal, +// which delays job termination for 120 seconds. Algorithms can use this 120-second +// window to save the model artifacts, so the results of training are not lost. // -// The training algorithms provided by Amazon SageMaker automatically save the -// intermediate results of a model training job when possible. This attempt -// to save artifacts is only a best effort case as model might not be in a state -// from which it can be saved. For example, if training has just started, the -// model might not be ready to save. When saved, this intermediate data is a -// valid model artifact. You can use it to create a model with CreateModel. +// The training algorithms provided by SageMaker automatically save the intermediate +// results of a model training job when possible. This attempt to save artifacts +// is only a best effort case as model might not be in a state from which it +// can be saved. For example, if training has just started, the model might +// not be ready to save. When saved, this intermediate data is a valid model +// artifact. You can use it to create a model with CreateModel. // // The Neural Topic Model (NTM) currently does not support saving intermediate // model artifacts. When training NTMs, make sure that the maximum runtime is @@ -85653,22 +85707,21 @@ type StoppingCondition struct { // The maximum length of time, in seconds, that a training or compilation job // can run. // - // For compilation jobs, if the job does not complete during this time, you - // will receive a TimeOut error. We recommend starting with 900 seconds and - // increase as necessary based on your model. + // For compilation jobs, if the job does not complete during this time, a TimeOut + // error is generated. We recommend starting with 900 seconds and increasing + // as necessary based on your model. // - // For all other jobs, if the job does not complete during this time, Amazon - // SageMaker ends the job. When RetryStrategy is specified in the job request, - // MaxRuntimeInSeconds specifies the maximum time for all of the attempts in - // total, not each individual attempt. The default value is 1 day. The maximum - // value is 28 days. + // For all other jobs, if the job does not complete during this time, SageMaker + // ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds + // specifies the maximum time for all of the attempts in total, not each individual + // attempt. The default value is 1 day. The maximum value is 28 days. MaxRuntimeInSeconds *int64 `min:"1" type:"integer"` // The maximum length of time, in seconds, that a managed Spot training job // has to complete. It is the amount of time spent waiting for Spot capacity // plus the amount of time the job can run. It must be equal to or greater than - // MaxRuntimeInSeconds. If the job does not complete during this time, Amazon - // SageMaker ends the job. + // MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker + // ends the job. // // When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds // specifies the maximum time for all of the attempts in total, not each individual @@ -86422,7 +86475,7 @@ type TrainingJob struct { ModelArtifacts *ModelArtifacts `type:"structure"` // The S3 path where model artifacts that you configured when creating the job - // are stored. Amazon SageMaker creates subfolders for model artifacts. + // are stored. SageMaker creates subfolders for model artifacts. OutputDataConfig *OutputDataConfig `type:"structure"` // Resources, including ML compute instances and ML storage volumes, that are @@ -86440,8 +86493,8 @@ type TrainingJob struct { // information about the secondary status of the training job, see StatusMessage // under SecondaryStatusTransition. // - // Amazon SageMaker provides primary statuses and secondary statuses that apply - // to each of them: + // SageMaker provides primary statuses and secondary statuses that apply to + // each of them: // // InProgress // @@ -86493,12 +86546,12 @@ type TrainingJob struct { // Specifies a limit to how long a model training job can run. It also specifies // how long a managed Spot training job has to complete. When the job reaches - // the time limit, Amazon SageMaker ends the training job. Use this API to cap - // model training costs. + // the time limit, SageMaker ends the training job. Use this API to cap model + // training costs. // - // To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which - // delays job termination for 120 seconds. Algorithms can use this 120-second - // window to save the model artifacts, so the results of training are not lost. + // To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays + // job termination for 120 seconds. Algorithms can use this 120-second window + // to save the model artifacts, so the results of training are not lost. StoppingCondition *StoppingCondition `type:"structure"` // An array of key-value pairs. You can use tags to categorize your Amazon Web @@ -86513,7 +86566,7 @@ type TrainingJob struct { // Indicates the time when the training job ends on training instances. You // are billed for the time interval between the value of TrainingStartTime and // this time. For successful jobs and stopped jobs, this is the time after model - // artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker + // artifacts are uploaded. For failed jobs, this is the time when SageMaker // detects a job failure. TrainingEndTime *time.Time `type:"timestamp"` @@ -86814,8 +86867,8 @@ type TrainingJobDefinition struct { // InputDataConfig is a required field InputDataConfig []*Channel `min:"1" type:"list" required:"true"` - // the path to the S3 bucket where you want to store model artifacts. Amazon - // SageMaker creates subfolders for the artifacts. + // the path to the S3 bucket where you want to store model artifacts. SageMaker + // creates subfolders for the artifacts. // // OutputDataConfig is a required field OutputDataConfig *OutputDataConfig `type:"structure" required:"true"` @@ -86828,12 +86881,12 @@ type TrainingJobDefinition struct { // Specifies a limit to how long a model training job can run. It also specifies // how long a managed Spot training job has to complete. When the job reaches - // the time limit, Amazon SageMaker ends the training job. Use this API to cap - // model training costs. + // the time limit, SageMaker ends the training job. Use this API to cap model + // training costs. // - // To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which - // delays job termination for 120 seconds. Algorithms can use this 120-second - // window to save the model artifacts. + // To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays + // job termination for 120 seconds. Algorithms can use this 120-second window + // to save the model artifacts. // // StoppingCondition is a required field StoppingCondition *StoppingCondition `type:"structure" required:"true"` @@ -90694,7 +90747,7 @@ type UpdateEndpointWeightsAndCapacitiesInput struct { // DesiredWeightsAndCapacities is a required field DesiredWeightsAndCapacities []*DesiredWeightAndCapacity `min:"1" type:"list" required:"true"` - // The name of an existing Amazon SageMaker endpoint. + // The name of an existing SageMaker endpoint. // // EndpointName is a required field EndpointName *string `type:"string" required:"true"` @@ -91286,8 +91339,7 @@ type UpdateNotebookInstanceInput struct { // (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or // in any other Git repository. These repositories are cloned at the same level // as the default repository of your notebook instance. For more information, - // see Associating Git Repositories with Amazon SageMaker Notebook Instances - // (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + // see Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). AdditionalCodeRepositories []*string `type:"list"` // The Git repository to associate with the notebook instance as its default @@ -91296,7 +91348,7 @@ type UpdateNotebookInstanceInput struct { // Services CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) // or in any other Git repository. When you open a notebook instance, it opens // in the directory that contains this repository. For more information, see - // Associating Git Repositories with Amazon SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). + // Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html). DefaultCodeRepository *string `min:"1" type:"string"` // A list of the Elastic Inference (EI) instance types to remove from this notebook @@ -91336,12 +91388,12 @@ type UpdateNotebookInstanceInput struct { // NotebookInstanceName is a required field NotebookInstanceName *string `type:"string" required:"true"` - // The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can - // assume to access the notebook instance. For more information, see Amazon - // SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). + // The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume + // to access the notebook instance. For more information, see SageMaker Roles + // (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html). // - // To be able to pass this role to Amazon SageMaker, the caller of this API - // must have the iam:PassRole permission. + // To be able to pass this role to SageMaker, the caller of this API must have + // the iam:PassRole permission. RoleArn *string `min:"20" type:"string"` // Whether root access is enabled or disabled for users of the notebook instance. @@ -91352,7 +91404,7 @@ type UpdateNotebookInstanceInput struct { RootAccess *string `type:"string" enum:"RootAccess"` // The size, in GB, of the ML storage volume to attach to the notebook instance. - // The default value is 5 GB. ML storage volumes are encrypted, so Amazon SageMaker + // The default value is 5 GB. ML storage volumes are encrypted, so SageMaker // can't determine the amount of available free space on the volume. Because // of this, you can increase the volume size when you update a notebook instance, // but you can't decrease the volume size. If you want to decrease the size @@ -93974,6 +94026,22 @@ func AuthMode_Values() []string { } } +const ( + // AutoMLChannelTypeTraining is a AutoMLChannelType enum value + AutoMLChannelTypeTraining = "training" + + // AutoMLChannelTypeValidation is a AutoMLChannelType enum value + AutoMLChannelTypeValidation = "validation" +) + +// AutoMLChannelType_Values returns all elements of the AutoMLChannelType enum +func AutoMLChannelType_Values() []string { + return []string{ + AutoMLChannelTypeTraining, + AutoMLChannelTypeValidation, + } +} + const ( // AutoMLJobObjectiveTypeMaximize is a AutoMLJobObjectiveType enum value AutoMLJobObjectiveTypeMaximize = "Maximize" diff --git a/service/sagemaker/doc.go b/service/sagemaker/doc.go index 0dda1b81f74..11985ddd6e2 100644 --- a/service/sagemaker/doc.go +++ b/service/sagemaker/doc.go @@ -3,11 +3,11 @@ // Package sagemaker provides the client and types for making API // requests to Amazon SageMaker Service. // -// Provides APIs for creating and managing Amazon SageMaker resources. +// Provides APIs for creating and managing SageMaker resources. // // Other Resources: // -// * Amazon SageMaker Developer Guide (https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html#first-time-user) +// * SageMaker Developer Guide (https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html#first-time-user) // // * Amazon Augmented AI Runtime API Reference (https://docs.aws.amazon.com/augmented-ai/2019-11-07/APIReference/Welcome.html) // diff --git a/service/sagemaker/errors.go b/service/sagemaker/errors.go index 1b996981b2b..e87acc021f8 100644 --- a/service/sagemaker/errors.go +++ b/service/sagemaker/errors.go @@ -24,8 +24,8 @@ const ( // ErrCodeResourceLimitExceeded for service response error code // "ResourceLimitExceeded". // - // You have exceeded an Amazon SageMaker resource limit. For example, you might - // have too many training jobs created. + // You have exceeded an SageMaker resource limit. For example, you might have + // too many training jobs created. ErrCodeResourceLimitExceeded = "ResourceLimitExceeded" // ErrCodeResourceNotFound for service response error code