User does not have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.artifact#AccountSettings": { + "type": "structure", + "members": { + "notificationSubscriptionStatus": { + "target": "com.amazonaws.artifact#NotificationSubscriptionStatus", + "traits": { + "smithy.api#documentation": "Notification subscription status of the customer.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Account settings for the customer.
" + } + }, + "com.amazonaws.artifact#AccountSettingsResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.artifact#GetAccountSettings" + }, + { + "target": "com.amazonaws.artifact#PutAccountSettings" + } + ] + }, + "com.amazonaws.artifact#Artifact": { + "type": "service", + "version": "2018-05-10", + "resources": [ + { + "target": "com.amazonaws.artifact#AccountSettingsResource" + }, + { + "target": "com.amazonaws.artifact#ReportResource" + }, + { + "target": "com.amazonaws.artifact#TermResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Artifact", + "arnNamespace": "artifact", + "cloudTrailEventSource": "artifact.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "artifact" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "This reference provides descriptions of the low-level AWS Artifact Service API.
", + "smithy.api#title": "AWS Artifact", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://artifact-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://artifact-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://artifact.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://artifact.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://artifact-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://artifact-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://artifact.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://artifact.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://artifact-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://artifact-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://artifact.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://artifact.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://artifact-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://artifact-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://artifact.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://artifact.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://artifact-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://artifact.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://artifact-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://artifact.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.artifact#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Identifier of the affected resource.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Type of the affected resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request to create/modify content would result in a conflict.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.artifact#GetAccountSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.artifact#GetAccountSettingsRequest" + }, + "output": { + "target": "com.amazonaws.artifact#GetAccountSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.artifact#AccessDeniedException" + }, + { + "target": "com.amazonaws.artifact#ConflictException" + }, + { + "target": "com.amazonaws.artifact#InternalServerException" + }, + { + "target": "com.amazonaws.artifact#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.artifact#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.artifact#ThrottlingException" + }, + { + "target": "com.amazonaws.artifact#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get the account settings for Artifact.
", + "smithy.api#examples": [ + { + "title": "Invoke GetAccountSettings operation", + "documentation": "Get the current account settings.", + "input": {}, + "output": { + "accountSettings": { + "notificationSubscriptionStatus": "SUBSCRIBED" + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v1/account-settings/get" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.artifact#GetAccountSettingsRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.artifact#GetAccountSettingsResponse": { + "type": "structure", + "members": { + "accountSettings": { + "target": "com.amazonaws.artifact#AccountSettings" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.artifact#GetReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.artifact#GetReportRequest" + }, + "output": { + "target": "com.amazonaws.artifact#GetReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.artifact#AccessDeniedException" + }, + { + "target": "com.amazonaws.artifact#ConflictException" + }, + { + "target": "com.amazonaws.artifact#InternalServerException" + }, + { + "target": "com.amazonaws.artifact#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.artifact#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.artifact#ThrottlingException" + }, + { + "target": "com.amazonaws.artifact#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get the content for a single report.
", + "smithy.api#examples": [ + { + "title": "Invoke GetReport operation on the latest version of a specific report", + "documentation": "The GetReport operation is invoked on a reportId and on a optional version.\n Callers must provide a termToken, which is provided by the GetTermForReport\n operation. If callers do not provide a version, it will default to the\n report's latest version", + "input": { + "reportId": "report-1hVFddebtfDNJAUf", + "termToken": "term-token-gPFEGk7CF4wS901w7ppYclt7" + }, + "output": { + "documentPresignedUrl": "Get the metadata for a single report.
", + "smithy.api#examples": [ + { + "title": "Invoke GetReportMetadata operation on the latest version of a specific report", + "documentation": "The GetReportMetadata operation is invoked on a reportId and on a optional version.\n If callers do not provide a version, it will default to the report's latest version.", + "input": { + "reportId": "report-bqhUJF3FrQZsMJpb" + }, + "output": { + "reportDetails": { + "arn": "arn:aws:artifact:us-east-1::report/report-bqhUJF3FrQZsMJpb:1", + "category": "Artifact Category", + "companyName": "AWS", + "createdAt": "2022-05-27T23:17:00.343940Z", + "description": "Description of report", + "id": "report-bqhUJF3FrQZsMJpb", + "name": "Name of report", + "periodEnd": "2022-04-01T20:32:04Z", + "periodStart": "2022-04-01T20:32:04Z", + "productName": "Product of report", + "series": "Artifact Series", + "state": "PUBLISHED", + "termArn": "arn:aws:artifact:us-east-1::term/term-gLJGG12NyPtYcmtu:1", + "version": 1 + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v1/report/getMetadata" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.artifact#GetReportMetadataRequest": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.artifact#ReportId", + "traits": { + "smithy.api#documentation": "Unique resource ID for the report resource.
", + "smithy.api#httpQuery": "reportId", + "smithy.api#required": {} + } + }, + "reportVersion": { + "target": "com.amazonaws.artifact#VersionAttribute", + "traits": { + "smithy.api#documentation": "Version for the report resource.
", + "smithy.api#httpQuery": "reportVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.artifact#GetReportMetadataResponse": { + "type": "structure", + "members": { + "reportDetails": { + "target": "com.amazonaws.artifact#ReportDetail", + "traits": { + "smithy.api#documentation": "Report resource detail.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.artifact#GetReportRequest": { + "type": "structure", + "members": { + "reportId": { + "target": "com.amazonaws.artifact#ReportId", + "traits": { + "smithy.api#documentation": "Unique resource ID for the report resource.
", + "smithy.api#httpQuery": "reportId", + "smithy.api#required": {} + } + }, + "reportVersion": { + "target": "com.amazonaws.artifact#VersionAttribute", + "traits": { + "smithy.api#documentation": "Version for the report resource.
", + "smithy.api#httpQuery": "reportVersion" + } + }, + "termToken": { + "target": "com.amazonaws.artifact#ShortStringAttribute", + "traits": { + "smithy.api#documentation": "Unique download token provided by GetTermForReport API.
", + "smithy.api#httpQuery": "termToken", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.artifact#GetReportResponse": { + "type": "structure", + "members": { + "documentPresignedUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Presigned S3 url to access the report content.
", + "smithy.api#length": { + "min": 1, + "max": 10240 + } + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.artifact#GetTermForReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.artifact#GetTermForReportRequest" + }, + "output": { + "target": "com.amazonaws.artifact#GetTermForReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.artifact#AccessDeniedException" + }, + { + "target": "com.amazonaws.artifact#ConflictException" + }, + { + "target": "com.amazonaws.artifact#InternalServerException" + }, + { + "target": "com.amazonaws.artifact#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.artifact#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.artifact#ThrottlingException" + }, + { + "target": "com.amazonaws.artifact#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get the Term content associated with a single report.
", + "smithy.api#examples": [ + { + "title": "Invoke GetTermForReport operation on the latest version of a specific report", + "documentation": "The GetTermForReport operation is invoked on a reportId and on a optional version.\n If callers do not provide a version, it will default to the report's latest version.", + "input": { + "reportId": "report-bqhUJF3FrQZsMJpb" + }, + "output": { + "termToken": "term-token-gPFEGk7CF4wS901w7ppYclt7", + "documentPresignedUrl": "Unique resource ID for the report resource.
", + "smithy.api#httpQuery": "reportId", + "smithy.api#required": {} + } + }, + "reportVersion": { + "target": "com.amazonaws.artifact#VersionAttribute", + "traits": { + "smithy.api#documentation": "Version for the report resource.
", + "smithy.api#httpQuery": "reportVersion" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.artifact#GetTermForReportResponse": { + "type": "structure", + "members": { + "documentPresignedUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Presigned S3 url to access the term content.
", + "smithy.api#length": { + "min": 1, + "max": 10240 + } + } + }, + "termToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Unique token representing this request event.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.artifact#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Number of seconds in which the caller can retry the request.
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "An unknown server exception has occurred.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.artifact#ListReports": { + "type": "operation", + "input": { + "target": "com.amazonaws.artifact#ListReportsRequest" + }, + "output": { + "target": "com.amazonaws.artifact#ListReportsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.artifact#AccessDeniedException" + }, + { + "target": "com.amazonaws.artifact#InternalServerException" + }, + { + "target": "com.amazonaws.artifact#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.artifact#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.artifact#ThrottlingException" + }, + { + "target": "com.amazonaws.artifact#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List available reports.
", + "smithy.api#examples": [ + { + "title": "Invoke ListReports operation", + "documentation": "The ListReports operation returns a collection of report resources.", + "input": {}, + "output": { + "reports": [ + { + "arn": "arn:aws:artifact:us-east-1::report/report-bqhUJF3FrQZsMJpb", + "category": "Artifact Category", + "companyName": "AWS", + "description": "Description of report", + "id": "report-bqhUJF3FrQZsMJpb", + "name": "Name of report", + "periodEnd": "2022-04-01T20:32:04Z", + "periodStart": "2022-04-01T20:32:04Z", + "productName": "Product of report", + "series": "Artifact Series", + "state": "PUBLISHED", + "version": 1 + } + ], + "nextToken": "gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7gPFEGk7CF4wS901w7ppYclt7" + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v1/report/list" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "reports" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.artifact#ListReportsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.artifact#MaxResultsAttribute", + "traits": { + "smithy.api#documentation": "Maximum number of resources to return in the paginated response.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.artifact#NextTokenAttribute", + "traits": { + "smithy.api#documentation": "Pagination token to request the next page of resources.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.artifact#ListReportsResponse": { + "type": "structure", + "members": { + "reports": { + "target": "com.amazonaws.artifact#ReportsList", + "traits": { + "smithy.api#documentation": "List of report resources.
" + } + }, + "nextToken": { + "target": "com.amazonaws.artifact#NextTokenAttribute", + "traits": { + "smithy.api#documentation": "Pagination token to request the next page of resources.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.artifact#LongStringAttribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[^<>]*$" + } + }, + "com.amazonaws.artifact#MaxResultsAttribute": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.artifact#NextTokenAttribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.artifact#NotificationSubscriptionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUBSCRIBED", + "name": "SUBSCRIBED", + "documentation": "The account is subscribed for notification." + }, + { + "value": "NOT_SUBSCRIBED", + "name": "NOT_SUBSCRIBED", + "documentation": "The account is not subscribed for notification." + } + ] + } + }, + "com.amazonaws.artifact#PublishedState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PUBLISHED", + "name": "PUBLISHED", + "documentation": "The resource is published for consumption." + }, + { + "value": "UNPUBLISHED", + "name": "UNPUBLISHED", + "documentation": "The resource is not published for consumption." + } + ] + } + }, + "com.amazonaws.artifact#PutAccountSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.artifact#PutAccountSettingsRequest" + }, + "output": { + "target": "com.amazonaws.artifact#PutAccountSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.artifact#AccessDeniedException" + }, + { + "target": "com.amazonaws.artifact#ConflictException" + }, + { + "target": "com.amazonaws.artifact#InternalServerException" + }, + { + "target": "com.amazonaws.artifact#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.artifact#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.artifact#ThrottlingException" + }, + { + "target": "com.amazonaws.artifact#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Put the account settings for Artifact.
", + "smithy.api#examples": [ + { + "title": "Invoke PutAccountSettings operation", + "documentation": "Set the account settings.", + "input": { + "notificationSubscriptionStatus": "SUBSCRIBED" + }, + "output": { + "accountSettings": { + "notificationSubscriptionStatus": "SUBSCRIBED" + } + } + } + ], + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/v1/account-settings/put" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.artifact#PutAccountSettingsRequest": { + "type": "structure", + "members": { + "notificationSubscriptionStatus": { + "target": "com.amazonaws.artifact#NotificationSubscriptionStatus", + "traits": { + "smithy.api#documentation": "Desired notification subscription status.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.artifact#PutAccountSettingsResponse": { + "type": "structure", + "members": { + "accountSettings": { + "target": "com.amazonaws.artifact#AccountSettings" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.artifact#ReportDetail": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.artifact#ReportId", + "traits": { + "smithy.api#documentation": "Unique resource ID for the report resource.
" + } + }, + "name": { + "target": "com.amazonaws.artifact#ShortStringAttribute", + "traits": { + "smithy.api#documentation": "Name for the report resource.
" + } + }, + "description": { + "target": "com.amazonaws.artifact#LongStringAttribute", + "traits": { + "smithy.api#documentation": "Description for the report resource.
" + } + }, + "periodStart": { + "target": "com.amazonaws.artifact#TimestampAttribute", + "traits": { + "smithy.api#documentation": "Timestamp indicating the report resource effective start.
" + } + }, + "periodEnd": { + "target": "com.amazonaws.artifact#TimestampAttribute", + "traits": { + "smithy.api#documentation": "Timestamp indicating the report resource effective end.
" + } + }, + "createdAt": { + "target": "com.amazonaws.artifact#TimestampAttribute", + "traits": { + "smithy.api#documentation": "Timestamp indicating when the report resource was created.
" + } + }, + "lastModifiedAt": { + "target": "com.amazonaws.artifact#TimestampAttribute", + "traits": { + "smithy.api#documentation": "Timestamp indicating when the report resource was last modified.
" + } + }, + "deletedAt": { + "target": "com.amazonaws.artifact#TimestampAttribute", + "traits": { + "smithy.api#documentation": "Timestamp indicating when the report resource was deleted.
" + } + }, + "state": { + "target": "com.amazonaws.artifact#PublishedState", + "traits": { + "smithy.api#documentation": "Current state of the report resource
" + } + }, + "arn": { + "target": "com.amazonaws.artifact#LongStringAttribute", + "traits": { + "smithy.api#documentation": "ARN for the report resource.
" + } + }, + "series": { + "target": "com.amazonaws.artifact#ShortStringAttribute", + "traits": { + "smithy.api#documentation": "Series for the report resource.
" + } + }, + "category": { + "target": "com.amazonaws.artifact#ShortStringAttribute", + "traits": { + "smithy.api#documentation": "Category for the report resource.
" + } + }, + "companyName": { + "target": "com.amazonaws.artifact#ShortStringAttribute", + "traits": { + "smithy.api#documentation": "Associated company name for the report resource.
" + } + }, + "productName": { + "target": "com.amazonaws.artifact#ShortStringAttribute", + "traits": { + "smithy.api#documentation": "Associated product name for the report resource.
" + } + }, + "termArn": { + "target": "com.amazonaws.artifact#LongStringAttribute", + "traits": { + "smithy.api#documentation": "Unique resource ARN for term resource.
" + } + }, + "version": { + "target": "com.amazonaws.artifact#VersionAttribute", + "traits": { + "smithy.api#documentation": "Version for the report resource.
" + } + }, + "acceptanceType": { + "target": "com.amazonaws.artifact#AcceptanceType", + "traits": { + "smithy.api#documentation": "Acceptance type for report.
" + } + }, + "sequenceNumber": { + "target": "com.amazonaws.artifact#SequenceNumberAttribute", + "traits": { + "smithy.api#documentation": "Sequence number to enforce optimistic locking.
" + } + }, + "uploadState": { + "target": "com.amazonaws.artifact#UploadState", + "traits": { + "smithy.api#documentation": "The current state of the document upload.
" + } + }, + "statusMessage": { + "target": "com.amazonaws.artifact#StatusMessage", + "traits": { + "smithy.api#documentation": "The message associated with the current upload state.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Full detail for report resource metadata.
" + } + }, + "com.amazonaws.artifact#ReportId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^report-[a-zA-Z0-9]{16}$" + } + }, + "com.amazonaws.artifact#ReportResource": { + "type": "resource", + "identifiers": { + "reportId": { + "target": "com.amazonaws.artifact#ReportId" + } + }, + "read": { + "target": "com.amazonaws.artifact#GetReportMetadata" + }, + "list": { + "target": "com.amazonaws.artifact#ListReports" + }, + "operations": [ + { + "target": "com.amazonaws.artifact#GetReport" + }, + { + "target": "com.amazonaws.artifact#GetTermForReport" + } + ] + }, + "com.amazonaws.artifact#ReportSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.artifact#ReportId", + "traits": { + "smithy.api#documentation": "Unique resource ID for the report resource.
" + } + }, + "name": { + "target": "com.amazonaws.artifact#ShortStringAttribute", + "traits": { + "smithy.api#documentation": "Name for the report resource.
" + } + }, + "state": { + "target": "com.amazonaws.artifact#PublishedState", + "traits": { + "smithy.api#documentation": "Current state of the report resource.
" + } + }, + "arn": { + "target": "com.amazonaws.artifact#LongStringAttribute", + "traits": { + "smithy.api#documentation": "ARN for the report resource.
" + } + }, + "version": { + "target": "com.amazonaws.artifact#VersionAttribute", + "traits": { + "smithy.api#documentation": "Version for the report resource.
" + } + }, + "uploadState": { + "target": "com.amazonaws.artifact#UploadState", + "traits": { + "smithy.api#documentation": "The current state of the document upload.
" + } + }, + "description": { + "target": "com.amazonaws.artifact#LongStringAttribute", + "traits": { + "smithy.api#documentation": "Description for the report resource.
" + } + }, + "periodStart": { + "target": "com.amazonaws.artifact#TimestampAttribute", + "traits": { + "smithy.api#documentation": "Timestamp indicating the report resource effective start.
" + } + }, + "periodEnd": { + "target": "com.amazonaws.artifact#TimestampAttribute", + "traits": { + "smithy.api#documentation": "Timestamp indicating the report resource effective end.
" + } + }, + "series": { + "target": "com.amazonaws.artifact#ShortStringAttribute", + "traits": { + "smithy.api#documentation": "Series for the report resource.
" + } + }, + "category": { + "target": "com.amazonaws.artifact#ShortStringAttribute", + "traits": { + "smithy.api#documentation": "Category for the report resource.
" + } + }, + "companyName": { + "target": "com.amazonaws.artifact#ShortStringAttribute", + "traits": { + "smithy.api#documentation": "Associated company name for the report resource.
" + } + }, + "productName": { + "target": "com.amazonaws.artifact#ShortStringAttribute", + "traits": { + "smithy.api#documentation": "Associated product name for the report resource.
" + } + }, + "statusMessage": { + "target": "com.amazonaws.artifact#StatusMessage", + "traits": { + "smithy.api#documentation": "The message associated with the current upload state.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary for report resource.
" + } + }, + "com.amazonaws.artifact#ReportsList": { + "type": "list", + "member": { + "target": "com.amazonaws.artifact#ReportSummary" + } + }, + "com.amazonaws.artifact#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Identifier of the affected resource.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Type of the affected resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request references a resource which does not exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.artifact#SequenceNumberAttribute": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.artifact#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Identifier of the affected resource.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Type of the affected resource.
", + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Code for the affected service.
", + "smithy.api#required": {} + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Code for the affected quota.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request would cause a service quota to be exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.artifact#ShortStringAttribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-\\s]*$" + } + }, + "com.amazonaws.artifact#StatusMessage": { + "type": "string" + }, + "com.amazonaws.artifact#TermId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^term-[a-zA-Z0-9]{16}$" + } + }, + "com.amazonaws.artifact#TermResource": { + "type": "resource", + "identifiers": { + "termId": { + "target": "com.amazonaws.artifact#TermId" + } + } + }, + "com.amazonaws.artifact#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Code for the affected service.
" + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Code for the affected quota.
" + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Number of seconds in which the caller can retry the request.
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "Request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.artifact#TimestampAttribute": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.artifact#UploadState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROCESSING", + "name": "PROCESSING" + }, + { + "value": "COMPLETE", + "name": "COMPLETE" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "FAULT", + "name": "FAULT" + } + ] + } + }, + "com.amazonaws.artifact#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.artifact#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "Reason the request failed validation.
", + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.artifact#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "The field that caused the error, if applicable.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Request fails to satisfy the constraints specified by an AWS service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.artifact#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Name of validation exception.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Message describing why the field failed validation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Validation exception message and name.
" + } + }, + "com.amazonaws.artifact#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.artifact#ValidationExceptionField" + } + }, + "com.amazonaws.artifact#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "unknownOperation", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "cannotParse", + "name": "CANNOT_PARSE" + }, + { + "value": "fieldValidationFailed", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "invalidToken", + "name": "INVALID_TOKEN" + }, + { + "value": "other", + "name": "OTHER" + } + ] + } + }, + "com.amazonaws.artifact#VersionAttribute": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/codepipeline.json b/codegen/sdk-codegen/aws-models/codepipeline.json index 1d0f55894d8..6c74e204edc 100644 --- a/codegen/sdk-codegen/aws-models/codepipeline.json +++ b/codegen/sdk-codegen/aws-models/codepipeline.json @@ -475,6 +475,12 @@ "traits": { "smithy.api#documentation": "The variable namespace associated with the action. All variables produced as output by\n this action fall under this namespace.
" } + }, + "timeoutInMinutes": { + "target": "com.amazonaws.codepipeline#ActionTimeout", + "traits": { + "smithy.api#documentation": "A timeout duration in minutes that can be applied against the ActionType’s default\n timeout value specified in Quotas for CodePipeline\n . This attribute is available only to the manual approval ActionType.
" + } } }, "traits": { @@ -936,6 +942,15 @@ "target": "com.amazonaws.codepipeline#ActionState" } }, + "com.amazonaws.codepipeline#ActionTimeout": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 86400 + } + } + }, "com.amazonaws.codepipeline#ActionType": { "type": "structure", "members": { @@ -4074,18 +4089,18 @@ "includes": { "target": "com.amazonaws.codepipeline#GitBranchPatternList", "traits": { - "smithy.api#documentation": "The list of patterns of Git branches that, when a commit is pushed, are to be included as criteria that starts the pipeline.
" + "smithy.api#documentation": "The list of patterns of Git branches that, when a commit is pushed, are to be\n included as criteria that starts the pipeline.
" } }, "excludes": { "target": "com.amazonaws.codepipeline#GitBranchPatternList", "traits": { - "smithy.api#documentation": "The list of patterns of Git branches that, when a commit is pushed, are to be excluded from starting the pipeline.
" + "smithy.api#documentation": "The list of patterns of Git branches that, when a commit is pushed, are to be\n excluded from starting the pipeline.
" } } }, "traits": { - "smithy.api#documentation": "The Git repository branches specified as filter criteria to start the pipeline.
" + "smithy.api#documentation": "The Git repository branches specified as filter criteria to start the\n pipeline.
" } }, "com.amazonaws.codepipeline#GitBranchNamePattern": { @@ -4129,7 +4144,7 @@ "pullRequest": { "target": "com.amazonaws.codepipeline#GitPullRequestFilterList", "traits": { - "smithy.api#documentation": "The field where the repository event that will start the pipeline is specified as pull requests.
" + "smithy.api#documentation": "The field where the repository event that will start the pipeline is specified as\n pull requests.
" } } }, @@ -4143,18 +4158,18 @@ "includes": { "target": "com.amazonaws.codepipeline#GitFilePathPatternList", "traits": { - "smithy.api#documentation": "The list of patterns of Git repository file paths that, when a commit is pushed, are to be included as criteria that starts the pipeline.
" + "smithy.api#documentation": "The list of patterns of Git repository file paths that, when a commit is pushed,\n are to be included as criteria that starts the pipeline.
" } }, "excludes": { "target": "com.amazonaws.codepipeline#GitFilePathPatternList", "traits": { - "smithy.api#documentation": "The list of patterns of Git repository file paths that, when a commit is pushed, are to be excluded from starting the pipeline.
" + "smithy.api#documentation": "The list of patterns of Git repository file paths that, when a commit is pushed,\n are to be excluded from starting the pipeline.
" } } }, "traits": { - "smithy.api#documentation": "The Git repository file paths specified as filter criteria to start the pipeline.
" + "smithy.api#documentation": "The Git repository file paths specified as filter criteria to start the\n pipeline.
" } }, "com.amazonaws.codepipeline#GitFilePathPattern": { @@ -4220,24 +4235,24 @@ "events": { "target": "com.amazonaws.codepipeline#GitPullRequestEventTypeList", "traits": { - "smithy.api#documentation": "The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.
" + "smithy.api#documentation": "The field that specifies which pull request events to filter on (opened, updated,\n closed) for the trigger configuration.
" } }, "branches": { "target": "com.amazonaws.codepipeline#GitBranchFilterCriteria", "traits": { - "smithy.api#documentation": "The field that specifies to filter on branches for the pull request trigger configuration.
" + "smithy.api#documentation": "The field that specifies to filter on branches for the pull request trigger\n configuration.
" } }, "filePaths": { "target": "com.amazonaws.codepipeline#GitFilePathFilterCriteria", "traits": { - "smithy.api#documentation": "The field that specifies to filter on file paths for the pull request trigger configuration.
" + "smithy.api#documentation": "The field that specifies to filter on file paths for the pull request trigger\n configuration.
" } } }, "traits": { - "smithy.api#documentation": "The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.
" + "smithy.api#documentation": "The event criteria for the pull request trigger configuration, such as the lists of\n branches or file paths to include and exclude.
" } }, "com.amazonaws.codepipeline#GitPullRequestFilterList": { @@ -4264,18 +4279,18 @@ "branches": { "target": "com.amazonaws.codepipeline#GitBranchFilterCriteria", "traits": { - "smithy.api#documentation": "The field that specifies to filter on branches for the push trigger configuration.
" + "smithy.api#documentation": "The field that specifies to filter on branches for the push trigger\n configuration.
" } }, "filePaths": { "target": "com.amazonaws.codepipeline#GitFilePathFilterCriteria", "traits": { - "smithy.api#documentation": "The field that specifies to filter on file paths for the push trigger configuration.
" + "smithy.api#documentation": "The field that specifies to filter on file paths for the push trigger\n configuration.
" } } }, "traits": { - "smithy.api#documentation": "The event criteria that specify when a specified repository event will start the pipeline for the specified trigger configuration, such as the lists of Git tags to include and exclude.
" + "smithy.api#documentation": "The event criteria that specify when a specified repository event will start the\n pipeline for the specified trigger configuration, such as the lists of Git tags to\n include and exclude.
" } }, "com.amazonaws.codepipeline#GitPushFilterList": { @@ -4835,7 +4850,7 @@ } }, "traits": { - "smithy.api#documentation": "The field that specifies to filter on the latest execution in the pipeline.
\nFiltering on the latest execution is available for executions run on or after\n February 08, 2024.
\nThe field that specifies to filter on the latest execution in the\n pipeline.
\nFiltering on the latest execution is available for executions run on or after\n February 08, 2024.
\nThe method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
" + "smithy.api#documentation": "The method that the pipeline will use to handle multiple executions. The default\n mode is SUPERSEDED.
" } }, "pipelineType": { "target": "com.amazonaws.codepipeline#PipelineType", "traits": { - "smithy.api#documentation": "CodePipeline provides the following pipeline types, which differ in characteristics and\n price, so that you can tailor your pipeline features and cost to the needs of your\n applications.
\nV1 type pipelines have a JSON structure that contains standard pipeline,\n stage, and action-level parameters.
\nV2 type pipelines have the same structure as a V1 type, along with additional\n parameters for release safety and trigger configuration.
\nIncluding V2 parameters, such as triggers on Git tags, in the pipeline JSON when\n creating or updating a pipeline will result in the pipeline having the V2 type of\n pipeline and the associated costs.
\nFor information about pricing for CodePipeline, see Pricing.
\n\n For information about which type of pipeline to choose, see What type of pipeline is right for me?.
" + "smithy.api#documentation": "CodePipeline provides the following pipeline types, which differ in\n characteristics and price, so that you can tailor your pipeline features and cost to the\n needs of your applications.
\nV1 type pipelines have a JSON structure that contains standard pipeline,\n stage, and action-level parameters.
\nV2 type pipelines have the same structure as a V1 type, along with additional\n parameters for release safety and trigger configuration.
\nIncluding V2 parameters, such as triggers on Git tags, in the pipeline JSON when\n creating or updating a pipeline will result in the pipeline having the V2 type of\n pipeline and the associated costs.
\nFor information about pricing for CodePipeline, see Pricing.
\nFor information about which type of pipeline to choose, see What type of\n pipeline is right for me?.
" } }, "variables": { @@ -5639,7 +5654,7 @@ "triggers": { "target": "com.amazonaws.codepipeline#PipelineTriggerDeclarationList", "traits": { - "smithy.api#documentation": "The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.
\nWhen a trigger configuration is specified, default change detection for\n repository and branch commits is disabled.
\nThe trigger configuration specifying a type of event, such as Git tags, that starts\n the pipeline.
\nWhen a trigger configuration is specified, default change detection for\n repository and branch commits is disabled.
\nThe method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
" + "smithy.api#documentation": "The method that the pipeline will use to handle multiple executions. The default\n mode is SUPERSEDED.
" } } }, @@ -5837,7 +5852,7 @@ "executionMode": { "target": "com.amazonaws.codepipeline#ExecutionMode", "traits": { - "smithy.api#documentation": "The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
" + "smithy.api#documentation": "The method that the pipeline will use to handle multiple executions. The default\n mode is SUPERSEDED.
" } } }, @@ -5953,13 +5968,13 @@ "pipelineType": { "target": "com.amazonaws.codepipeline#PipelineType", "traits": { - "smithy.api#documentation": "CodePipeline provides the following pipeline types, which differ in characteristics and\n price, so that you can tailor your pipeline features and cost to the needs of your\n applications.
\nV1 type pipelines have a JSON structure that contains standard pipeline,\n stage, and action-level parameters.
\nV2 type pipelines have the same structure as a V1 type, along with additional\n parameters for release safety and trigger configuration.
\nIncluding V2 parameters, such as triggers on Git tags, in the pipeline JSON when\n creating or updating a pipeline will result in the pipeline having the V2 type of\n pipeline and the associated costs.
\nFor information about pricing for CodePipeline, see Pricing.
\n\n For information about which type of pipeline to choose, see What type of pipeline is right for me?.
" + "smithy.api#documentation": "CodePipeline provides the following pipeline types, which differ in\n characteristics and price, so that you can tailor your pipeline features and cost to the\n needs of your applications.
\nV1 type pipelines have a JSON structure that contains standard pipeline,\n stage, and action-level parameters.
\nV2 type pipelines have the same structure as a V1 type, along with additional\n parameters for release safety and trigger configuration.
\nIncluding V2 parameters, such as triggers on Git tags, in the pipeline JSON when\n creating or updating a pipeline will result in the pipeline having the V2 type of\n pipeline and the associated costs.
\nFor information about pricing for CodePipeline, see Pricing.
\nFor information about which type of pipeline to choose, see What type of\n pipeline is right for me?.
" } }, "executionMode": { "target": "com.amazonaws.codepipeline#ExecutionMode", "traits": { - "smithy.api#documentation": "The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
" + "smithy.api#documentation": "The method that the pipeline will use to handle multiple executions. The default\n mode is SUPERSEDED.
" } }, "created": { @@ -6082,7 +6097,7 @@ "description": { "target": "com.amazonaws.codepipeline#PipelineVariableDescription", "traits": { - "smithy.api#documentation": "The description of a pipeline-level variable. It's used to add additional context about the variable, and not being used at time when pipeline executes.
" + "smithy.api#documentation": "The description of a pipeline-level variable. It's used to add additional context\n about the variable, and not being used at time when pipeline executes.
" } } }, @@ -6966,7 +6981,7 @@ } ], "traits": { - "smithy.api#documentation": "You can retry a stage that has failed without having to run a pipeline again from the beginning. You do\n this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage,\n all actions that are still in progress continue working, and failed actions are\n triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. Before a stage can be retried, it must either have all actions failed or some actions failed and some succeeded.
" + "smithy.api#documentation": "You can retry a stage that has failed without having to run a pipeline again from\n the beginning. You do this by either retrying the failed actions in a stage or by\n retrying all actions in the stage starting from the first action in the stage. When you\n retry the failed actions in a stage, all actions that are still in progress continue\n working, and failed actions are triggered again. When you retry a failed stage from the\n first action in the stage, the stage cannot have any actions in progress. Before a stage\n can be retried, it must either have all actions failed or some actions failed and some\n succeeded.
" } }, "com.amazonaws.codepipeline#RetryStageExecutionInput": { @@ -7531,7 +7546,7 @@ "variables": { "target": "com.amazonaws.codepipeline#PipelineVariableList", "traits": { - "smithy.api#documentation": "A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match [A-Za-z0-9@\\-_]+, \n and the values can be anything except an empty string.
A list that overrides pipeline variables for a pipeline execution that's being\n started. Variable names must match [A-Za-z0-9@\\-_]+, and the values can be\n anything except an empty string.
A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.
" + "smithy.api#documentation": "A list that allows you to specify, or override, the source revision for a pipeline\n execution that's being started. A source revision is the version with all the changes to\n your application code, or source artifact, for the pipeline execution.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/detective.json b/codegen/sdk-codegen/aws-models/detective.json index c093d46e35e..68f27094e6e 100644 --- a/codegen/sdk-codegen/aws-models/detective.json +++ b/codegen/sdk-codegen/aws-models/detective.json @@ -343,7 +343,7 @@ "name": "detective" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Detective uses machine learning and purpose-built visualizations to help you to\n analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such\n as login attempts, API calls, and network traffic from CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by\n Amazon GuardDuty.
\nThe Detective API primarily supports the creation and management of behavior\n graphs. A behavior graph contains the extracted data from a set of member accounts, and is\n created and managed by an administrator account.
\nTo add a member account to the behavior graph, the administrator account sends an\n invitation to the account. When the account accepts the invitation, it becomes a member\n account in the behavior graph.
\nDetective is also integrated with Organizations. The organization\n management account designates the Detective administrator account for the\n organization. That account becomes the administrator account for the organization behavior\n graph. The Detective administrator account is also the delegated administrator\n account for Detective in Organizations.
\nThe Detective administrator account can enable any organization account as a\n member account in the organization behavior graph. The organization accounts do not receive\n invitations. The Detective administrator account can also invite other accounts to\n the organization behavior graph.
\nEvery behavior graph is specific to a Region. You can only use the API to manage\n behavior graphs that belong to the Region that is associated with the currently selected\n endpoint.
\nThe administrator account for a behavior graph can use the Detective API to do\n the following:
\nEnable and disable Detective. Enabling Detective creates a new\n behavior graph.
\nView the list of member accounts in a behavior graph.
\nAdd member accounts to a behavior graph.
\nRemove member accounts from a behavior graph.
\nApply tags to a behavior graph.
\nThe organization management account can use the Detective API to select the\n delegated administrator for Detective.
\nThe Detective administrator account for an organization can use the Detective API to do the following:
\nPerform all of the functions of an administrator account.
\nDetermine whether to automatically enable new organization accounts as member\n accounts in the organization behavior graph.
\nAn invited member account can use the Detective API to do the following:
\nView the list of behavior graphs that they are invited to.
\nAccept an invitation to contribute to a behavior graph.
\nDecline an invitation to contribute to a behavior graph.
\nRemove their account from a behavior graph.
\nAll API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail.
\nWe replaced the term \"master account\" with the term \"administrator account.\" An\n administrator account is used to centrally manage multiple accounts. In the case of\n Detective, the administrator account manages the accounts in their behavior\n graph.
\nDetective uses machine learning and purpose-built visualizations to help you to\n analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such\n as login attempts, API calls, and network traffic from CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by\n Amazon GuardDuty.
\nThe Detective API primarily supports the creation and management of behavior\n graphs. A behavior graph contains the extracted data from a set of member accounts, and is\n created and managed by an administrator account.
\nTo add a member account to the behavior graph, the administrator account sends an\n invitation to the account. When the account accepts the invitation, it becomes a member\n account in the behavior graph.
\nDetective is also integrated with Organizations. The organization\n management account designates the Detective administrator account for the\n organization. That account becomes the administrator account for the organization behavior\n graph. The Detective administrator account is also the delegated administrator\n account for Detective in Organizations.
\nThe Detective administrator account can enable any organization account as a\n member account in the organization behavior graph. The organization accounts do not receive\n invitations. The Detective administrator account can also invite other accounts to\n the organization behavior graph.
\nEvery behavior graph is specific to a Region. You can only use the API to manage\n behavior graphs that belong to the Region that is associated with the currently selected\n endpoint.
\nThe administrator account for a behavior graph can use the Detective API to do\n the following:
\nEnable and disable Detective. Enabling Detective creates a new\n behavior graph.
\nView the list of member accounts in a behavior graph.
\nAdd member accounts to a behavior graph.
\nRemove member accounts from a behavior graph.
\nApply tags to a behavior graph.
\nThe organization management account can use the Detective API to select the\n delegated administrator for Detective.
\nThe Detective administrator account for an organization can use the Detective API to do the following:
\nPerform all of the functions of an administrator account.
\nDetermine whether to automatically enable new organization accounts as member\n accounts in the organization behavior graph.
\nAn invited member account can use the Detective API to do the following:
\nView the list of behavior graphs that they are invited to.
\nAccept an invitation to contribute to a behavior graph.
\nDecline an invitation to contribute to a behavior graph.
\nRemove their account from a behavior graph.
\nAll API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail.
\nWe replaced the term \"master account\" with the term \"administrator account\". An\n administrator account is used to centrally manage multiple accounts. In the case of\n Detective, the administrator account manages the accounts in their behavior\n graph.
\nCreates a new behavior graph for the calling account, and sets that account as the\n administrator account. This operation is called by the account that is enabling Detective.
\nBefore you try to enable Detective, make sure that your account has been\n enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this\n requirement, you cannot enable Detective. If you do meet the GuardDuty\n prerequisite, then when you make the request to enable Detective, it checks\n whether your data volume is within the Detective quota. If it exceeds the quota,\n then you cannot enable Detective.
\nThe operation also enables Detective for the calling account in the currently\n selected Region. It returns the ARN of the new behavior graph.
\n\n CreateGraph triggers a process to create the corresponding data tables for\n the new behavior graph.
An account can only be the administrator account for one behavior graph within a Region.\n If the same account calls CreateGraph with the same administrator account, it\n always returns the same behavior graph ARN. It does not create a new behavior graph.
Creates a new behavior graph for the calling account, and sets that account as the\n administrator account. This operation is called by the account that is enabling Detective.
\nThe operation also enables Detective for the calling account in the currently\n selected Region. It returns the ARN of the new behavior graph.
\n\n CreateGraph triggers a process to create the corresponding data tables for\n the new behavior graph.
An account can only be the administrator account for one behavior graph within a Region.\n If the same account calls CreateGraph with the same administrator account, it\n always returns the same behavior graph ARN. It does not create a new behavior graph.
A timestamp representing the end date of the time period until when data is filtered , including the end date.
", + "smithy.api#documentation": "A timestamp representing the end date of the time period until when data is filtered, including the end date.
", "smithy.api#required": {} } } @@ -2235,7 +2235,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the investigation results of an investigation for a behavior graph.
", + "smithy.api#documentation": "Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. GetInvestigation returns the investigation results of an investigation for a behavior graph.
The ARN of the behavior graph.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the behavior graph.
", "smithy.api#required": {} } }, @@ -2271,7 +2271,7 @@ "GraphArn": { "target": "com.amazonaws.detective#GraphArn", "traits": { - "smithy.api#documentation": "The ARN of the behavior graph.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the behavior graph.
" } }, "InvestigationId": { @@ -2283,49 +2283,49 @@ "EntityArn": { "target": "com.amazonaws.detective#EntityArn", "traits": { - "smithy.api#documentation": "The unique Amazon Resource Name (ARN) of the IAM user and IAM role.
" + "smithy.api#documentation": "The unique Amazon Resource Name (ARN). Detective supports IAM user ARNs and IAM role ARNs.
" } }, "EntityType": { "target": "com.amazonaws.detective#EntityType", "traits": { - "smithy.api#documentation": "Type of entity. For example, Amazon Web Services accounts, such as IAM user and role.
" + "smithy.api#documentation": "Type of entity. For example, Amazon Web Services accounts, such as an IAM user and/or IAM role.
" } }, "CreatedTime": { "target": "com.amazonaws.detective#Timestamp", "traits": { - "smithy.api#documentation": "The UTC time stamp of the creation time of the investigation report.
" + "smithy.api#documentation": "The creation time of the investigation report in UTC time stamp format.
" } }, "ScopeStartTime": { "target": "com.amazonaws.detective#Timestamp", "traits": { - "smithy.api#documentation": "The start date and time for the scope time set to generate the investigation report.
" + "smithy.api#documentation": "The start date and time used to set the scope time within which you want to generate the investigation report. The value is an UTC ISO8601 formatted\n string. For example, 2021-08-18T16:35:56.284Z.
The data and time when the investigation began. The value is an UTC ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
" + "smithy.api#documentation": "The data and time when the investigation began. The value is an UTC ISO8601 formatted\n string. For example, 2021-08-18T16:35:56.284Z.
Status based on the completion status of the investigation.
" + "smithy.api#documentation": "The status based on the completion status of the investigation.
" } }, "Severity": { "target": "com.amazonaws.detective#Severity", "traits": { - "smithy.api#documentation": "Severity based on the likelihood and impact of the indicators of compromise discovered in the investigation.
" + "smithy.api#documentation": "The severity assigned is based on the likelihood and impact of the indicators of\n compromise discovered in the investigation.
" } }, "State": { "target": "com.amazonaws.detective#State", "traits": { - "smithy.api#documentation": "The current state of the investigation. An archived investigation indicates you have completed reviewing the investigation.
" + "smithy.api#documentation": "The current state of the investigation. An archived investigation indicates that you\n have completed reviewing the investigation.
" } } }, @@ -2462,7 +2462,7 @@ "StartingIpAddress": { "target": "com.amazonaws.detective#IpAddress", "traits": { - "smithy.api#documentation": "IP address where the resource was first used in the impossible travel
" + "smithy.api#documentation": "IP address where the resource was first used in the impossible travel.
" } }, "EndingIpAddress": { @@ -2474,7 +2474,7 @@ "StartingLocation": { "target": "com.amazonaws.detective#Location", "traits": { - "smithy.api#documentation": "Location where the resource was first used in the impossible travel
" + "smithy.api#documentation": "Location where the resource was first used in the impossible travel.
" } }, "EndingLocation": { @@ -2500,18 +2500,18 @@ "IndicatorType": { "target": "com.amazonaws.detective#IndicatorType", "traits": { - "smithy.api#documentation": "The type of indicator.
" + "smithy.api#documentation": "The type of indicator.
" } }, "IndicatorDetail": { "target": "com.amazonaws.detective#IndicatorDetail", "traits": { - "smithy.api#documentation": "Details about the indicator of compromise.
" + "smithy.api#documentation": "Details about the indicators of compromise that are used to determine if a resource is involved in a security incident. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident.
" } } }, "traits": { - "smithy.api#documentation": "Investigations triages indicators of compromises such as a finding and surfaces only the most critical and suspicious issues, so you can focus on high-level investigations.
" + "smithy.api#documentation": "Detective investigations triages indicators of compromises such as a finding\n and surfaces only the most critical and suspicious issues, so you can focus on high-level\n investigations. An Indicator lets you determine if an Amazon Web Services\n resource is involved in unusual activity that could indicate malicious behavior and its\n impact.
Suspicious IP addresses that are flagged, which indicates critical or severe threats based on threat intelligence by Detective. This indicator is derived from AWS threat intelligence.
" + "smithy.api#documentation": "Suspicious IP addresses that are flagged, which indicates critical or severe threats based on threat intelligence by Detective. This indicator is derived from Amazon Web Services threat intelligence.
" } }, "NewGeolocationDetail": { @@ -2567,7 +2567,7 @@ } }, "traits": { - "smithy.api#documentation": "Details about the indicators of compromise which are used to determine if a resource is involved in a security incident.
" + "smithy.api#documentation": "Details about the indicators of compromise which are used to determine if a resource is involved in a security incident. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. For the list of indicators of compromise that are generated by Detective investigations, see Detective investigations.
" } }, "com.amazonaws.detective#IndicatorType": { @@ -2672,7 +2672,7 @@ "CreatedTime": { "target": "com.amazonaws.detective#Timestamp", "traits": { - "smithy.api#documentation": "The UTC time stamp of the creation time of the investigation report.
" + "smithy.api#documentation": "The time stamp of the creation time of the investigation report. The value is an UTC ISO8601 formatted\n string. For example, 2021-08-18T16:35:56.284Z.
Details about the investigation related to a potential security event identified by Detective
" + "smithy.api#documentation": "Details about the investigation related to a potential security event identified by Detective.
" } }, "com.amazonaws.detective#InvestigationDetails": { @@ -2925,7 +2925,7 @@ } ], "traits": { - "smithy.api#documentation": "Get the indicators from an investigation
", + "smithy.api#documentation": "Gets the indicators from an investigation. You can use the information from the indicators to determine if an IAM user and/or IAM role is involved in an unusual activity that could indicate malicious behavior and its impact.
", "smithy.api#http": { "method": "POST", "uri": "/investigations/listIndicators", @@ -2939,7 +2939,7 @@ "GraphArn": { "target": "com.amazonaws.detective#GraphArn", "traits": { - "smithy.api#documentation": "The ARN of the behavior graph.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the behavior graph.
", "smithy.api#required": {} } }, @@ -2953,19 +2953,19 @@ "IndicatorType": { "target": "com.amazonaws.detective#IndicatorType", "traits": { - "smithy.api#documentation": "See Detective investigations..
" + "smithy.api#documentation": "For the list of indicators of compromise that are generated by Detective investigations, see Detective investigations.
" } }, "NextToken": { "target": "com.amazonaws.detective#AiPaginationToken", "traits": { - "smithy.api#documentation": "List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
\nEach pagination token expires after 24 hours. Using an expired pagination token will return a Validation Exception error.
" + "smithy.api#documentation": "Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
\nEach pagination token expires after 24 hours. Using an expired pagination token will return a Validation Exception error.
" } }, "MaxResults": { "target": "com.amazonaws.detective#MaxResults", "traits": { - "smithy.api#documentation": "List the maximum number of indicators in a page.
" + "smithy.api#documentation": "Lists the maximum number of indicators in a page.
" } } }, @@ -2979,7 +2979,7 @@ "GraphArn": { "target": "com.amazonaws.detective#GraphArn", "traits": { - "smithy.api#documentation": "The ARN of the behavior graph.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the behavior graph.
" } }, "InvestigationId": { @@ -2991,13 +2991,13 @@ "NextToken": { "target": "com.amazonaws.detective#AiPaginationToken", "traits": { - "smithy.api#documentation": "List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
\nEach pagination token expires after 24 hours. Using an expired pagination token will return a Validation Exception error.
" + "smithy.api#documentation": "Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
\nEach pagination token expires after 24 hours. Using an expired pagination token will return a Validation Exception error.
" } }, "Indicators": { "target": "com.amazonaws.detective#Indicators", "traits": { - "smithy.api#documentation": "Indicators of compromise listed based on severity.
" + "smithy.api#documentation": "Lists the indicators of compromise.
" } } }, @@ -3031,7 +3031,7 @@ } ], "traits": { - "smithy.api#documentation": "List all Investigations.
", + "smithy.api#documentation": "Detective investigations lets you investigate IAM users and\n IAM roles using indicators of compromise. An indicator of compromise\n (IOC) is an artifact observed in or on a network, system, or environment that can (with a\n high level of confidence) identify malicious activity or a security incident.\n ListInvestigations lists all active Detective\n investigations.
The ARN of the behavior graph.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the behavior graph.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.detective#AiPaginationToken", "traits": { - "smithy.api#documentation": "List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
\nEach pagination token expires after 24 hours. Using an expired pagination token will return a Validation Exception error.
" + "smithy.api#documentation": "Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
\nEach pagination token expires after 24 hours. Using an expired pagination token will return a Validation Exception error.
" } }, "MaxResults": { "target": "com.amazonaws.detective#MaxResults", "traits": { - "smithy.api#documentation": "List the maximum number of investigations in a page.
" + "smithy.api#documentation": "Lists the maximum number of investigations in a page.
" } }, "FilterCriteria": { "target": "com.amazonaws.detective#FilterCriteria", "traits": { - "smithy.api#documentation": "Filter the investigation results based on a criteria.
" + "smithy.api#documentation": "Filters the investigation results based on a criteria.
" } }, "SortCriteria": { @@ -3084,13 +3084,13 @@ "InvestigationDetails": { "target": "com.amazonaws.detective#InvestigationDetails", "traits": { - "smithy.api#documentation": "Investigations details lists the summary of uncommon behavior or malicious activity which indicates a compromise.
" + "smithy.api#documentation": "Lists the summary of uncommon behavior or malicious activity which indicates a compromise.
" } }, "NextToken": { "target": "com.amazonaws.detective#AiPaginationToken", "traits": { - "smithy.api#documentation": "List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
\nEach pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
" + "smithy.api#documentation": "Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
\nEach pagination token expires after 24 hours.
" } } }, @@ -3634,7 +3634,7 @@ "target": "com.amazonaws.detective#IsNewForEntireAccount", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Checks if the ASO is for new for the entire account.
" + "smithy.api#documentation": "Checks if the Autonomous System Organization (ASO) is new for the entire account.
" } } }, @@ -3661,7 +3661,7 @@ "target": "com.amazonaws.detective#IsNewForEntireAccount", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Checks if the gelocation is new for the entire account.
" + "smithy.api#documentation": "Checks if the geolocation is new for the entire account.
" } } }, @@ -3771,7 +3771,7 @@ "Arn": { "target": "com.amazonaws.detective#EntityArn", "traits": { - "smithy.api#documentation": "The ARN of the related finding.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the related finding.
" } }, "Type": { @@ -3853,7 +3853,7 @@ } }, "traits": { - "smithy.api#documentation": "This request cannot be completed for one of the following reasons.
\nThe request would cause the number of member accounts in the behavior graph to\n exceed the maximum allowed. A behavior graph cannot have more than 1200 member\n accounts.
\nThe request would cause the data rate for the behavior graph to exceed the maximum\n allowed.
\nDetective is unable to verify the data rate for the member account. This\n is usually because the member account is not enrolled in Amazon GuardDuty.
\nThis request cannot be completed for one of the following reasons.
\nThis request cannot be completed if it would cause the number of member accounts in the\n behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200\n member accounts.
\nThis request cannot be completed if the current volume ingested is above the limit of 10 TB per day. Detective will not allow you to add additional member accounts.
\ninitiate an investigation on an entity in a graph
", + "smithy.api#documentation": "Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. StartInvestigation initiates an investigation on an entity in a behavior graph.
The ARN of the behavior graph.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the behavior graph.
", "smithy.api#required": {} } }, @@ -3991,7 +3991,7 @@ "ScopeEndTime": { "target": "com.amazonaws.detective#Timestamp", "traits": { - "smithy.api#documentation": "The data and time when the investigation began. The value is an UTC ISO8601 formatted\n string. For example, 2021-08-18T16:35:56.284Z.
The data and time when the investigation ended. The value is an UTC ISO8601 formatted\n string. For example, 2021-08-18T16:35:56.284Z.
The IP address where the TTP was observed.
" + "smithy.api#documentation": "The IP address where the tactics, techniques, and procedure (TTP) was observed.
" } }, "APIName": { "target": "com.amazonaws.detective#APIName", "traits": { - "smithy.api#documentation": "The name of the API where the TTP was observed.
" + "smithy.api#documentation": "The name of the API where the tactics, techniques, and procedure (TTP) was observed.
" } }, "APISuccessCount": { @@ -4528,7 +4528,7 @@ } ], "traits": { - "smithy.api#documentation": "Update the state of an investigation.
", + "smithy.api#documentation": "Updates the state of an investigation.
", "smithy.api#http": { "method": "POST", "uri": "/investigations/updateInvestigationState", @@ -4542,7 +4542,7 @@ "GraphArn": { "target": "com.amazonaws.detective#GraphArn", "traits": { - "smithy.api#documentation": "The ARN of the behavior graph.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the behavior graph.
", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/guardduty.json b/codegen/sdk-codegen/aws-models/guardduty.json index aeb5a1ab259..2a2021b95cb 100644 --- a/codegen/sdk-codegen/aws-models/guardduty.json +++ b/codegen/sdk-codegen/aws-models/guardduty.json @@ -4492,7 +4492,8 @@ "smithy.api#length": { "min": 1, "max": 64 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.guardduty#EnableOrganizationAdminAccount": { @@ -5639,7 +5640,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists Amazon GuardDuty findings statistics for the specified detector ID.
", + "smithy.api#documentation": "Lists Amazon GuardDuty findings statistics for the specified detector ID.
\nThere might be regional differences because some flags might not be available in all the Regions where GuardDuty\n is currently supported. For more information, see Regions and endpoints.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/findings/statistics", @@ -9036,7 +9037,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists Amazon GuardDuty findings for the specified detector ID.
", + "smithy.api#documentation": "Lists GuardDuty findings for the specified detector ID.
\nThere might be regional differences because some flags might not be available in all the Regions where GuardDuty\n is currently supported. For more information, see Regions and endpoints.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/findings", @@ -9694,7 +9695,7 @@ "type": "structure", "members": { "IpAddressV4": { - "target": "com.amazonaws.guardduty#String", + "target": "com.amazonaws.guardduty#SensitiveString", "traits": { "smithy.api#documentation": "The IPv4 local address of the connection.
", "smithy.api#jsonName": "ipAddressV4" @@ -10285,7 +10286,7 @@ } }, "PrivateIpAddress": { - "target": "com.amazonaws.guardduty#String", + "target": "com.amazonaws.guardduty#SensitiveString", "traits": { "smithy.api#documentation": "The private IP address of the EC2 instance.
", "smithy.api#jsonName": "privateIpAddress" @@ -11139,7 +11140,7 @@ } }, "PrivateIpAddress": { - "target": "com.amazonaws.guardduty#String", + "target": "com.amazonaws.guardduty#SensitiveString", "traits": { "smithy.api#documentation": "The private IP address of the EC2 instance.
", "smithy.api#jsonName": "privateIpAddress" @@ -11540,7 +11541,7 @@ } }, "IpAddressV4": { - "target": "com.amazonaws.guardduty#String", + "target": "com.amazonaws.guardduty#SensitiveString", "traits": { "smithy.api#documentation": "The IPv4 remote address of the connection.
", "smithy.api#jsonName": "ipAddressV4" @@ -12504,6 +12505,12 @@ "target": "com.amazonaws.guardduty#SecurityGroup" } }, + "com.amazonaws.guardduty#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.guardduty#Service": { "type": "structure", "members": { @@ -13452,7 +13459,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the Amazon GuardDuty detector specified by the detectorId.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#documentation": "Updates the GuardDuty detector specified by the detectorId.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}", diff --git a/codegen/sdk-codegen/aws-models/healthlake.json b/codegen/sdk-codegen/aws-models/healthlake.json index ffe2c05aafe..3d52f0ee345 100644 --- a/codegen/sdk-codegen/aws-models/healthlake.json +++ b/codegen/sdk-codegen/aws-models/healthlake.json @@ -664,7 +664,7 @@ "ImportJobProperties": { "target": "com.amazonaws.healthlake#ImportJobProperties", "traits": { - "smithy.api#documentation": "The properties of the Import job request, including the ID, ARN, name, and the status of the job.
", + "smithy.api#documentation": "The properties of the Import job request, including the ID, ARN, name, status of the job, and the progress report of the job.
", "smithy.api#required": {} } } @@ -767,6 +767,12 @@ } } }, + "com.amazonaws.healthlake#GenericDouble": { + "type": "double" + }, + "com.amazonaws.healthlake#GenericLong": { + "type": "long" + }, "com.amazonaws.healthlake#HealthLake": { "type": "service", "version": "2017-07-01", @@ -867,7 +873,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -910,7 +915,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -923,7 +929,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -937,7 +942,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -960,7 +964,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -995,7 +998,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -1006,14 +1008,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -1027,14 +1031,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -1043,11 +1045,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -1058,14 +1060,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -1079,7 +1083,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1099,7 +1102,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -1110,14 +1112,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1128,9 +1132,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1578,6 +1584,12 @@ "JobOutputDataConfig": { "target": "com.amazonaws.healthlake#OutputDataConfig" }, + "JobProgressReport": { + "target": "com.amazonaws.healthlake#JobProgressReport", + "traits": { + "smithy.api#documentation": "Displays the progress of the import job, including total resources scanned, total resources ingested, and total size of data ingested.
" + } + }, "DataAccessRoleArn": { "target": "com.amazonaws.healthlake#IamRoleArn", "traits": { @@ -1592,7 +1604,7 @@ } }, "traits": { - "smithy.api#documentation": "Displays the properties of the import job, including the ID, Arn, Name, and the status of the data store.
" + "smithy.api#documentation": "Displays the properties of the import job, including the ID, Arn, Name, the status of the job, and the progress report of the job.
" } }, "com.amazonaws.healthlake#ImportJobPropertiesList": { @@ -1648,6 +1660,62 @@ "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" } }, + "com.amazonaws.healthlake#JobProgressReport": { + "type": "structure", + "members": { + "TotalNumberOfScannedFiles": { + "target": "com.amazonaws.healthlake#GenericLong", + "traits": { + "smithy.api#documentation": "The number of files scanned from input S3 bucket.
" + } + }, + "TotalSizeOfScannedFilesInMB": { + "target": "com.amazonaws.healthlake#GenericDouble", + "traits": { + "smithy.api#documentation": "The size (in MB) of the files scanned from the input S3 bucket.
" + } + }, + "TotalNumberOfImportedFiles": { + "target": "com.amazonaws.healthlake#GenericLong", + "traits": { + "smithy.api#documentation": "The number of files imported so far.
" + } + }, + "TotalNumberOfResourcesScanned": { + "target": "com.amazonaws.healthlake#GenericLong", + "traits": { + "smithy.api#documentation": "The number of resources scanned from the input S3 bucket.
" + } + }, + "TotalNumberOfResourcesImported": { + "target": "com.amazonaws.healthlake#GenericLong", + "traits": { + "smithy.api#documentation": "The number of resources imported so far.
" + } + }, + "TotalNumberOfResourcesWithCustomerError": { + "target": "com.amazonaws.healthlake#GenericLong", + "traits": { + "smithy.api#documentation": "The number of resources that failed due to customer error.
" + } + }, + "TotalNumberOfFilesReadWithCustomerError": { + "target": "com.amazonaws.healthlake#GenericLong", + "traits": { + "smithy.api#documentation": "The number of files that failed to be read from the input S3 bucket due to customer error.
" + } + }, + "Throughput": { + "target": "com.amazonaws.healthlake#GenericDouble", + "traits": { + "smithy.api#documentation": "The throughput (in MB/sec) of the import job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The progress report of an import job.
" + } + }, "com.amazonaws.healthlake#JobStatus": { "type": "enum", "members": { @@ -2010,7 +2078,7 @@ "ImportJobPropertiesList": { "target": "com.amazonaws.healthlake#ImportJobPropertiesList", "traits": { - "smithy.api#documentation": "\n The properties of a listed FHIR import jobs, including the ID, ARN, name, and the status of the job.\n
", + "smithy.api#documentation": "\n The properties of a listed FHIR import jobs, including the ID, ARN, name, the status of the job, and the progress report of the job.\n
", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/opensearch.json b/codegen/sdk-codegen/aws-models/opensearch.json index 78b7c230fa0..8157d81a080 100644 --- a/codegen/sdk-codegen/aws-models/opensearch.json +++ b/codegen/sdk-codegen/aws-models/opensearch.json @@ -768,7 +768,7 @@ "name": "es" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Use the Amazon OpenSearch Service configuration API to create, configure, and manage\n OpenSearch Service domains.
\nFor sample code that uses the configuration API, see the \n Amazon OpenSearch Service Developer Guide\n . The guide also\n contains sample code for\n sending signed HTTP requests to the OpenSearch APIs. The endpoint for configuration service\n requests is Region specific: es.region.amazonaws.com. For example,\n es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services\n service endpoints.
", + "smithy.api#documentation": "Use the Amazon OpenSearch Service configuration API to create, configure, and manage\n OpenSearch Service domains. The endpoint for configuration service requests is Region specific:\n es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a\n current list of supported Regions and endpoints, see Amazon Web Services service\n endpoints.
", "smithy.api#title": "Amazon OpenSearch Service", "smithy.api#xmlNamespace": { "uri": "http://es.amazonaws.com/doc/2021-01-01/" @@ -2973,7 +2973,7 @@ "Enabled": { "target": "com.amazonaws.opensearch#Boolean", "traits": { - "smithy.api#documentation": "Whether to enable or disable cold storage on the domain.
", + "smithy.api#documentation": "Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.
", "smithy.api#required": {} } } @@ -4262,7 +4262,7 @@ "NextToken": { "target": "com.amazonaws.opensearch#NextToken", "traits": { - "smithy.api#documentation": "When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Send the request again using the\n returned token to retrieve the next page.
Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.
\nEach tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.
\nTags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n
Tags that you add to a SageMaker Domain or User Profile by calling this API\n are also added to any Apps that the Domain or User Profile launches after you call\n this API, but not to Apps that the Domain or User Profile launched before you called\n this API. To make sure that the tags associated with a Domain or User Profile are\n also added to all Apps that the Domain or User Profile launches, add the tags when\n you first create the Domain or User Profile by specifying them in the\n Tags parameter of CreateDomain\n or CreateUserProfile.
Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.
\nEach tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.
\nTags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n
Tags that you add to a SageMaker Domain or User Profile by calling this API are\n also added to any Apps that the Domain or User Profile launches after you call this\n API, but not to Apps that the Domain or User Profile launched before you called this\n API. To make sure that the tags associated with a Domain or User Profile are also\n added to all Apps that the Domain or User Profile launches, add the tags when you\n first create the Domain or User Profile by specifying them in the Tags\n parameter of CreateDomain\n or CreateUserProfile.
Configuration for remote debugging. To learn more about the remote \n debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) \n for remote debugging.
" + "smithy.api#documentation": "Configuration for remote debugging. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
" } }, "InfraCheckConfig": { @@ -14599,7 +14599,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob\n API deletes only the tuning job entry that was created in SageMaker when you called the\n CreateHyperParameterTuningJob API. It does not delete training jobs,\n artifacts, or the IAM role that you specified when creating the model.
Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob\n API deletes only the tuning job entry that was created in SageMaker when you called the\n CreateHyperParameterTuningJob API. It does not delete training jobs,\n artifacts, or the IAM role that you specified when creating the model.
Deletes the specified tags from an SageMaker resource.
\nTo list a resource's tags, use the ListTags API.
When you call this API to delete tags from a hyperparameter tuning job, the\n deleted tags are not removed from training jobs that the hyperparameter tuning job\n launched before you called this API.
\nWhen you call this API to delete tags from a SageMaker Domain or User\n Profile, the deleted tags are not removed from Apps that the SageMaker Domain\n or User Profile launched before you called this API.
\nDeletes the specified tags from an SageMaker resource.
\nTo list a resource's tags, use the ListTags API.
When you call this API to delete tags from a hyperparameter tuning job, the\n deleted tags are not removed from training jobs that the hyperparameter tuning job\n launched before you called this API.
\nWhen you call this API to delete tags from a SageMaker Domain or User Profile, the\n deleted tags are not removed from Apps that the SageMaker Domain or User Profile\n launched before you called this API.
\nConfiguration for remote debugging. To learn more about the remote \n debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) \n for remote debugging.
" + "smithy.api#documentation": "Configuration for remote debugging. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
" } }, "InfraCheckConfig": { @@ -41702,7 +41702,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information about the location that is configured for storing model\n artifacts.
\nModel artifacts are the output that results from training a model, and typically\n consist of trained parameters, a model definition that describes how to compute\n inferences, and other metadata.
" + "smithy.api#documentation": "Provides information about the location that is configured for storing model\n artifacts.
\nModel artifacts are outputs that result from training a model. They typically consist\n of trained parameters, a model definition that describes how to compute inferences, and\n other metadata. A SageMaker container stores your trained model artifacts in the\n /opt/ml/model directory. After training has completed, by default, these artifacts\n are uploaded to your Amazon S3 bucket as compressed files.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The\n KmsKeyId can be any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// KMS Key Alias
\n\n \"alias/ExampleAlias\"\n
// Amazon Resource Name (ARN) of a KMS Key Alias
\n\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account.\n \n For more information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide. If the output\n data is stored in Amazon S3 Express One Zone, it is encrypted with server-side\n encryption with Amazon S3 managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone
The KMS key policy must grant permission to the IAM role that you specify in your\n CreateTrainingJob, CreateTransformJob, or\n CreateHyperParameterTuningJob requests. For more information, see\n Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services\n Key Management Service Developer Guide.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker\n uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The\n KmsKeyId can be any of the following formats:
// KMS Key ID
\n\n \"1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// Amazon Resource Name (ARN) of a KMS Key
\n\n \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"\n
// KMS Key Alias
\n\n \"alias/ExampleAlias\"\n
// Amazon Resource Name (ARN) of a KMS Key Alias
\n\n \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"\n
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must\n include permissions to call kms:Encrypt. If you don't provide a KMS key ID,\n SageMaker uses the default KMS key for Amazon S3 for your role's account.\n \n For more information, see KMS-Managed Encryption\n Keys in the Amazon Simple Storage Service Developer Guide. If the output\n data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3\n managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone
The KMS key policy must grant permission to the IAM role that you specify in your\n CreateTrainingJob, CreateTransformJob, or\n CreateHyperParameterTuningJob requests. For more information, see\n Using\n Key Policies in Amazon Web Services KMS in the Amazon Web Services\n Key Management Service Developer Guide.
Configuration for remote debugging for the CreateTrainingJob API. To learn more about the remote \n debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) \n for remote debugging.
" + "smithy.api#documentation": "Configuration for remote debugging for the CreateTrainingJob API. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
" } }, "com.amazonaws.sagemaker#RemoteDebugConfigForUpdate": { @@ -52307,7 +52307,7 @@ } }, "traits": { - "smithy.api#documentation": "Configuration for remote debugging for the UpdateTrainingJob API. To learn more about the remote \n debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) \n for remote debugging.
" + "smithy.api#documentation": "Configuration for remote debugging for the UpdateTrainingJob API. To learn more about the remote debugging\n functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
" } }, "com.amazonaws.sagemaker#RenderUiTemplate": { @@ -53236,7 +53236,7 @@ "target": "com.amazonaws.sagemaker#S3Uri", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Depending on the value specified for the S3DataType, identifies either\n a key name prefix or a manifest. For example:
A key name prefix might look like this:\n\t\ts3://bucketname/exampleprefix/\n
A manifest might look like this:\n s3://bucketname/example.manifest\n
A manifest is an S3 object which is a JSON file consisting of an array of\n elements. The first element is a prefix which is followed by one or more\n suffixes. SageMaker appends the suffix elements to the prefix to get a full set of\n S3Uri. Note that the prefix must be a valid non-empty\n S3Uri that precludes users from specifying a manifest whose\n individual S3Uri is sourced from different S3 buckets.
The following code example shows a valid manifest format:
\n\n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n
\n \"relative/path/to/custdata-1\",\n
\n \"relative/path/custdata-2\",\n
\n ...\n
\n \"relative/path/custdata-N\"\n
\n ]\n
This JSON is equivalent to the following S3Uri\n list:
\n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-2\n
\n ...\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-N\n
The complete set of S3Uri in this manifest is the input data\n for the channel for this data source. The object that each S3Uri\n points to must be readable by the IAM role that SageMaker uses to perform tasks on\n your behalf.
Your input bucket must be located in same Amazon Web Services region as your\n training job.
", + "smithy.api#documentation": "Depending on the value specified for the S3DataType, identifies either\n a key name prefix or a manifest. For example:
A key name prefix might look like this:\n s3://bucketname/exampleprefix/\n
A manifest might look like this:\n s3://bucketname/example.manifest\n
A manifest is an S3 object which is a JSON file consisting of an array of\n elements. The first element is a prefix which is followed by one or more\n suffixes. SageMaker appends the suffix elements to the prefix to get a full set of\n S3Uri. Note that the prefix must be a valid non-empty\n S3Uri that precludes users from specifying a manifest whose\n individual S3Uri is sourced from different S3 buckets.
The following code example shows a valid manifest format:
\n\n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n
\n \"relative/path/to/custdata-1\",\n
\n \"relative/path/custdata-2\",\n
\n ...\n
\n \"relative/path/custdata-N\"\n
\n ]\n
This JSON is equivalent to the following S3Uri\n list:
\n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-2\n
\n ...\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-N\n
The complete set of S3Uri in this manifest is the input data\n for the channel for this data source. The object that each S3Uri\n points to must be readable by the IAM role that SageMaker uses to perform tasks on\n your behalf.
Your input bucket must be located in same Amazon Web Services region as your\n training job.
", "smithy.api#required": {} } }, @@ -54264,6 +54264,9 @@ { "target": "com.amazonaws.sagemaker#UpdateCluster" }, + { + "target": "com.amazonaws.sagemaker#UpdateClusterSoftware" + }, { "target": "com.amazonaws.sagemaker#UpdateCodeRepository" }, @@ -62679,7 +62682,7 @@ } ], "traits": { - "smithy.api#documentation": "Update a SageMaker HyperPod cluster.
" + "smithy.api#documentation": "Updates a SageMaker HyperPod cluster.
" } }, "com.amazonaws.sagemaker#UpdateClusterRequest": { @@ -62722,6 +62725,58 @@ "smithy.api#output": {} } }, + "com.amazonaws.sagemaker#UpdateClusterSoftware": { + "type": "operation", + "input": { + "target": "com.amazonaws.sagemaker#UpdateClusterSoftwareRequest" + }, + "output": { + "target": "com.amazonaws.sagemaker#UpdateClusterSoftwareResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sagemaker#ConflictException" + }, + { + "target": "com.amazonaws.sagemaker#ResourceNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to\n use this API, see Update the SageMaker HyperPod platform software of a cluster.
" + } + }, + "com.amazonaws.sagemaker#UpdateClusterSoftwareRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.sagemaker#ClusterNameOrArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security\n patching.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sagemaker#UpdateClusterSoftwareResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.sagemaker#ClusterArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated for security patching.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sagemaker#UpdateCodeRepository": { "type": "operation", "input": { @@ -63043,7 +63098,7 @@ } ], "traits": { - "smithy.api#documentation": "Deploys the EndpointConfig specified in the request\n to a new fleet of instances. SageMaker shifts endpoint traffic to the new instances\n with the updated endpoint configuration and then deletes the old instances\n using the previous EndpointConfig (there is no availability loss).\n For more information about how to control the update and traffic shifting process, see\n \n Update models in production.
When SageMaker receives the request, it sets the endpoint status to\n Updating. After updating the endpoint, it sets the status to\n InService. To check the status of an endpoint, use the DescribeEndpoint API.\n \n
You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.
If you delete the EndpointConfig of an endpoint that is active or\n being created or updated you may lose visibility into the instance type the endpoint\n is using. The endpoint must be deleted in order to stop incurring charges.
Deploys the EndpointConfig specified in the request to a new fleet of\n instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint\n configuration and then deletes the old instances using the previous\n EndpointConfig (there is no availability loss). For more information\n about how to control the update and traffic shifting process, see Update\n models in production.
When SageMaker receives the request, it sets the endpoint status to Updating.\n After updating the endpoint, it sets the status to InService. To check the\n status of an endpoint, use the DescribeEndpoint API.\n \n
You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.
If you delete the EndpointConfig of an endpoint that is active or\n being created or updated you may lose visibility into the instance type the endpoint\n is using. The endpoint must be deleted in order to stop incurring charges.
Configuration for remote debugging while the training job is running. You can\n update the remote debugging configuration when the SecondaryStatus of the job\n is Downloading or Training.To learn more about the remote \n debugging functionality of SageMaker, see Access a training container through Amazon Web Services Systems Manager (SSM) \n for remote debugging.
Configuration for remote debugging while the training job is running. You can update\n the remote debugging configuration when the SecondaryStatus of the job is\n Downloading or Training.To learn more about the remote\n debugging functionality of SageMaker, see Access a training container\n through Amazon Web Services Systems Manager (SSM) for remote\n debugging.
The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.
" + "smithy.api#documentation": "The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.
" } }, "Tags": { @@ -1542,7 +1542,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets \n that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.
\nListSecrets is eventually consistent, however it might not reflect changes from the last five minutes. \n To get the latest information for a specific secret, use DescribeSecret.
\nTo list the versions of a secret, use ListSecretVersionIds.
\nTo retrieve the values for the secrets, call BatchGetSecretValue or GetSecretValue.
\nFor information about finding secrets in the console, see Find secrets in Secrets Manager.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:ListSecrets. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.
Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets \n that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.
\nAll Secrets Manager operations are eventually consistent. ListSecrets might not reflect changes from the last five minutes. You can get more recent information for a specific secret by calling DescribeSecret.
\nTo list the versions of a secret, use ListSecretVersionIds.
\nTo retrieve the values for the secrets, call BatchGetSecretValue or GetSecretValue.
\nFor information about finding secrets in the console, see Find secrets in Secrets Manager.
\nSecrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
\n\n Required permissions: \n secretsmanager:ListSecrets. \n For more information, see \n IAM policy actions for Secrets Manager and Authentication \n and access control in Secrets Manager.