This is the ACM Private CA API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing private certificate authorities (CA) for your organization.
The documentation for each action shows the Query API request parameters and the XML response. Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.
Each ACM Private CA API action has a quota that determines the number of times the action can be called per second. For more information, see API Rate Quotas in ACM Private CA in the ACM Private CA user guide.
Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, the certificate revocation list (CRL) configuration, the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.
ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.
Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Configure Access to ACM Private CA.
Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the private key.
Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Configure Access to ACM Private CA.
ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports.
", + "CreateCertificateAuthority": "Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, the certificate revocation list (CRL) configuration, the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.
ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.
Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Configure Access to ACM Private CA.
Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the private key.
Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Configure Access to ACM Private CA.
ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports.
", "CreatePermission": "Grants one or more permissions on a private CA to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA.
You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action.
About Permissions
If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.
For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.
If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.
Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities action.
Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.
Before you can delete a CA that you have created and activated, you must disable it. To do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED.
Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into ACM Private CA (that is, the status of the CA is PENDING_CERTIFICATE).
When you successfully call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set the PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the restoration window of a private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority action.
Revokes permissions on a private CA granted to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com).
These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates automatically.
Permissions can be granted with the CreatePermission action and listed with the ListPermissions action.
About Permissions
If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.
For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.
If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.
Contains X.509 certificate information to be placed in an issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored.
If conflicting or duplicate certificate information is supplied from other sources, ACM Private CA applies order of operation rules to determine what information is used.
", + "base": "Contains X.509 certificate information to be placed in an issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored.
If conflicting or duplicate certificate information is supplied from other sources, ACM Private CA applies order of operation rules to determine what information is used.
", "refs": { - "IssueCertificateRequest$ApiPassthrough": "Specifies X.509 certificate information to be included in the issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored. For more information about using these templates, see Understanding Certificate Templates.
If conflicting or duplicate certificate information is supplied during certificate issuance, ACM Private CA applies order of operation rules to determine what information is used.
" + "IssueCertificateRequest$ApiPassthrough": "Specifies X.509 certificate information to be included in the issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored. For more information about using these templates, see Understanding Certificate Templates.
If conflicting or duplicate certificate information is supplied during certificate issuance, ACM Private CA applies order of operation rules to determine what information is used.
" } }, "Arn": { @@ -276,7 +276,7 @@ } }, "CrlConfiguration": { - "base": "Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM Private CA.
ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.
Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included.
CRLs contain the following fields:
Version: The current version number defined in RFC 5280 is V2. The integer value is 0x1.
Signature Algorithm: The name of the algorithm used to sign the CRL.
Issuer: The X.500 distinguished name of your private CA that issued the CRL.
Last Update: The issue date and time of this CRL.
Next Update: The day and time by which the next CRL will be issued.
Revoked Certificates: List of revoked certificates. Each list item contains the following information.
Serial Number: The serial number, in hexadecimal format, of the revoked certificate.
Revocation Date: Date and time the certificate was revoked.
CRL Entry Extensions: Optional extensions for the CRL entry.
X509v3 CRL Reason Code: Reason the certificate was revoked.
CRL Extensions: Optional extensions for the CRL.
X509v3 Authority Key Identifier: Identifies the public key associated with the private key used to sign the certificate.
X509v3 CRL Number:: Decimal sequence number for the CRL.
Signature Algorithm: Algorithm used by your private CA to sign the CRL.
Signature Value: Signature computed over the CRL.
Certificate revocation lists created by ACM Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.
openssl crl -inform DER -text -in crl_path -noout
Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM Private CA.
ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.
Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included.
CRLs contain the following fields:
Version: The current version number defined in RFC 5280 is V2. The integer value is 0x1.
Signature Algorithm: The name of the algorithm used to sign the CRL.
Issuer: The X.500 distinguished name of your private CA that issued the CRL.
Last Update: The issue date and time of this CRL.
Next Update: The day and time by which the next CRL will be issued.
Revoked Certificates: List of revoked certificates. Each list item contains the following information.
Serial Number: The serial number, in hexadecimal format, of the revoked certificate.
Revocation Date: Date and time the certificate was revoked.
CRL Entry Extensions: Optional extensions for the CRL entry.
X509v3 CRL Reason Code: Reason the certificate was revoked.
CRL Extensions: Optional extensions for the CRL.
X509v3 Authority Key Identifier: Identifies the public key associated with the private key used to sign the certificate.
X509v3 CRL Number:: Decimal sequence number for the CRL.
Signature Algorithm: Algorithm used by your private CA to sign the CRL.
Signature Value: Signature computed over the CRL.
Certificate revocation lists created by ACM Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.
openssl crl -inform DER -text -in crl_path -noout
Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.
" } @@ -502,6 +502,13 @@ "CertificateAuthorityConfiguration$KeyAlgorithm": "Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.
" } }, + "KeyStorageSecurityStandard": { + "base": null, + "refs": { + "CertificateAuthority$KeyStorageSecurityStandard": "Defines a cryptographic key management compliance standard used for handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Note: AWS Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message \"A certificate authority cannot be created in this region with the specified security standard.\"
Specifies a cryptographic key management compliance standard used for handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Note: AWS Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message \"A certificate authority cannot be created in this region with the specified security standard.\"
Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.
", "refs": { diff --git a/models/apis/chime/2018-05-01/api-2.json b/models/apis/chime/2018-05-01/api-2.json index 5479a161802..44cf1ce657f 100644 --- a/models/apis/chime/2018-05-01/api-2.json +++ b/models/apis/chime/2018-05-01/api-2.json @@ -2481,6 +2481,25 @@ {"shape":"ServiceFailureException"} ] }, + "ListSupportedPhoneNumberCountries":{ + "name":"ListSupportedPhoneNumberCountries", + "http":{ + "method":"GET", + "requestUri":"/phone-number-countries", + "responseCode":200 + }, + "input":{"shape":"ListSupportedPhoneNumberCountriesRequest"}, + "output":{"shape":"ListSupportedPhoneNumberCountriesResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ] + }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ @@ -7026,6 +7045,23 @@ "NextToken":{"shape":"NextTokenString"} } }, + "ListSupportedPhoneNumberCountriesRequest":{ + "type":"structure", + "required":["ProductType"], + "members":{ + "ProductType":{ + "shape":"PhoneNumberProductType", + "location":"querystring", + "locationName":"product-type" + } + } + }, + "ListSupportedPhoneNumberCountriesResponse":{ + "type":"structure", + "members":{ + "PhoneNumberCountries":{"shape":"PhoneNumberCountriesList"} + } + }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceARN"], @@ -7436,6 +7472,7 @@ "members":{ "PhoneNumberId":{"shape":"String"}, "E164PhoneNumber":{"shape":"E164PhoneNumber"}, + "Country":{"shape":"Alpha2CountryCode"}, "Type":{"shape":"PhoneNumberType"}, "ProductType":{"shape":"PhoneNumberProductType"}, "Status":{"shape":"PhoneNumberStatus"}, @@ -7481,6 +7518,17 @@ "OutboundMMS":{"shape":"NullableBoolean"} } }, + "PhoneNumberCountriesList":{ + "type":"list", + "member":{"shape":"PhoneNumberCountry"} + }, + "PhoneNumberCountry":{ + "type":"structure", + "members":{ + "CountryCode":{"shape":"Alpha2CountryCode"}, + "SupportedPhoneNumberTypes":{"shape":"PhoneNumberTypeList"} + } + }, "PhoneNumberError":{ "type":"structure", "members":{ @@ -7530,7 +7578,8 @@ "type":"string", "enum":[ "BusinessCalling", - "VoiceConnector" + "VoiceConnector", + "SipMediaApplicationDialIn" ] }, "PhoneNumberStatus":{ @@ -7553,6 +7602,10 @@ "TollFree" ] }, + "PhoneNumberTypeList":{ + "type":"list", + "member":{"shape":"PhoneNumberType"} + }, "Port":{ "type":"integer", "max":65535, @@ -8118,7 +8171,7 @@ "locationName":"city" }, "Country":{ - "shape":"String", + "shape":"Alpha2CountryCode", "location":"querystring", "locationName":"country" }, @@ -8132,6 +8185,11 @@ "location":"querystring", "locationName":"toll-free-prefix" }, + "PhoneNumberType":{ + "shape":"PhoneNumberType", + "location":"querystring", + "locationName":"phone-number-type" + }, "MaxResults":{ "shape":"PhoneNumberMaxResults", "location":"querystring", @@ -8147,7 +8205,8 @@ "SearchAvailablePhoneNumbersResponse":{ "type":"structure", "members":{ - "E164PhoneNumbers":{"shape":"E164PhoneNumberList"} + "E164PhoneNumbers":{"shape":"E164PhoneNumberList"}, + "NextToken":{"shape":"String"} } }, "SendChannelMessageRequest":{ diff --git a/models/apis/chime/2018-05-01/docs-2.json b/models/apis/chime/2018-05-01/docs-2.json index 72b4e05c9f2..bf97cb658b6 100644 --- a/models/apis/chime/2018-05-01/docs-2.json +++ b/models/apis/chime/2018-05-01/docs-2.json @@ -12,7 +12,7 @@ "BatchDeletePhoneNumber": "Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.
Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
", "BatchSuspendUser": "Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Users suspended from a Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.
Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.
To sign out users without suspending them, use the LogoutUser action.
", "BatchUnsuspendUser": "Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.
Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem . For example, you can update either the product type or the calling name.
For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
", + "BatchUpdatePhoneNumber": "Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type or the calling name.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the US, you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
", "BatchUpdateUser": " Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.
Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
", "CreateMeetingDialOut": "Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.
To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall action with the corresponding SIP media application ID.
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
", - "CreatePhoneNumberOrder": "Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
", + "CreatePhoneNumberOrder": "Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the US, you must use the Amazon Chime SIP Media Application Dial-In product type.
", "CreateProxySession": "Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
", "CreateRoom": "Creates a chat room for the specified Amazon Chime Enterprise account.
", "CreateRoomMembership": "Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.
", @@ -50,7 +50,7 @@ "DeleteChannelModerator": "Deletes a channel moderator.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Deletes the events configuration that allows a bot to receive outgoing events.
", "DeleteMeeting": "Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
", - "DeletePhoneNumber": "Moves the specified phone number into the Deletionqueue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.
Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
", + "DeletePhoneNumber": "Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.
Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
", "DeleteProxySession": "Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
", "DeleteRoom": "Deletes a chat room in an Amazon Chime Enterprise account.
", "DeleteRoomMembership": "Removes a member from a chat room in an Amazon Chime Enterprise account.
", @@ -119,7 +119,7 @@ "ListChannelBans": "Lists all the users banned from a particular channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Lists all channel memberships in a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order .
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Lists all the moderators for a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Use privacy = PUBLIC to retrieve all public channels in the account.
Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
A list of the channels moderated by an AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.
", "ListSipMediaApplications": "Lists the SIP media applications under the administrator's AWS account.
", "ListSipRules": "Lists the SIP rules under the administrator's AWS account.
", + "ListSupportedPhoneNumberCountries": "Lists supported phone number countries.
", "ListTagsForResource": "Lists the tags applied to an Amazon Chime SDK meeting resource.
", "ListUsers": "Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.
", "ListVoiceConnectorGroups": "Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
", @@ -156,7 +157,7 @@ "RegenerateSecurityToken": "Regenerates the security token for a bot.
", "ResetPersonalPIN": "Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
", "RestorePhoneNumber": "Moves a phone number from the Deletion queue back into the phone number Inventory.
", - "SearchAvailablePhoneNumbers": "Searches phone numbers that can be ordered.
", + "SearchAvailablePhoneNumbers": "Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode, City, State, or TollFreePrefix. If you provide City, you must also provide State. Numbers outside the US only support the PhoneNumberType filter, which you must use.
Sends a message to a particular channel that the member is a part of.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.
Applies the specified tags to the specified Amazon Chime SDK attendee.
", "TagMeeting": "Applies the specified tags to the specified Amazon Chime SDK meeting.
", @@ -173,7 +174,7 @@ "UpdateChannelMessage": "Updates the content of a message.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
The details of the time when a user last read messages in a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
", - "UpdatePhoneNumber": "Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.
For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
", + "UpdatePhoneNumber": "Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.
For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.
Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
", "UpdatePhoneNumberSettings": "Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.
", "UpdateProxySession": "Updates the specified proxy session details, such as voice or SMS capabilities.
", "UpdateRoom": "Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
", @@ -238,7 +239,10 @@ "Alpha2CountryCode": { "base": null, "refs": { - "DNISEmergencyCallingConfiguration$CallingCountry": "The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.
" + "DNISEmergencyCallingConfiguration$CallingCountry": "The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.
", + "PhoneNumber$Country": "The phone number country. Format: ISO 3166-1 alpha-2.
", + "PhoneNumberCountry$CountryCode": "The phone number country code. Format: ISO 3166-1 alpha-2.
", + "SearchAvailablePhoneNumbersRequest$Country": "The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.
" } }, "AppInstance": { @@ -628,7 +632,7 @@ "ChannelBan": { "base": "The details of a channel ban.
", "refs": { - "DescribeChannelBanResponse$ChannelBan": "The the details of the ban.
" + "DescribeChannelBanResponse$ChannelBan": "The details of the ban.
" } }, "ChannelBanSummary": { @@ -2327,6 +2331,16 @@ "refs": { } }, + "ListSupportedPhoneNumberCountriesRequest": { + "base": null, + "refs": { + } + }, + "ListSupportedPhoneNumberCountriesResponse": { + "base": null, + "refs": { + } + }, "ListTagsForResourceRequest": { "base": null, "refs": { @@ -2903,6 +2917,18 @@ "PhoneNumber$Capabilities": "The phone number capabilities.
" } }, + "PhoneNumberCountriesList": { + "base": null, + "refs": { + "ListSupportedPhoneNumberCountriesResponse$PhoneNumberCountries": "The supported phone number countries.
" + } + }, + "PhoneNumberCountry": { + "base": "The phone number country.
", + "refs": { + "PhoneNumberCountriesList$member": null + } + }, "PhoneNumberError": { "base": "If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
", "refs": { @@ -2957,6 +2983,7 @@ "refs": { "CreatePhoneNumberOrderRequest$ProductType": "The phone number product type.
", "ListPhoneNumbersRequest$ProductType": "The phone number product type.
", + "ListSupportedPhoneNumberCountriesRequest$ProductType": "The phone number product type.
", "PhoneNumber$ProductType": "The phone number product type.
", "PhoneNumberOrder$ProductType": "The phone number order product type.
", "UpdatePhoneNumberRequest$ProductType": "The product type.
", @@ -2973,7 +3000,15 @@ "PhoneNumberType": { "base": null, "refs": { - "PhoneNumber$Type": "The phone number type.
" + "PhoneNumber$Type": "The phone number type.
", + "PhoneNumberTypeList$member": null, + "SearchAvailablePhoneNumbersRequest$PhoneNumberType": "The phone number type used to filter results. Required for non-US numbers.
" + } + }, + "PhoneNumberTypeList": { + "base": null, + "refs": { + "PhoneNumberCountry$SupportedPhoneNumberTypes": "The supported phone number types.
" } }, "Port": { @@ -3565,11 +3600,11 @@ "PhoneNumberAssociation$Value": "Contains the ID for the entity specified in Name.
", "PhoneNumberError$ErrorMessage": "The error message.
", "ResourceLimitExceededException$Message": null, - "SearchAvailablePhoneNumbersRequest$AreaCode": "The area code used to filter results.
", - "SearchAvailablePhoneNumbersRequest$City": "The city used to filter results.
", - "SearchAvailablePhoneNumbersRequest$Country": "The country used to filter results.
", - "SearchAvailablePhoneNumbersRequest$State": "The state used to filter results.
", - "SearchAvailablePhoneNumbersRequest$NextToken": "The token to use to retrieve the next page of results.
", + "SearchAvailablePhoneNumbersRequest$AreaCode": "The area code used to filter results. Only applies to the US.
", + "SearchAvailablePhoneNumbersRequest$City": "The city used to filter results. Only applies to the US.
", + "SearchAvailablePhoneNumbersRequest$State": "The state used to filter results. Required only if you provide City. Only applies to the US.
The token used to retrieve the next page of results.
", + "SearchAvailablePhoneNumbersResponse$NextToken": "The token used to retrieve the next page of search results.
", "ServiceFailureException$Message": null, "ServiceUnavailableException$Message": null, "SipMediaApplication$AwsRegion": "The AWS Region in which the SIP media application is created.
", @@ -3716,7 +3751,7 @@ "TollFreePrefix": { "base": null, "refs": { - "SearchAvailablePhoneNumbersRequest$TollFreePrefix": "The toll-free prefix that you use to filter results.
" + "SearchAvailablePhoneNumbersRequest$TollFreePrefix": "The toll-free prefix that you use to filter results. Only applies to the US.
" } }, "UnauthorizedClientException": { diff --git a/models/apis/chime/2018-05-01/paginators-1.json b/models/apis/chime/2018-05-01/paginators-1.json index 83b1912f078..8021a1e8848 100644 --- a/models/apis/chime/2018-05-01/paginators-1.json +++ b/models/apis/chime/2018-05-01/paginators-1.json @@ -119,6 +119,11 @@ "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults" + }, + "SearchAvailablePhoneNumbers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" } } } diff --git a/models/apis/devops-guru/2020-12-01/api-2.json b/models/apis/devops-guru/2020-12-01/api-2.json index f1852cd7de3..855fd121d81 100644 --- a/models/apis/devops-guru/2020-12-01/api-2.json +++ b/models/apis/devops-guru/2020-12-01/api-2.json @@ -146,6 +146,23 @@ {"shape":"ValidationException"} ] }, + "GetCostEstimation":{ + "name":"GetCostEstimation", + "http":{ + "method":"GET", + "requestUri":"/cost-estimation", + "responseCode":200 + }, + "input":{"shape":"GetCostEstimationRequest"}, + "output":{"shape":"GetCostEstimationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ] + }, "GetResourceCollection":{ "name":"GetResourceCollection", "http":{ @@ -298,6 +315,24 @@ {"shape":"ValidationException"} ] }, + "StartCostEstimation":{ + "name":"StartCostEstimation", + "http":{ + "method":"PUT", + "requestUri":"/cost-estimation", + "responseCode":200 + }, + "input":{"shape":"StartCostEstimationRequest"}, + "output":{"shape":"StartCostEstimationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ] + }, "UpdateResourceCollection":{ "name":"UpdateResourceCollection", "http":{ @@ -400,6 +435,12 @@ "type":"list", "member":{"shape":"NotificationChannel"} }, + "ClientToken":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[a-zA-Z0-9]+[a-zA-Z0-9-]*$" + }, "CloudFormationCollection":{ "type":"structure", "members":{ @@ -412,6 +453,12 @@ "StackNames":{"shape":"StackNames"} } }, + "CloudFormationCostEstimationResourceCollectionFilter":{ + "type":"structure", + "members":{ + "StackNames":{"shape":"CostEstimationStackNames"} + } + }, "CloudFormationHealth":{ "type":"structure", "members":{ @@ -483,6 +530,41 @@ "error":{"httpStatusCode":409}, "exception":true }, + "Cost":{"type":"double"}, + "CostEstimationResourceCollectionFilter":{ + "type":"structure", + "members":{ + "CloudFormation":{"shape":"CloudFormationCostEstimationResourceCollectionFilter"} + } + }, + "CostEstimationServiceResourceCount":{"type":"integer"}, + "CostEstimationServiceResourceState":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE" + ] + }, + "CostEstimationStackNames":{ + "type":"list", + "member":{"shape":"StackName"}, + "max":1, + "min":1 + }, + "CostEstimationStatus":{ + "type":"string", + "enum":[ + "ONGOING", + "COMPLETED" + ] + }, + "CostEstimationTimeRange":{ + "type":"structure", + "members":{ + "StartTime":{"shape":"Timestamp"}, + "EndTime":{"shape":"Timestamp"} + } + }, "DescribeAccountHealthRequest":{ "type":"structure", "members":{ @@ -593,6 +675,7 @@ "required":["CloudFormation"], "members":{ "CloudFormation":{"shape":"CloudFormationHealths"}, + "Service":{"shape":"ServiceHealths"}, "NextToken":{"shape":"UuidNextToken"} } }, @@ -705,6 +788,27 @@ "type":"list", "member":{"shape":"Event"} }, + "GetCostEstimationRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"UuidNextToken", + "location":"querystring", + "locationName":"NextToken" + } + } + }, + "GetCostEstimationResponse":{ + "type":"structure", + "members":{ + "ResourceCollection":{"shape":"CostEstimationResourceCollectionFilter"}, + "Status":{"shape":"CostEstimationStatus"}, + "Costs":{"shape":"ServiceResourceCosts"}, + "TimeRange":{"shape":"CostEstimationTimeRange"}, + "TotalCost":{"shape":"Cost"}, + "NextToken":{"shape":"UuidNextToken"} + } + }, "GetResourceCollectionRequest":{ "type":"structure", "required":["ResourceCollectionType"], @@ -959,7 +1063,8 @@ "required":["InsightId"], "members":{ "InsightId":{"shape":"InsightId"}, - "NextToken":{"shape":"UuidNextToken"} + "NextToken":{"shape":"UuidNextToken"}, + "Locale":{"shape":"Locale"} } }, "ListRecommendationsResponse":{ @@ -969,6 +1074,22 @@ "NextToken":{"shape":"UuidNextToken"} } }, + "Locale":{ + "type":"string", + "enum":[ + "DE_DE", + "EN_US", + "EN_GB", + "ES_ES", + "FR_FR", + "IT_IT", + "JA_JP", + "KO_KR", + "PT_BR", + "ZH_CN", + "ZH_TW" + ] + }, "MeanTimeToRecoverInMilliseconds":{"type":"long"}, "NotificationChannel":{ "type":"structure", @@ -1078,7 +1199,8 @@ "Status":{"shape":"InsightStatus"}, "InsightTimeRange":{"shape":"InsightTimeRange"}, "PredictionTimeRange":{"shape":"PredictionTimeRange"}, - "ResourceCollection":{"shape":"ResourceCollection"} + "ResourceCollection":{"shape":"ResourceCollection"}, + "ServiceCollection":{"shape":"ServiceCollection"} } }, "ProactiveInsights":{ @@ -1144,7 +1266,8 @@ "Severity":{"shape":"InsightSeverity"}, "Status":{"shape":"InsightStatus"}, "InsightTimeRange":{"shape":"InsightTimeRange"}, - "ResourceCollection":{"shape":"ResourceCollection"} + "ResourceCollection":{"shape":"ResourceCollection"}, + "ServiceCollection":{"shape":"ServiceCollection"} } }, "ReactiveInsights":{ @@ -1274,7 +1397,10 @@ }, "ResourceCollectionType":{ "type":"string", - "enum":["AWS_CLOUD_FORMATION"] + "enum":[ + "AWS_CLOUD_FORMATION", + "AWS_SERVICE" + ] }, "ResourceHours":{"type":"long"}, "ResourceIdString":{"type":"string"}, @@ -1294,13 +1420,20 @@ "error":{"httpStatusCode":404}, "exception":true }, + "ResourceType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-zA-Z]+[a-zA-Z0-9-_:]*$" + }, "RetryAfterSeconds":{"type":"integer"}, "SearchInsightsFilters":{ "type":"structure", "members":{ "Severities":{"shape":"InsightSeverities"}, "Statuses":{"shape":"InsightStatuses"}, - "ResourceCollection":{"shape":"ResourceCollection"} + "ResourceCollection":{"shape":"ResourceCollection"}, + "ServiceCollection":{"shape":"ServiceCollection"} } }, "SearchInsightsMaxResults":{ @@ -1330,12 +1463,70 @@ "NextToken":{"shape":"UuidNextToken"} } }, + "ServiceCollection":{ + "type":"structure", + "members":{ + "ServiceNames":{"shape":"ServiceNames"} + } + }, + "ServiceHealth":{ + "type":"structure", + "members":{ + "ServiceName":{"shape":"ServiceName"}, + "Insight":{"shape":"ServiceInsightHealth"} + } + }, + "ServiceHealths":{ + "type":"list", + "member":{"shape":"ServiceHealth"} + }, + "ServiceInsightHealth":{ + "type":"structure", + "members":{ + "OpenProactiveInsights":{"shape":"NumOpenProactiveInsights"}, + "OpenReactiveInsights":{"shape":"NumOpenReactiveInsights"} + } + }, "ServiceIntegrationConfig":{ "type":"structure", "members":{ "OpsCenter":{"shape":"OpsCenterIntegration"} } }, + "ServiceName":{ + "type":"string", + "enum":[ + "API_GATEWAY", + "APPLICATION_ELB", + "AUTO_SCALING_GROUP", + "CLOUD_FRONT", + "DYNAMO_DB", + "EC2", + "ECS", + "EKS", + "ELASTIC_BEANSTALK", + "ELASTI_CACHE", + "ELB", + "ES", + "KINESIS", + "LAMBDA", + "NAT_GATEWAY", + "NETWORK_ELB", + "RDS", + "REDSHIFT", + "ROUTE_53", + "S3", + "SAGE_MAKER", + "SNS", + "SQS", + "STEP_FUNCTIONS", + "SWF" + ] + }, + "ServiceNames":{ + "type":"list", + "member":{"shape":"ServiceName"} + }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ @@ -1344,6 +1535,20 @@ "error":{"httpStatusCode":402}, "exception":true }, + "ServiceResourceCost":{ + "type":"structure", + "members":{ + "Type":{"shape":"ResourceType"}, + "State":{"shape":"CostEstimationServiceResourceState"}, + "Count":{"shape":"CostEstimationServiceResourceCount"}, + "UnitCost":{"shape":"Cost"}, + "Cost":{"shape":"Cost"} + } + }, + "ServiceResourceCosts":{ + "type":"list", + "member":{"shape":"ServiceResourceCost"} + }, "SnsChannelConfig":{ "type":"structure", "members":{ @@ -1366,6 +1571,22 @@ "type":"list", "member":{"shape":"StackName"} }, + "StartCostEstimationRequest":{ + "type":"structure", + "required":["ResourceCollection"], + "members":{ + "ResourceCollection":{"shape":"CostEstimationResourceCollectionFilter"}, + "ClientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + } + } + }, + "StartCostEstimationResponse":{ + "type":"structure", + "members":{ + } + }, "StartTimeRange":{ "type":"structure", "members":{ diff --git a/models/apis/devops-guru/2020-12-01/docs-2.json b/models/apis/devops-guru/2020-12-01/docs-2.json index 60e23bf8f5f..553bb706a5f 100644 --- a/models/apis/devops-guru/2020-12-01/docs-2.json +++ b/models/apis/devops-guru/2020-12-01/docs-2.json @@ -8,9 +8,10 @@ "DescribeAnomaly": "Returns details about an anomaly that you specify using its ID.
", "DescribeFeedback": "Returns the most recent feedback submitted in the current AWS account and Region.
", "DescribeInsight": "Returns details about an insight that you specify using its ID.
", - "DescribeResourceCollectionHealth": "Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account. You specify the type of AWS resources collection. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.
", + "DescribeResourceCollectionHealth": "Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account. You specify the type of AWS resources collection. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
", "DescribeServiceIntegration": "Returns the integration status of services that are integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is AWS Systems Manager, which can be used to create an OpsItem for each generated insight.
", - "GetResourceCollection": "Returns lists AWS resources that are of the specified resource collection type. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.
", + "GetCostEstimation": "Returns an estimate of the monthly cost for DevOps Guru to analyze your AWS resources. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.
", + "GetResourceCollection": "Returns lists AWS resources that are of the specified resource collection type. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
", "ListAnomaliesForInsight": "Returns a list of the anomalies that belong to an insight that you specify using its ID.
", "ListEvents": "Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned.
", "ListInsights": " Returns a list of insights in your AWS account. You can specify which insights are returned by their start time and status (ONGOING, CLOSED, or ANY).
Collects customer feedback about the specified insight.
", "RemoveNotificationChannel": "Removes a notification channel from DevOps Guru. A notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations.
", "SearchInsights": " Returns a list of insights in your AWS account. You can specify which insights are returned by their start time, one or more statuses (ONGOING, CLOSED, and CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE).
Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.
Updates the collection of resources that DevOps Guru analyzes. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. This method also creates the IAM role required for you to use DevOps Guru.
", + "StartCostEstimation": "Starts the creation of an estimate of the monthly cost to analyze your AWS resources.
", + "UpdateResourceCollection": "Updates the collection of resources that DevOps Guru analyzes. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks. This method also creates the IAM role required for you to use DevOps Guru.
", "UpdateServiceIntegration": "Enables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is AWS Systems Manager, which can be used to create an OpsItem for each generated insight.
" }, "shapes": { @@ -97,16 +99,28 @@ "ListNotificationChannelsResponse$Channels": "An array that contains the requested notification channels.
" } }, + "ClientToken": { + "base": null, + "refs": { + "StartCostEstimationRequest$ClientToken": "The idempotency token used to identify each cost estimate request.
" + } + }, "CloudFormationCollection": { - "base": "Information about AWS CloudFormation stacks. You can use stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide.
", + "base": "Information about AWS CloudFormation stacks. You can use up to 500 stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide.
", "refs": { - "ResourceCollection$CloudFormation": "An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes.
" + "ResourceCollection$CloudFormation": "An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.
" } }, "CloudFormationCollectionFilter": { - "base": "Information about AWS CloudFormation stacks. You can use stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide.
", + "base": "Information about AWS CloudFormation stacks. You can use up to 500 stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide.
", "refs": { - "ResourceCollectionFilter$CloudFormation": "Information about AWS CloudFormation stacks. You can use stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide.
" + "ResourceCollectionFilter$CloudFormation": "Information about AWS CloudFormation stacks. You can use up to 500 stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide.
" + } + }, + "CloudFormationCostEstimationResourceCollectionFilter": { + "base": "Information about an AWS CloudFormation stack used to create a monthly cost estimate for DevOps Guru to analyze AWS resources. The maximum number of stacks you can specify for a cost estimate is one. The estimate created is for the cost to analyze the AWS resources defined by the stack. For more information, see Stacks in the AWS CloudFormation User Guide.
", + "refs": { + "CostEstimationResourceCollectionFilter$CloudFormation": "An object that specifies the CloudFormation stack that defines the AWS resources used to create a monthly estimate for DevOps Guru.
" } }, "CloudFormationHealth": { @@ -192,6 +206,51 @@ "refs": { } }, + "Cost": { + "base": null, + "refs": { + "GetCostEstimationResponse$TotalCost": "The estimated monthly cost to analyze the AWS resources. This value is the sum of the estimated costs to analyze each resource in the Costs object in this response.
The price per hour to analyze the resources in the service. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.
", + "ServiceResourceCost$Cost": "The total estimated monthly cost to analyze the active resources for this resource.
" + } + }, + "CostEstimationResourceCollectionFilter": { + "base": "Information about a filter used to specify which AWS resources are analyzed to create a monthly DevOps Guru cost estimate. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.
", + "refs": { + "GetCostEstimationResponse$ResourceCollection": "The collection of the AWS resources used to create your monthly DevOps Guru cost estimate.
", + "StartCostEstimationRequest$ResourceCollection": "The collection of AWS resources used to create a monthly DevOps Guru cost estimate.
" + } + }, + "CostEstimationServiceResourceCount": { + "base": null, + "refs": { + "ServiceResourceCost$Count": "The number of active resources analyzed for this service to create a monthly cost estimate.
" + } + }, + "CostEstimationServiceResourceState": { + "base": null, + "refs": { + "ServiceResourceCost$State": "The state of the resource. The resource is ACTIVE if it produces metrics, events, or logs within an hour, otherwise it is INACTIVE. You pay for the number of active AWS resource hours analyzed for each resource. Inactive resources are not charged.
An array of CloudFormation stack names. Its size is fixed at 1 item.
" + } + }, + "CostEstimationStatus": { + "base": null, + "refs": { + "GetCostEstimationResponse$Status": "The status of creating this cost estimate. If it's still in progress, the status ONGOING is returned. If it is finished, the status COMPLETED is returned.
The time range of a cost estimation.
", + "refs": { + "GetCostEstimationResponse$TimeRange": "The start and end time of the cost estimation.
" + } + }, "DescribeAccountHealthRequest": { "base": null, "refs": { @@ -380,6 +439,16 @@ "ListEventsResponse$Events": "A list of the requested events.
" } }, + "GetCostEstimationRequest": { + "base": null, + "refs": { + } + }, + "GetCostEstimationResponse": { + "base": null, + "refs": { + } + }, "GetResourceCollectionRequest": { "base": null, "refs": { @@ -590,6 +659,12 @@ "refs": { } }, + "Locale": { + "base": null, + "refs": { + "ListRecommendationsRequest$Locale": "A locale that specifies the language to use for recommendations.
" + } + }, "MeanTimeToRecoverInMilliseconds": { "base": null, "refs": { @@ -628,14 +703,16 @@ "base": null, "refs": { "DescribeAccountHealthResponse$OpenProactiveInsights": "An integer that specifies the number of open proactive insights in your AWS account.
", - "InsightHealth$OpenProactiveInsights": "The number of open proactive insights.
" + "InsightHealth$OpenProactiveInsights": "The number of open proactive insights.
", + "ServiceInsightHealth$OpenProactiveInsights": "The number of open proactive insights in the AWS service
" } }, "NumOpenReactiveInsights": { "base": null, "refs": { "DescribeAccountHealthResponse$OpenReactiveInsights": "An integer that specifies the number of open reactive insights in your AWS account.
", - "InsightHealth$OpenReactiveInsights": "The number of open reactive insights.
" + "InsightHealth$OpenReactiveInsights": "The number of open reactive insights.
", + "ServiceInsightHealth$OpenReactiveInsights": "The number of open reactive insights in the AWS service
" } }, "NumProactiveInsights": { @@ -687,7 +764,7 @@ "ProactiveAnomaly": { "base": "Information about an anomaly. This object is returned by ListAnomalies.
An ReactiveAnomaly object that represents the requested anomaly.
A ReactiveAnomaly object that represents the requested anomaly.
Details about a proactive insight. This object is returned by ListInsights.
An ProactiveInsight object that represents the requested insight.
A ProactiveInsight object that represents the requested insight.
Details about a reactive anomaly. This object is returned by ListAnomalies.
An ProactiveAnomaly object that represents the requested anomaly.
A ProactiveAnomaly object that represents the requested anomaly.
Information about a reactive insight. This object is returned by ListInsights.
An ReactiveInsight object that represents the requested insight.
A ReactiveInsight object that represents the requested insight.
A ResourceCollection object that contains arrays of the names of AWS CloudFormation stacks.
A ResourceCollection object that contains arrays of the names of AWS CloudFormation stacks. You can specify up to 500 AWS CloudFormation stacks.
A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.
", + "base": "A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
", "refs": { "Event$ResourceCollection": null, "ListEventsFilters$ResourceCollection": null, @@ -941,13 +1018,13 @@ "ResourceCollectionFilter": { "base": "Information about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.
", "refs": { - "GetResourceCollectionResponse$ResourceCollection": "The requested list of AWS resource collections. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.
" + "GetResourceCollectionResponse$ResourceCollection": "The requested list of AWS resource collections. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
" } }, "ResourceCollectionType": { "base": null, "refs": { - "DescribeResourceCollectionHealthRequest$ResourceCollectionType": "An AWS resource collection type. This type specifies how analyzed AWS resources are defined. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks.
", + "DescribeResourceCollectionHealthRequest$ResourceCollectionType": "An AWS resource collection type. This type specifies how analyzed AWS resources are defined. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.
", "GetResourceCollectionRequest$ResourceCollectionType": " The type of AWS resource collections to return. The one valid value is CLOUD_FORMATION for AWS CloudFormation stacks.
The type of the AWS resource.
" + } + }, "RetryAfterSeconds": { "base": null, "refs": { @@ -1005,17 +1088,68 @@ "refs": { } }, + "ServiceCollection": { + "base": "A collection of the names of AWS services.
", + "refs": { + "ProactiveInsightSummary$ServiceCollection": "A collection of the names of AWS services.
", + "ReactiveInsightSummary$ServiceCollection": "A collection of the names of AWS services.
", + "SearchInsightsFilters$ServiceCollection": "A collection of the names of AWS services.
" + } + }, + "ServiceHealth": { + "base": "Represents the health of an AWS service.
", + "refs": { + "ServiceHealths$member": null + } + }, + "ServiceHealths": { + "base": null, + "refs": { + "DescribeResourceCollectionHealthResponse$Service": "An array of ServiceHealth objects that describes the health of the AWS services associated with the resources in the collection.
Contains the number of open proactive and reactive insights in an analyzed AWS service.
", + "refs": { + "ServiceHealth$Insight": "Represents the health of an AWS service. This is a ServiceInsightHealth that contains the number of open proactive and reactive insights for this service.
Information about the integration of DevOps Guru with another AWS service, such as AWS Systems Manager.
", "refs": { "DescribeServiceIntegrationResponse$ServiceIntegration": null } }, + "ServiceName": { + "base": null, + "refs": { + "ServiceHealth$ServiceName": "The name of the AWS service.
", + "ServiceNames$member": null + } + }, + "ServiceNames": { + "base": null, + "refs": { + "ServiceCollection$ServiceNames": "An array of strings that each specifies the name of an AWS service.
" + } + }, "ServiceQuotaExceededException": { "base": "The request contains a value that exceeds a maximum quota.
", "refs": { } }, + "ServiceResourceCost": { + "base": "An object that contains information about the estimated monthly cost to analyze an AWS resource. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.
", + "refs": { + "ServiceResourceCosts$member": null + } + }, + "ServiceResourceCosts": { + "base": null, + "refs": { + "GetCostEstimationResponse$Costs": "An array of ResourceCost objects that each contains details about the monthly cost estimate to analyze one of your AWS resources.
Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.
If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics.
", "refs": { @@ -1033,6 +1167,7 @@ "base": null, "refs": { "CloudFormationHealth$StackName": "The name of the CloudFormation stack.
", + "CostEstimationStackNames$member": null, "StackNames$member": null, "UpdateStackNames$member": null } @@ -1044,6 +1179,16 @@ "CloudFormationCollectionFilter$StackNames": "An array of CloudFormation stack names.
" } }, + "StartCostEstimationRequest": { + "base": null, + "refs": { + } + }, + "StartCostEstimationResponse": { + "base": null, + "refs": { + } + }, "StartTimeRange": { "base": "A time range used to specify when the behavior of an insight or anomaly started.
", "refs": { @@ -1062,6 +1207,8 @@ "refs": { "AnomalyTimeRange$StartTime": "The time when the anomalous behavior started.
", "AnomalyTimeRange$EndTime": "The time when the anomalous behavior ended.
", + "CostEstimationTimeRange$StartTime": "The start time of the cost estimation.
", + "CostEstimationTimeRange$EndTime": "The end time of the cost estimation.
", "DescribeAccountOverviewRequest$FromTime": "The start of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred after this day.
", "DescribeAccountOverviewRequest$ToTime": "The end of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred before this day. If this is not specified, then the current day is used.
", "EndTimeRange$FromTime": "The earliest end time in the time range.
", @@ -1086,9 +1233,9 @@ } }, "UpdateCloudFormationCollectionFilter": { - "base": "Contains the names of AWS CloudFormation stacks used to update a collection of stacks.
", + "base": "Contains the names of AWS CloudFormation stacks used to update a collection of stacks. You can specify up to 500 AWS CloudFormation stacks.
", "refs": { - "UpdateResourceCollectionFilter$CloudFormation": "An collection of AWS CloudFormation stacks.
" + "UpdateResourceCollectionFilter$CloudFormation": "An collection of AWS CloudFormation stacks. You can specify up to 500 AWS CloudFormation stacks.
" } }, "UpdateResourceCollectionAction": { @@ -1132,7 +1279,7 @@ "UpdateStackNames": { "base": null, "refs": { - "UpdateCloudFormationCollectionFilter$StackNames": "An array of the name of stacks to update.
" + "UpdateCloudFormationCollectionFilter$StackNames": "An array of the names of the AWS CloudFormation stacks to update. You can specify up to 500 AWS CloudFormation stacks.
" } }, "UuidNextToken": { @@ -1140,6 +1287,8 @@ "refs": { "DescribeResourceCollectionHealthRequest$NextToken": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
", "DescribeResourceCollectionHealthResponse$NextToken": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", + "GetCostEstimationRequest$NextToken": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
", + "GetCostEstimationResponse$NextToken": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", "GetResourceCollectionRequest$NextToken": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
", "GetResourceCollectionResponse$NextToken": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
", "ListAnomaliesForInsightRequest$NextToken": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
", diff --git a/models/apis/devops-guru/2020-12-01/paginators-1.json b/models/apis/devops-guru/2020-12-01/paginators-1.json index 6e9b69977be..67745d4d9f3 100644 --- a/models/apis/devops-guru/2020-12-01/paginators-1.json +++ b/models/apis/devops-guru/2020-12-01/paginators-1.json @@ -4,7 +4,21 @@ "input_token": "NextToken", "output_token": "NextToken", "result_key": [ - "CloudFormation" + "CloudFormation", + "Service" + ] + }, + "GetCostEstimation": { + "input_token": "NextToken", + "non_aggregate_keys": [ + "Status", + "TotalCost", + "TimeRange", + "ResourceCollection" + ], + "output_token": "NextToken", + "result_key": [ + "Costs" ] }, "GetResourceCollection": { diff --git a/models/apis/health/2016-08-04/docs-2.json b/models/apis/health/2016-08-04/docs-2.json index 1dd868fba87..00a6b1f5865 100644 --- a/models/apis/health/2016-08-04/docs-2.json +++ b/models/apis/health/2016-08-04/docs-2.json @@ -1,20 +1,20 @@ { "version": "2.0", - "service": "The AWS Health API provides programmatic access to the AWS Health information that appears in the AWS Personal Health Dashboard. You can use the API operations to get information about AWS Health events that affect your AWS services and resources.
You must have a Business or Enterprise support plan from AWS Support to use the AWS Health API. If you call the AWS Health API from an AWS account that doesn't have a Business or Enterprise support plan, you receive a SubscriptionRequiredException error.
AWS Health has a single endpoint: health.us-east-1.amazonaws.com (HTTPS). Use this endpoint to call the AWS Health API operations.
For authentication of requests, AWS Health uses the Signature Version 4 Signing Process.
If your AWS account is part of AWS Organizations, you can use the AWS Health organizational view feature. This feature provides a centralized view of AWS Health events across all accounts in your organization. You can aggregate AWS Health events in real time to identify accounts in your organization that are affected by an operational event or get notified of security vulnerabilities. Use the organizational view API operations to enable this feature and return event information. For more information, see Aggregating AWS Health events in the AWS Health User Guide.
When you use the AWS Health API operations to return AWS Health events, see the following recommendations:
Use the eventScopeCode parameter to specify whether to return AWS Health events that are public or account-specific.
Use pagination to view all events from the response. For example, if you call the DescribeEventsForOrganization operation to get all events in your organization, you might receive several page results. Specify the nextToken in the next request to return more results.
The AWS Health API provides programmatic access to the AWS Health information that appears in the AWS Personal Health Dashboard. You can use the API operations to get information about AWS Health events that affect your AWS services and resources.
You must have a Business or Enterprise Support plan from AWS Support to use the AWS Health API. If you call the AWS Health API from an AWS account that doesn't have a Business or Enterprise Support plan, you receive a SubscriptionRequiredException error.
You can use the AWS Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the AWS Health API operations. AWS Health supports a multi-Region application architecture and has two regional endpoints in an active-passive configuration. You can use the high availability endpoint example to determine which AWS Region is active, so that you can get the latest information from the API. For more information, see Accessing the AWS Health API in the AWS Health User Guide.
For authentication of requests, AWS Health uses the Signature Version 4 Signing Process.
If your AWS account is part of AWS Organizations, you can use the AWS Health organizational view feature. This feature provides a centralized view of AWS Health events across all accounts in your organization. You can aggregate AWS Health events in real time to identify accounts in your organization that are affected by an operational event or get notified of security vulnerabilities. Use the organizational view API operations to enable this feature and return event information. For more information, see Aggregating AWS Health events in the AWS Health User Guide.
When you use the AWS Health API operations to return AWS Health events, see the following recommendations:
Use the eventScopeCode parameter to specify whether to return AWS Health events that are public or account-specific.
Use pagination to view all events from the response. For example, if you call the DescribeEventsForOrganization operation to get all events in your organization, you might receive several page results. Specify the nextToken in the next request to return more results.
Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event. For more information about the different types of AWS Health events, see Event.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.
At least one event ARN is required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
This operation supports resource-level permissions. You can use this operation to allow or deny access to specific AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide.
Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service.
At least one event Amazon Resource Name (ARN) and account ID are required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide.
Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned.
", "DescribeEventAggregates": "Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
Returns detailed information about one or more specified events. Information includes standard event data (AWS Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve those, use the DescribeAffectedEntities operation.
If a specified event cannot be retrieved, an error message is returned for that event.
This operation supports resource-level permissions. You can use this operation to allow or deny access to specific AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide.
Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (AWS Region, service, and so on, as returned by DescribeEventsForOrganization), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntitiesForOrganization operation.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
When you call the DescribeEventDetailsForOrganization operation, you specify the organizationEventDetailFilters object in the request. Depending on the AWS Health event type, note the following differences:
If the event is public, the awsAccountId parameter must be empty. If you specify an account ID for a public event, then an error message is returned. That's because the event might apply to all AWS accounts and isn't specific to an account in your organization.
If the event is specific to an account, then you must specify the awsAccountId parameter in the request. If you don't specify an account ID, an error message returns because the event is specific to an AWS account in your organization.
For more information, see Event.
This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide.
Returns detailed information about one or more specified events. Information includes standard event data (AWS Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve the entities, use the DescribeAffectedEntities operation.
If a specified event can't be retrieved, an error message is returned for that event.
This operation supports resource-level permissions. You can use this operation to allow or deny access to specific AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide.
Returns detailed information about one or more specified events for one or more AWS accounts in your organization. This information includes standard event data (such as the AWS Region and service), an event description, and (depending on the event) possible metadata. This operation doesn't return affected entities, such as the resources related to the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization operation.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
When you call the DescribeEventDetailsForOrganization operation, specify the organizationEventDetailFilters object in the request. Depending on the AWS Health event type, note the following differences:
To return event details for a public event, you must specify a null value for the awsAccountId parameter. If you specify an account ID for a public event, AWS Health returns an error message because public events aren't specific to an account.
To return event details for an event that is specific to an account in your organization, you must specify the awsAccountId parameter in the request. If you don't specify an account ID, AWS Health returns an error message because the event is specific to an account in your organization.
For more information, see Event.
This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide.
Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the AWS Health event, such as the category, AWS service, and event code. The metadata for each event appears in the EventType object.
If you don't specify a filter criteria, the API operation returns all event types, in no particular order.
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.
If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent event.
When you call the DescribeEvents operation and specify an entity for the entityValues parameter, AWS Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, AWS Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event.
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
Returns information about events across your organization in AWS Organizations. You can use thefilters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations:
If you don't specify a filter, the DescribeEventsForOrganizations returns all events across your organization. Results are sorted by lastModifiedTime, starting with the most recent event.
For more information about the different types of AWS Health events, see Event.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
This operation provides status information on enabling or disabling AWS Health to work with your organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's management account.
", "DisableHealthServiceAccessForOrganization": "Disables AWS Health from working with AWS Organizations. To call this operation, you must sign in as an AWS Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not recommended) in the organization's management account. For more information, see Aggregating AWS Health events in the AWS Health User Guide.
This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or AWS Command Line Interface (AWS CLI) to remove the service-linked role. For more information, see Deleting a Service-Linked Role in the IAM User Guide.
You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess API operation. After you call this operation, AWS Health stops aggregating events for all other AWS accounts in your organization. If you call the AWS Health API operations for organizational view, AWS Health returns an error. AWS Health continues to aggregate health events for your AWS account.
Enables AWS Health to work with AWS Organizations. You can use the organizational view feature to aggregate events from all AWS accounts in your organization in a centralized location.
This operation also creates a service-linked role for the management account in the organization.
To call this operation, you must meet the following requirements:
You must have a Business or Enterprise support plan from AWS Support to use the AWS Health API. If you call the AWS Health API from an AWS account that doesn't have a Business or Enterprise support plan, you receive a SubscriptionRequiredException error.
You must have permission to call this operation from the organization's management account. For example IAM policies, see AWS Health identity-based policy examples.
If you don't have the required support plan, you can instead use the AWS Health console to enable the organizational view feature. For more information, see Aggregating AWS Health events in the AWS Health User Guide.
" + "EnableHealthServiceAccessForOrganization": "Enables AWS Health to work with AWS Organizations. You can use the organizational view feature to aggregate events from all AWS accounts in your organization in a centralized location.
This operation also creates a service-linked role for the management account in the organization.
To call this operation, you must meet the following requirements:
You must have a Business or Enterprise Support plan from AWS Support to use the AWS Health API. If you call the AWS Health API from an AWS account that doesn't have a Business or Enterprise Support plan, you receive a SubscriptionRequiredException error.
You must have permission to call this operation from the organization's management account. For example IAM policies, see AWS Health identity-based policy examples.
If you don't have the required support plan, you can instead use the AWS Health console to enable the organizational view feature. For more information, see Aggregating AWS Health events in the AWS Health User Guide.
" }, "shapes": { "AffectedEntity": { @@ -244,7 +244,7 @@ } }, "EventDetailsErrorItem": { - "base": "Error information returned when a DescribeEventDetails operation cannot find a specified event.
", + "base": "Error information returned when a DescribeEventDetails operation can't find a specified event.
", "refs": { "DescribeEventDetailsFailedSet$member": null } @@ -298,7 +298,7 @@ } }, "OrganizationAffectedEntitiesErrorItem": { - "base": "Error information returned when a DescribeAffectedEntitiesForOrganization operation cannot find or process a specific entity.
", + "base": "Error information returned when a DescribeAffectedEntitiesForOrganization operation can't find or process a specific entity.
", "refs": { "DescribeAffectedEntitiesForOrganizationFailedSet$member": null } @@ -328,7 +328,7 @@ } }, "OrganizationEventDetailsErrorItem": { - "base": "Error information returned when a DescribeEventDetailsForOrganization operation cannot find a specified event.
", + "base": "Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.
", "refs": { "DescribeEventDetailsForOrganizationFailedSet$member": null } @@ -357,7 +357,7 @@ "EventAccountFilter$awsAccountId": "The 12-digit AWS account numbers that contains the affected entities.
", "OrganizationAffectedEntitiesErrorItem$awsAccountId": "The 12-digit AWS account numbers that contains the affected entities.
", "OrganizationEventDetails$awsAccountId": "The 12-digit AWS account numbers that contains the affected entities.
", - "OrganizationEventDetailsErrorItem$awsAccountId": "Error information returned when a DescribeEventDetailsForOrganization operation cannot find a specified event.
", + "OrganizationEventDetailsErrorItem$awsAccountId": "Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event.
", "affectedAccountsList$member": null, "awsAccountIdsList$member": null } @@ -384,7 +384,7 @@ "availabilityZones": { "base": null, "refs": { - "EventFilter$availabilityZones": "A list of AWS availability zones.
" + "EventFilter$availabilityZones": "A list of AWS Availability Zones.
" } }, "awsAccountIdsList": { @@ -467,16 +467,16 @@ "eventArn": { "base": null, "refs": { - "AffectedEntity$eventArn": "The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.
For example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.
For example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.
For example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.
For example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.
For example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.
For example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.
For example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.
For example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.
For example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
The AWS region name of the event.
", + "Event$region": "The AWS Region name of the event.
", "OrganizationEvent$region": "The AWS Region name of the event.
", "regionList$member": null } @@ -635,7 +635,7 @@ "regionList": { "base": null, "refs": { - "EventFilter$regions": "A list of AWS regions.
", + "EventFilter$regions": "A list of AWS Regions.
", "OrganizationEventFilter$regions": "A list of AWS Regions.
" } }, @@ -644,7 +644,7 @@ "refs": { "Event$service": "The AWS service that is affected by the event. For example, EC2, RDS.
The AWS service that is affected by the event. For example, EC2, RDS.
The AWS service that is affected by the event. For example, EC2, RDS.
", + "OrganizationEvent$service": "The AWS service that is affected by the event, such as EC2 and RDS.
", "serviceList$member": null } }, @@ -666,7 +666,7 @@ "OrganizationAffectedEntitiesErrorItem$errorName": "The name of the error.
", "OrganizationAffectedEntitiesErrorItem$errorMessage": "The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
The name of the error.
", - "OrganizationEventDetailsErrorItem$errorMessage": "A message that describes the error.
", + "OrganizationEventDetailsErrorItem$errorMessage": "A message that describes the error.
If you call the DescribeEventDetailsForOrganization operation and receive one of the following errors, follow the recommendations in the message:
We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an AWS account ID in the request.
We couldn't find an account specific event for the specified AWS account. To find an event that is public, you must enter a null value for the AWS account ID in the request.
Your AWS account doesn't include the AWS Support plan required to use the AWS Health API. You must have either a Business or Enterprise Support plan.
Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking.
", "AddTags": "Adds or overwrites one or more tags for the specified Amazon SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.
Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see AWS Tagging Strategies.
Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob
Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.
", - "CreateAction": "Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.
", + "CreateAction": "Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking.
CreateAction can only be invoked from within an SageMaker managed environment. This includes SageMaker training jobs, processing jobs, transform jobs, and SageMaker notebooks. A call to CreateAction from outside one of these environments results in an error.
Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.
", "CreateApp": "Creates a running app for the specified UserProfile. Supported apps are JupyterServer and KernelGateway. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.
Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System (EFS) storage volume on the image, and a list of the kernels in the image.
", - "CreateArtifact": "Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.
", + "CreateArtifact": "Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking.
CreateArtifact can only be invoked from within an SageMaker managed environment. This includes SageMaker training jobs, processing jobs, transform jobs, and SageMaker notebooks. A call to CreateArtifact from outside one of these environments results in an error.
Creates an Autopilot job.
Find the best performing model after you run an Autopilot job by calling .
For information about how to use Autopilot, see Automate Model Development with Amazon SageMaker Autopilot.
", "CreateCodeRepository": "Creates a Git repository as a resource in your Amazon SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your Amazon SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.
The repository can be hosted either in AWS CodeCommit or in any other Git repository.
", "CreateCompilationJob": "Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.
If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with AWS IoT Greengrass. In that case, deploy them as an ML resource.
In the request body, you provide the following:
A name for the compilation job
Information about the input model artifacts
The output location for the compiled model and the device (target) that the model runs on
The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job.
You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.
To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.
", - "CreateContext": "Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.
", + "CreateContext": "Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.
CreateContext can only be invoked from within an SageMaker managed environment. This includes SageMaker training jobs, processing jobs, transform jobs, and SageMaker notebooks. A call to CreateContext from outside one of these environments results in an error.
Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.
", "CreateDeviceFleet": "Creates a device fleet.
", "CreateDomain": "Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. An AWS account is limited to one domain per region. Users within a domain can share notebook files and other artifacts with each other.
EFS storage
When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.
SageMaker uses the AWS Key Management Service (AWS KMS) to encrypt the EFS volume attached to the domain with an AWS managed customer master key (CMK) by default. For more control, you can specify a customer managed CMK. For more information, see Protect Data at Rest Using Encryption.
VPC configuration
All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. The following options are available:
PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.
VpcOnly - All Studio traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.
When internet access is disabled, you won't be able to run a Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.
For more information, see Connect SageMaker Studio Notebooks to Resources in a VPC.
", "CreateEdgePackagingJob": "Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.
", "CreateEndpoint": "Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.
Use this API to deploy models using Amazon SageMaker hosting services.
For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).
You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
The endpoint name must be unique within an AWS Region in your AWS account.
When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
When Amazon SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. Amazon SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provided. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.
Option 1: For a full Amazon SageMaker access, search and attach the AmazonSageMakerFullAccess policy.
Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:
\"Action\": [\"sagemaker:CreateEndpoint\", \"sagemaker:CreateEndpointConfig\"]
\"Resource\": [
\"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"
\"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"
]
For more information, see Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference.
Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want Amazon SageMaker to provision. Then you call the CreateEndpoint API.
Use this API if you want to use Amazon SageMaker hosting services to deploy models into production.
In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want Amazon SageMaker to provision. This includes the number and type of ML compute instances to deploy.
If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. Amazon SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.
For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
Creates an SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.
The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.
When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.
To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.
To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
", + "CreateExperiment": "Creates an SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.
The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.
To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.
To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
", "CreateFeatureGroup": "Create a new FeatureGroup. A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record.
The FeatureGroup defines the schema and features contained in the FeatureGroup. A FeatureGroup definition is composed of a list of Features, a RecordIdentifierFeatureName, an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore. Check AWS service quotas to see the FeatureGroups quota for your AWS account.
You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup.
Creates a flow definition.
", "CreateHumanTaskUi": "Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.
", @@ -42,10 +42,10 @@ "CreatePresignedNotebookInstanceUrl": "Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the Amazon SageMaker console, when you choose Open next to a notebook instance, Amazon SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.
The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.
You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.
The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the AWS console sign-in page.
Creates a processing job.
", "CreateProject": "Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.
", - "CreateTrainingJob": "Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.
If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than Amazon SageMaker, provided that you know how to use them for inference.
In the request body, you provide the following:
AlgorithmSpecification - Identifies the training algorithm to use.
HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms.
InputDataConfig - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored.
OutputDataConfig - Identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of model training.
ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.
EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.
RoleArn - The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete model training.
StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long you are willing to wait for a managed spot training job to complete.
Environment - The environment variables to set in the Docker container.
For more information about Amazon SageMaker, see How It Works.
", + "CreateTrainingJob": "Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.
If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than Amazon SageMaker, provided that you know how to use them for inference.
In the request body, you provide the following:
AlgorithmSpecification - Identifies the training algorithm to use.
HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms.
InputDataConfig - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored.
OutputDataConfig - Identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of model training.
ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.
EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.
RoleArn - The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete model training.
StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete.
Environment - The environment variables to set in the Docker container.
RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError.
For more information about Amazon SageMaker, see How It Works.
", "CreateTransformJob": "Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.
To perform batch transformations, you create a transform job and use the data that you have readily available.
In the request body, you provide the following:
TransformJobName - Identifies the transform job. The name must be unique within an AWS Region in an AWS account.
ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same AWS Region and AWS account. For information on creating a model, see CreateModel.
TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.
TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
TransformResources - Identifies the ML compute instances for the transform job.
For more information about how batch transformation works, see Batch Transform.
", - "CreateTrial": "Creates an Amazon SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single Amazon SageMaker experiment.
When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to a trial and then use the Search API to search for the tags.
To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.
", - "CreateTrialComponent": "Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.
Trial components include pre-processing jobs, training jobs, and batch transform jobs.
When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to a trial component and then use the Search API to search for the tags.
CreateTrialComponent can only be invoked from within an Amazon SageMaker managed environment. This includes Amazon SageMaker training jobs, processing jobs, transform jobs, and Amazon SageMaker notebooks. A call to CreateTrialComponent from outside one of these environments results in an error.
Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to a trial and then use the Search API to search for the tags.
To get a list of all your trials, call the ListTrials API. To view a trial's properties, call the DescribeTrial API. To create a trial component, call the CreateTrialComponent API.
", + "CreateTrialComponent": "Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.
Trial components include pre-processing jobs, training jobs, and batch transform jobs.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to a trial component and then use the Search API to search for the tags.
CreateTrialComponent can only be invoked from within an SageMaker managed environment. This includes SageMaker training jobs, processing jobs, transform jobs, and SageMaker notebooks. A call to CreateTrialComponent from outside one of these environments results in an error.
Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a \"person\" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from SSO, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.
", "CreateWorkforce": "Use this operation to create a workforce. This operation will return an error if a workforce already exists in the AWS Region that you specify. You can only create one workforce in each AWS Region per AWS account.
If you want to create a new workforce in an AWS Region where a workforce already exists, use the API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.
To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).
To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).
Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.
You cannot create more than 25 work teams in an account and region.
", @@ -62,7 +62,7 @@ "DeleteDomain": "Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using SSO. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.
", "DeleteEndpoint": "Deletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the endpoint was created.
Amazon SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.
", "DeleteEndpointConfig": "Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.
You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.
Deletes an Amazon SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.
", + "DeleteExperiment": "Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.
", "DeleteFeatureGroup": "Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup. Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called.
Data written into the OfflineStore will not be deleted. The AWS Glue database and tables that are automatically created for your OfflineStore are not deleted.
Deletes the specified flow definition.
", "DeleteHumanTaskUi": "Use this operation to delete a human task user interface (worker task template).
To see a list of human task user interfaces (work task templates) in your account, use . When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.
Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.
", "DeleteNotebookInstance": " Deletes an Amazon SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.
When you delete a notebook instance, you lose all of your data. Amazon SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.
Deletes a notebook instance lifecycle configuration.
", - "DeletePipeline": "Deletes a pipeline if there are no in-progress executions.
", + "DeletePipeline": "Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances of the pipeline are deleted.
Delete the specified project.
", "DeleteTags": "Deletes the specified tags from an Amazon SageMaker resource.
To list a resource's tags, use the ListTags API.
When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.
Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.
", @@ -185,7 +185,7 @@ "ListProjects": "Gets a list of the projects in an AWS account.
", "ListSubscribedWorkteams": "Gets a list of the work teams that you are subscribed to in the AWS Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.
Returns the tags for the specified Amazon SageMaker resource.
", - "ListTrainingJobs": "Lists training jobs.
When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response. For example, if ListTrainingJobs is invoked with the following parameters:
{ ... MaxResults: 100, StatusEquals: InProgress ... }
Then, 100 trainings jobs with any status including those other than InProgress are selected first (sorted according the creation time, from the latest to the oldest) and those with status InProgress are returned.
You can quickly test the API using the following AWS CLI code.
aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress
Lists training jobs.
When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response.
For example, if ListTrainingJobs is invoked with the following parameters:
{ ... MaxResults: 100, StatusEquals: InProgress ... }
First, 100 trainings jobs with any status, including those other than InProgress, are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned.
You can quickly test the API using the following AWS CLI code.
aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress
Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.
", "ListTransformJobs": "Lists transform jobs.
", "ListTrialComponents": "Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:
ExperimentName
SourceArn
TrialName
There was a conflict when you attempted to modify an experiment, trial, or trial component.
", + "base": "There was a conflict when you attempted to modify a SageMaker entity such as an Experiment or Artifact.
The maximum number of data quality monitoring job definitions to return in the response.
", "ListDomainsRequest$MaxResults": "Returns a list up to a specified limit.
", "ListEndpointConfigsInput$MaxResults": "The maximum number of training jobs to return in the response.
", - "ListEndpointsInput$MaxResults": "The maximum number of endpoints to return in the response.
", + "ListEndpointsInput$MaxResults": "The maximum number of endpoints to return in the response. This value defaults to 10.
", "ListExperimentsRequest$MaxResults": "The maximum number of experiments to return in the response. The default value is 10.
", "ListFlowDefinitionsRequest$MaxResults": "The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.
" + "StoppingCondition$MaxRuntimeInSeconds": "The maximum length of time, in seconds, that a training or compilation job can run. If the job does not complete during this time, Amazon SageMaker ends the job.
When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.
The default value is 1 day. The maximum value is 28 days.
" } }, "MaxRuntimePerTrainingJobInSeconds": { @@ -5816,7 +5816,7 @@ "MaxWaitTimeInSeconds": { "base": null, "refs": { - "StoppingCondition$MaxWaitTimeInSeconds": "The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds.
The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, Amazon SageMaker ends the job.
When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.
The number of times to retry the job. When the job is retried, it's SecondaryStatus is changed to STARTING.
The maximum runtime allowed in seconds.
" + "MonitoringStoppingCondition$MaxRuntimeInSeconds": "The maximum runtime allowed in seconds.
The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.
Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defauts to FullyReplicated
Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated
Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.
Resource being accessed is in use.
", + "base": "The resource being accessed is in use.
", "refs": { } }, "ResourceLimitExceeded": { - "base": "You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
", + "base": "You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
", "refs": { } }, @@ -8038,7 +8044,7 @@ } }, "ResourceNotFound": { - "base": "Resource being access is not found.
", + "base": "The resource being accessed was not found.
", "refs": { } }, @@ -8092,6 +8098,15 @@ "RetentionPolicy$HomeEfsFileSystem": "The default is Retain, which specifies to keep the data stored on the EFS volume.
Specify Delete to delete the data stored on the EFS volume.
The retry strategy to use when a training job fails due to an InternalServerError. RetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob requests. You can add the StoppingCondition parameter to the request to limit the training time for the complete job.
The number of times to retry the job when the job fails due to an InternalServerError.
The number of times to retry the job when the job fails due to an InternalServerError.
The number of times to retry the job when the job fails due to an InternalServerError.
The number of times to retry the job when the job fails due to an InternalServerError.
An Amazon Simple Notification Service (Amazon SNS) output topic ARN.
If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.
To learn more, see Receive Output Data from a Streaming Labeling Job.
", + "LabelingJobOutputConfig$SnsTopicArn": "An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.
If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.
To learn more, see Receive Output Data from a Streaming Labeling Job.
", "LabelingJobSnsDataSource$SnsTopicArn": "The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic you will use to send new data objects to a streaming labeling job.
" } }, @@ -8581,7 +8596,7 @@ "SplitType": { "base": null, "refs": { - "TransformInput$SplitType": "The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats. Currently, the supported record formats are:
RecordIO
TFRecord
When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.
Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord.
For more information about RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information about TFRecord, see Consuming TFRecord data in the TensorFlow documentation.
The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats. Currently, the supported record formats are:
RecordIO
TFRecord
When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.
Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord.
For more information about RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information about TFRecord, see Consuming TFRecord data in the TensorFlow documentation.
Specifies a limit to how long a model training or compilation job can run. It also specifies how long you are willing to wait for a managed spot training job to complete. When the job reaches the time limit, Amazon SageMaker ends the training or compilation job. Use this API to cap model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
The training algorithms provided by Amazon SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.
The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.
Specifies a limit to how long a model training job, model compilation job, or hyperparameter tuning job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training or compilation job. Use this API to cap model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
The training algorithms provided by Amazon SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.
The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.
Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
", - "CreateTrainingJobRequest$StoppingCondition": "Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
", - "DescribeTrainingJobResponse$StoppingCondition": "Specifies a limit to how long a model training job can run. It also specifies the maximum time to wait for a spot instance. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long you are willing to wait for a managed spot training job to complete. When the job reaches the a limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
", - "TrainingJob$StoppingCondition": "Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.
" + "DescribeTrainingJobResponse$StoppingCondition": "Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
", + "TrainingJob$StoppingCondition": "Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.
" } }, "String": { @@ -8882,7 +8897,7 @@ "CreateContextRequest$Tags": "A list of tags to apply to the context.
", "CreateDataQualityJobDefinitionRequest$Tags": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
", "CreateDeviceFleetRequest$Tags": "Creates tags for the specified fleet.
", - "CreateDomainRequest$Tags": "Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
Tags that you specify for the Domain are also added to all Apps that the Domain launches.
", "CreateEdgePackagingJobRequest$Tags": "Creates tags for the packaging job.
", "CreateEndpointConfigInput$Tags": "An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.
", "CreateEndpointInput$Tags": "An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.
", @@ -8908,7 +8923,7 @@ "CreateTransformJobRequest$Tags": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
", "CreateTrialComponentRequest$Tags": "A list of tags to associate with the component. You can use Search API to search on the tags.
", "CreateTrialRequest$Tags": "A list of tags to associate with the trial. You can use Search API to search on the tags.
", - "CreateUserProfileRequest$Tags": "Each tag consists of a key and an optional value. Tag keys must be unique per resource.
", + "CreateUserProfileRequest$Tags": "Each tag consists of a key and an optional value. Tag keys must be unique per resource.
Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.
", "CreateWorkforceRequest$Tags": "An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.
", "CreateWorkteamRequest$Tags": "An array of key-value pairs.
For more information, see Resource Tag and Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
", "DescribeLabelingJobResponse$Tags": "An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.
", @@ -10228,12 +10243,12 @@ "AppDetails$UserProfileName": "The user profile name.
", "CreateAppRequest$UserProfileName": "The user profile name.
", "CreatePresignedDomainUrlRequest$UserProfileName": "The name of the UserProfile to sign-in as.
", - "CreateUserProfileRequest$UserProfileName": "A name for the UserProfile.
", + "CreateUserProfileRequest$UserProfileName": "A name for the UserProfile. This value is not case sensitive.
", "DeleteAppRequest$UserProfileName": "The user profile name.
", "DeleteUserProfileRequest$UserProfileName": "The user profile name.
", "DescribeAppRequest$UserProfileName": "The user profile name.
", "DescribeAppResponse$UserProfileName": "The user profile name.
", - "DescribeUserProfileRequest$UserProfileName": "The user profile name.
", + "DescribeUserProfileRequest$UserProfileName": "The user profile name. This value is not case sensitive.
", "DescribeUserProfileResponse$UserProfileName": "The user profile name.
", "ListAppsRequest$UserProfileNameEquals": "A parameter to search by user profile name.
", "ListUserProfilesRequest$UserProfileNameContains": "A parameter by which to filter the results.
", diff --git a/service/acmpca/api.go b/service/acmpca/api.go index f874f85bd06..587bae29458 100644 --- a/service/acmpca/api.go +++ b/service/acmpca/api.go @@ -68,7 +68,7 @@ func (c *ACMPCA) CreateCertificateAuthorityRequest(input *CreateCertificateAutho // S3 bucket that is included in certificates issued by the CA. If successful, // this action returns the Amazon Resource Name (ARN) of the CA. // -// ACM Private CAA assets that are stored in Amazon S3 can be protected with +// ACM Private CA assets that are stored in Amazon S3 can be protected with // encryption. For more information, see Encrypting Your CRLs (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption). // // Both PCA and the IAM principal must have permission to write to the S3 bucket @@ -177,7 +177,7 @@ func (c *ACMPCA) CreateCertificateAuthorityAuditReportRequest(input *CreateCerti // to write to the bucket, then an exception is thrown. For more information, // see Configure Access to ACM Private CA (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html). // -// ACM Private CAA assets that are stored in Amazon S3 can be protected with +// ACM Private CA assets that are stored in Amazon S3 can be protected with // encryption. For more information, see Encrypting Your Audit Reports (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuditReport.html#audit-report-encryption). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -3001,8 +3001,8 @@ func (s *AccessMethod) SetCustomObjectIdentifier(v string) *AccessMethod { // or else this parameter is ignored. // // If conflicting or duplicate certificate information is supplied from other -// sources, ACM Private CA applies order of operation rules (xxxxx) to determine -// what information is used. +// sources, ACM Private CA applies order of operation rules (https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html#template-order-of-operations) +// to determine what information is used. type ApiPassthrough struct { _ struct{} `type:"structure"` @@ -3087,6 +3087,18 @@ type CertificateAuthority struct { // Reason the request to create your private CA failed. FailureReason *string `type:"string" enum:"FailureReason"` + // Defines a cryptographic key management compliance standard used for handling + // CA keys. + // + // Default: FIPS_140_2_LEVEL_3_OR_HIGHER + // + // Note: AWS Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. + // You must explicitly specify this parameter and value when creating a CA in + // that Region. Specifying a different value (or no value) results in an InvalidArgsException + // with the message "A certificate authority cannot be created in this region + // with the specified security standard." + KeyStorageSecurityStandard *string `type:"string" enum:"KeyStorageSecurityStandard"` + // Date and time at which your private CA was last updated. LastStateChangeAt *time.Time `type:"timestamp"` @@ -3153,6 +3165,12 @@ func (s *CertificateAuthority) SetFailureReason(v string) *CertificateAuthority return s } +// SetKeyStorageSecurityStandard sets the KeyStorageSecurityStandard field's value. +func (s *CertificateAuthority) SetKeyStorageSecurityStandard(v string) *CertificateAuthority { + s.KeyStorageSecurityStandard = &v + return s +} + // SetLastStateChangeAt sets the LastStateChangeAt field's value. func (s *CertificateAuthority) SetLastStateChangeAt(v time.Time) *CertificateAuthority { s.LastStateChangeAt = &v @@ -3548,6 +3566,18 @@ type CreateCertificateAuthorityInput struct { // that you are requesting multiple certificate authorities. IdempotencyToken *string `min:"1" type:"string"` + // Specifies a cryptographic key management compliance standard used for handling + // CA keys. + // + // Default: FIPS_140_2_LEVEL_3_OR_HIGHER + // + // Note: AWS Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. + // You must explicitly specify this parameter and value when creating a CA in + // that Region. Specifying a different value (or no value) results in an InvalidArgsException + // with the message "A certificate authority cannot be created in this region + // with the specified security standard." + KeyStorageSecurityStandard *string `type:"string" enum:"KeyStorageSecurityStandard"` + // Contains a Boolean value that you can use to enable a certification revocation // list (CRL) for the CA, the name of the S3 bucket to which ACM Private CA // will write the CRL, and an optional CNAME alias that you can use to hide @@ -3632,6 +3662,12 @@ func (s *CreateCertificateAuthorityInput) SetIdempotencyToken(v string) *CreateC return s } +// SetKeyStorageSecurityStandard sets the KeyStorageSecurityStandard field's value. +func (s *CreateCertificateAuthorityInput) SetKeyStorageSecurityStandard(v string) *CreateCertificateAuthorityInput { + s.KeyStorageSecurityStandard = &v + return s +} + // SetRevocationConfiguration sets the RevocationConfiguration field's value. func (s *CreateCertificateAuthorityInput) SetRevocationConfiguration(v *RevocationConfiguration) *CreateCertificateAuthorityInput { s.RevocationConfiguration = v @@ -3784,7 +3820,7 @@ func (s CreatePermissionOutput) GoString() string { // Points extension of each certificate it issues. Your S3 bucket policy must // give write permission to ACM Private CA. // -// ACM Private CAA assets that are stored in Amazon S3 can be protected with +// ACM Private CA assets that are stored in Amazon S3 can be protected with // encryption. For more information, see Encrypting Your CRLs (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption). // // Your private CA uses the value in the ExpirationInDays parameter to calculate @@ -5482,8 +5518,8 @@ type IssueCertificateInput struct { // templates, see Understanding Certificate Templates (https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html). // // If conflicting or duplicate certificate information is supplied during certificate - // issuance, ACM Private CA applies order of operation rules (xxxxx) to determine - // what information is used. + // issuance, ACM Private CA applies order of operation rules (https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html#template-order-of-operations) + // to determine what information is used. ApiPassthrough *ApiPassthrough `type:"structure"` // The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority @@ -7893,6 +7929,22 @@ func KeyAlgorithm_Values() []string { } } +const ( + // KeyStorageSecurityStandardFips1402Level2OrHigher is a KeyStorageSecurityStandard enum value + KeyStorageSecurityStandardFips1402Level2OrHigher = "FIPS_140_2_LEVEL_2_OR_HIGHER" + + // KeyStorageSecurityStandardFips1402Level3OrHigher is a KeyStorageSecurityStandard enum value + KeyStorageSecurityStandardFips1402Level3OrHigher = "FIPS_140_2_LEVEL_3_OR_HIGHER" +) + +// KeyStorageSecurityStandard_Values returns all elements of the KeyStorageSecurityStandard enum +func KeyStorageSecurityStandard_Values() []string { + return []string{ + KeyStorageSecurityStandardFips1402Level2OrHigher, + KeyStorageSecurityStandardFips1402Level3OrHigher, + } +} + const ( // PolicyQualifierIdCps is a PolicyQualifierId enum value PolicyQualifierIdCps = "CPS" diff --git a/service/chime/api.go b/service/chime/api.go index aa2c8e09364..fb6f2cf8739 100644 --- a/service/chime/api.go +++ b/service/chime/api.go @@ -1073,14 +1073,14 @@ func (c *Chime) BatchUpdatePhoneNumberRequest(input *BatchUpdatePhoneNumberInput // BatchUpdatePhoneNumber API operation for Amazon Chime. // // Updates phone number product types or calling names. You can update one attribute -// at a time for each UpdatePhoneNumberRequestItem . For example, you can update -// either the product type or the calling name. +// at a time for each UpdatePhoneNumberRequestItem. For example, you can update +// the product type or the calling name. // -// For product types, choose from Amazon Chime Business Calling and Amazon Chime -// Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice -// Connector product type. +// For toll-free numbers, you cannot use the Amazon Chime Business Calling product +// type. For numbers outside the US, you must use the Amazon Chime SIP Media +// Application Dial-In product type. // -// Updates to outbound calling names can take up to 72 hours to complete. Pending +// Updates to outbound calling names can take 72 hours to complete. Pending // updates to outbound calling names must be complete before you can request // another update. // @@ -2666,10 +2666,10 @@ func (c *Chime) CreatePhoneNumberOrderRequest(input *CreatePhoneNumberOrderInput // CreatePhoneNumberOrder API operation for Amazon Chime. // -// Creates an order for phone numbers to be provisioned. Choose from Amazon -// Chime Business Calling and Amazon Chime Voice Connector product types. For -// toll-free numbers, you must use the Amazon Chime Voice Connector product -// type. +// Creates an order for phone numbers to be provisioned. For toll-free numbers, +// you cannot use the Amazon Chime Business Calling product type. For numbers +// outside the US, you must use the Amazon Chime SIP Media Application Dial-In +// product type. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5008,9 +5008,9 @@ func (c *Chime) DeletePhoneNumberRequest(input *DeletePhoneNumberInput) (req *re // DeletePhoneNumber API operation for Amazon Chime. // -// Moves the specified phone number into the Deletionqueue. A phone number must -// be disassociated from any users or Amazon Chime Voice Connectors before it -// can be deleted. +// Moves the specified phone number into the Deletion queue. A phone number +// must be disassociated from any users or Amazon Chime Voice Connectors before +// it can be deleted. // // Deleted phone numbers remain in the Deletion queue for 7 days before they // are deleted permanently. @@ -12355,7 +12355,7 @@ func (c *Chime) ListChannelMessagesRequest(input *ListChannelMessagesInput) (req // ListChannelMessages API operation for Amazon Chime. // // List all the messages in a channel. Returns a paginated list of ChannelMessages. -// By default, sorted by creation timestamp in descending order . +// By default, sorted by creation timestamp in descending order. // // Redacted messages appear in the results as empty, since they are only redacted, // not deleted. Deleted messages do not appear in the results. This action always @@ -14274,6 +14274,103 @@ func (c *Chime) ListSipRulesPagesWithContext(ctx aws.Context, input *ListSipRule return p.Err() } +const opListSupportedPhoneNumberCountries = "ListSupportedPhoneNumberCountries" + +// ListSupportedPhoneNumberCountriesRequest generates a "aws/request.Request" representing the +// client's request for the ListSupportedPhoneNumberCountries operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListSupportedPhoneNumberCountries for more information on using the ListSupportedPhoneNumberCountries +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListSupportedPhoneNumberCountriesRequest method. +// req, resp := client.ListSupportedPhoneNumberCountriesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListSupportedPhoneNumberCountries +func (c *Chime) ListSupportedPhoneNumberCountriesRequest(input *ListSupportedPhoneNumberCountriesInput) (req *request.Request, output *ListSupportedPhoneNumberCountriesOutput) { + op := &request.Operation{ + Name: opListSupportedPhoneNumberCountries, + HTTPMethod: "GET", + HTTPPath: "/phone-number-countries", + } + + if input == nil { + input = &ListSupportedPhoneNumberCountriesInput{} + } + + output = &ListSupportedPhoneNumberCountriesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListSupportedPhoneNumberCountries API operation for Amazon Chime. +// +// Lists supported phone number countries. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Chime's +// API operation ListSupportedPhoneNumberCountries for usage and error information. +// +// Returned Error Types: +// * BadRequestException +// The input parameters don't match the service's restrictions. +// +// * ForbiddenException +// The client is permanently forbidden from making the request. +// +// * AccessDeniedException +// You don't have permissions to perform the requested operation. +// +// * UnauthorizedClientException +// The client is not currently authorized to make the request. +// +// * ThrottledClientException +// The client exceeded its request rate limit. +// +// * ServiceUnavailableException +// The service is currently unavailable. +// +// * ServiceFailureException +// The service encountered an unexpected error. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListSupportedPhoneNumberCountries +func (c *Chime) ListSupportedPhoneNumberCountries(input *ListSupportedPhoneNumberCountriesInput) (*ListSupportedPhoneNumberCountriesOutput, error) { + req, out := c.ListSupportedPhoneNumberCountriesRequest(input) + return out, req.Send() +} + +// ListSupportedPhoneNumberCountriesWithContext is the same as ListSupportedPhoneNumberCountries with the addition of +// the ability to pass a context and additional request options. +// +// See ListSupportedPhoneNumberCountries for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Chime) ListSupportedPhoneNumberCountriesWithContext(ctx aws.Context, input *ListSupportedPhoneNumberCountriesInput, opts ...request.Option) (*ListSupportedPhoneNumberCountriesOutput, error) { + req, out := c.ListSupportedPhoneNumberCountriesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opListTagsForResource = "ListTagsForResource" // ListTagsForResourceRequest generates a "aws/request.Request" representing the @@ -16856,6 +16953,12 @@ func (c *Chime) SearchAvailablePhoneNumbersRequest(input *SearchAvailablePhoneNu Name: opSearchAvailablePhoneNumbers, HTTPMethod: "GET", HTTPPath: "/search?type=phone-numbers", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, } if input == nil { @@ -16869,7 +16972,10 @@ func (c *Chime) SearchAvailablePhoneNumbersRequest(input *SearchAvailablePhoneNu // SearchAvailablePhoneNumbers API operation for Amazon Chime. // -// Searches phone numbers that can be ordered. +// Searches for phone numbers that can be ordered. For US numbers, provide at +// least one of the following search filters: AreaCode, City, State, or TollFreePrefix. +// If you provide City, you must also provide State. Numbers outside the US +// only support the PhoneNumberType filter, which you must use. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -16922,6 +17028,58 @@ func (c *Chime) SearchAvailablePhoneNumbersWithContext(ctx aws.Context, input *S return out, req.Send() } +// SearchAvailablePhoneNumbersPages iterates over the pages of a SearchAvailablePhoneNumbers operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See SearchAvailablePhoneNumbers method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a SearchAvailablePhoneNumbers operation. +// pageNum := 0 +// err := client.SearchAvailablePhoneNumbersPages(params, +// func(page *chime.SearchAvailablePhoneNumbersOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *Chime) SearchAvailablePhoneNumbersPages(input *SearchAvailablePhoneNumbersInput, fn func(*SearchAvailablePhoneNumbersOutput, bool) bool) error { + return c.SearchAvailablePhoneNumbersPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// SearchAvailablePhoneNumbersPagesWithContext same as SearchAvailablePhoneNumbersPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Chime) SearchAvailablePhoneNumbersPagesWithContext(ctx aws.Context, input *SearchAvailablePhoneNumbersInput, fn func(*SearchAvailablePhoneNumbersOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *SearchAvailablePhoneNumbersInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.SearchAvailablePhoneNumbersRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*SearchAvailablePhoneNumbersOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opSendChannelMessage = "SendChannelMessage" // SendChannelMessageRequest generates a "aws/request.Request" representing the @@ -18573,10 +18731,11 @@ func (c *Chime) UpdatePhoneNumberRequest(input *UpdatePhoneNumberInput) (req *re // For example, you can update either the product type or the calling name in // one action. // -// For toll-free numbers, you must use the Amazon Chime Voice Connector product -// type. +// For toll-free numbers, you cannot use the Amazon Chime Business Calling product +// type. For numbers outside the U.S., you must use the Amazon Chime SIP Media +// Application Dial-In product type. // -// Updates to outbound calling names can take up to 72 hours to complete. Pending +// Updates to outbound calling names can take 72 hours to complete. Pending // updates to outbound calling names must be complete before you can request // another update. // @@ -27168,7 +27327,7 @@ func (s *DescribeChannelBanInput) SetMemberArn(v string) *DescribeChannelBanInpu type DescribeChannelBanOutput struct { _ struct{} `type:"structure"` - // The the details of the ban. + // The details of the ban. ChannelBan *ChannelBan `type:"structure"` } @@ -32693,6 +32852,67 @@ func (s *ListSipRulesOutput) SetSipRules(v []*SipRule) *ListSipRulesOutput { return s } +type ListSupportedPhoneNumberCountriesInput struct { + _ struct{} `type:"structure"` + + // The phone number product type. + // + // ProductType is a required field + ProductType *string `location:"querystring" locationName:"product-type" type:"string" required:"true" enum:"PhoneNumberProductType"` +} + +// String returns the string representation +func (s ListSupportedPhoneNumberCountriesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListSupportedPhoneNumberCountriesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListSupportedPhoneNumberCountriesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListSupportedPhoneNumberCountriesInput"} + if s.ProductType == nil { + invalidParams.Add(request.NewErrParamRequired("ProductType")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetProductType sets the ProductType field's value. +func (s *ListSupportedPhoneNumberCountriesInput) SetProductType(v string) *ListSupportedPhoneNumberCountriesInput { + s.ProductType = &v + return s +} + +type ListSupportedPhoneNumberCountriesOutput struct { + _ struct{} `type:"structure"` + + // The supported phone number countries. + PhoneNumberCountries []*PhoneNumberCountry `type:"list"` +} + +// String returns the string representation +func (s ListSupportedPhoneNumberCountriesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListSupportedPhoneNumberCountriesOutput) GoString() string { + return s.String() +} + +// SetPhoneNumberCountries sets the PhoneNumberCountries field's value. +func (s *ListSupportedPhoneNumberCountriesOutput) SetPhoneNumberCountries(v []*PhoneNumberCountry) *ListSupportedPhoneNumberCountriesOutput { + s.PhoneNumberCountries = v + return s +} + type ListTagsForResourceInput struct { _ struct{} `type:"structure"` @@ -33807,6 +34027,9 @@ type PhoneNumber struct { // The phone number capabilities. Capabilities *PhoneNumberCapabilities `type:"structure"` + // The phone number country. Format: ISO 3166-1 alpha-2. + Country *string `type:"string"` + // The phone number creation timestamp, in ISO 8601 format. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` @@ -33866,6 +34089,12 @@ func (s *PhoneNumber) SetCapabilities(v *PhoneNumberCapabilities) *PhoneNumber { return s } +// SetCountry sets the Country field's value. +func (s *PhoneNumber) SetCountry(v string) *PhoneNumber { + s.Country = &v + return s +} + // SetCreatedTimestamp sets the CreatedTimestamp field's value. func (s *PhoneNumber) SetCreatedTimestamp(v time.Time) *PhoneNumber { s.CreatedTimestamp = &v @@ -34029,6 +34258,39 @@ func (s *PhoneNumberCapabilities) SetOutboundSMS(v bool) *PhoneNumberCapabilitie return s } +// The phone number country. +type PhoneNumberCountry struct { + _ struct{} `type:"structure"` + + // The phone number country code. Format: ISO 3166-1 alpha-2. + CountryCode *string `type:"string"` + + // The supported phone number types. + SupportedPhoneNumberTypes []*string `type:"list"` +} + +// String returns the string representation +func (s PhoneNumberCountry) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PhoneNumberCountry) GoString() string { + return s.String() +} + +// SetCountryCode sets the CountryCode field's value. +func (s *PhoneNumberCountry) SetCountryCode(v string) *PhoneNumberCountry { + s.CountryCode = &v + return s +} + +// SetSupportedPhoneNumberTypes sets the SupportedPhoneNumberTypes field's value. +func (s *PhoneNumberCountry) SetSupportedPhoneNumberTypes(v []*string) *PhoneNumberCountry { + s.SupportedPhoneNumberTypes = v + return s +} + // If the phone number action fails for one or more of the phone numbers in // the request, a list of the phone numbers is returned, along with error codes // and error messages. @@ -36156,25 +36418,31 @@ func (s *RoomRetentionSettings) SetRetentionDays(v int64) *RoomRetentionSettings type SearchAvailablePhoneNumbersInput struct { _ struct{} `type:"structure"` - // The area code used to filter results. + // The area code used to filter results. Only applies to the US. AreaCode *string `location:"querystring" locationName:"area-code" type:"string"` - // The city used to filter results. + // The city used to filter results. Only applies to the US. City *string `location:"querystring" locationName:"city" type:"string"` - // The country used to filter results. + // The country used to filter results. Defaults to the US Format: ISO 3166-1 + // alpha-2. Country *string `location:"querystring" locationName:"country" type:"string"` // The maximum number of results to return in a single call. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` - // The token to use to retrieve the next page of results. + // The token used to retrieve the next page of results. NextToken *string `location:"querystring" locationName:"next-token" type:"string"` - // The state used to filter results. + // The phone number type used to filter results. Required for non-US numbers. + PhoneNumberType *string `location:"querystring" locationName:"phone-number-type" type:"string" enum:"PhoneNumberType"` + + // The state used to filter results. Required only if you provide City. Only + // applies to the US. State *string `location:"querystring" locationName:"state" type:"string"` - // The toll-free prefix that you use to filter results. + // The toll-free prefix that you use to filter results. Only applies to the + // US. TollFreePrefix *string `location:"querystring" locationName:"toll-free-prefix" min:"3" type:"string"` } @@ -36234,6 +36502,12 @@ func (s *SearchAvailablePhoneNumbersInput) SetNextToken(v string) *SearchAvailab return s } +// SetPhoneNumberType sets the PhoneNumberType field's value. +func (s *SearchAvailablePhoneNumbersInput) SetPhoneNumberType(v string) *SearchAvailablePhoneNumbersInput { + s.PhoneNumberType = &v + return s +} + // SetState sets the State field's value. func (s *SearchAvailablePhoneNumbersInput) SetState(v string) *SearchAvailablePhoneNumbersInput { s.State = &v @@ -36251,6 +36525,9 @@ type SearchAvailablePhoneNumbersOutput struct { // List of phone numbers, in E.164 format. E164PhoneNumbers []*string `type:"list"` + + // The token used to retrieve the next page of search results. + NextToken *string `type:"string"` } // String returns the string representation @@ -36269,6 +36546,12 @@ func (s *SearchAvailablePhoneNumbersOutput) SetE164PhoneNumbers(v []*string) *Se return s } +// SetNextToken sets the NextToken field's value. +func (s *SearchAvailablePhoneNumbersOutput) SetNextToken(v string) *SearchAvailablePhoneNumbersOutput { + s.NextToken = &v + return s +} + type SendChannelMessageInput struct { _ struct{} `type:"structure"` @@ -40753,6 +41036,9 @@ const ( // PhoneNumberProductTypeVoiceConnector is a PhoneNumberProductType enum value PhoneNumberProductTypeVoiceConnector = "VoiceConnector" + + // PhoneNumberProductTypeSipMediaApplicationDialIn is a PhoneNumberProductType enum value + PhoneNumberProductTypeSipMediaApplicationDialIn = "SipMediaApplicationDialIn" ) // PhoneNumberProductType_Values returns all elements of the PhoneNumberProductType enum @@ -40760,6 +41046,7 @@ func PhoneNumberProductType_Values() []string { return []string{ PhoneNumberProductTypeBusinessCalling, PhoneNumberProductTypeVoiceConnector, + PhoneNumberProductTypeSipMediaApplicationDialIn, } } diff --git a/service/chime/chimeiface/interface.go b/service/chime/chimeiface/interface.go index 53ce2efaa0c..8c26449e220 100644 --- a/service/chime/chimeiface/interface.go +++ b/service/chime/chimeiface/interface.go @@ -643,6 +643,10 @@ type ChimeAPI interface { ListSipRulesPages(*chime.ListSipRulesInput, func(*chime.ListSipRulesOutput, bool) bool) error ListSipRulesPagesWithContext(aws.Context, *chime.ListSipRulesInput, func(*chime.ListSipRulesOutput, bool) bool, ...request.Option) error + ListSupportedPhoneNumberCountries(*chime.ListSupportedPhoneNumberCountriesInput) (*chime.ListSupportedPhoneNumberCountriesOutput, error) + ListSupportedPhoneNumberCountriesWithContext(aws.Context, *chime.ListSupportedPhoneNumberCountriesInput, ...request.Option) (*chime.ListSupportedPhoneNumberCountriesOutput, error) + ListSupportedPhoneNumberCountriesRequest(*chime.ListSupportedPhoneNumberCountriesInput) (*request.Request, *chime.ListSupportedPhoneNumberCountriesOutput) + ListTagsForResource(*chime.ListTagsForResourceInput) (*chime.ListTagsForResourceOutput, error) ListTagsForResourceWithContext(aws.Context, *chime.ListTagsForResourceInput, ...request.Option) (*chime.ListTagsForResourceOutput, error) ListTagsForResourceRequest(*chime.ListTagsForResourceInput) (*request.Request, *chime.ListTagsForResourceOutput) @@ -752,6 +756,9 @@ type ChimeAPI interface { SearchAvailablePhoneNumbersWithContext(aws.Context, *chime.SearchAvailablePhoneNumbersInput, ...request.Option) (*chime.SearchAvailablePhoneNumbersOutput, error) SearchAvailablePhoneNumbersRequest(*chime.SearchAvailablePhoneNumbersInput) (*request.Request, *chime.SearchAvailablePhoneNumbersOutput) + SearchAvailablePhoneNumbersPages(*chime.SearchAvailablePhoneNumbersInput, func(*chime.SearchAvailablePhoneNumbersOutput, bool) bool) error + SearchAvailablePhoneNumbersPagesWithContext(aws.Context, *chime.SearchAvailablePhoneNumbersInput, func(*chime.SearchAvailablePhoneNumbersOutput, bool) bool, ...request.Option) error + SendChannelMessage(*chime.SendChannelMessageInput) (*chime.SendChannelMessageOutput, error) SendChannelMessageWithContext(aws.Context, *chime.SendChannelMessageInput, ...request.Option) (*chime.SendChannelMessageOutput, error) SendChannelMessageRequest(*chime.SendChannelMessageInput) (*request.Request, *chime.SendChannelMessageOutput) diff --git a/service/devopsguru/api.go b/service/devopsguru/api.go index b0bb1b36154..51303df8eb1 100644 --- a/service/devopsguru/api.go +++ b/service/devopsguru/api.go @@ -662,7 +662,7 @@ func (c *DevOpsGuru) DescribeResourceCollectionHealthRequest(input *DescribeReso // in your account. You specify the type of AWS resources collection. The one // type of AWS resource collection supported is AWS CloudFormation stacks. DevOps // Guru can be configured to analyze only the AWS resources that are defined -// in the stacks. +// in the stacks. You can specify up to 500 AWS CloudFormation stacks. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -858,6 +858,163 @@ func (c *DevOpsGuru) DescribeServiceIntegrationWithContext(ctx aws.Context, inpu return out, req.Send() } +const opGetCostEstimation = "GetCostEstimation" + +// GetCostEstimationRequest generates a "aws/request.Request" representing the +// client's request for the GetCostEstimation operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetCostEstimation for more information on using the GetCostEstimation +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetCostEstimationRequest method. +// req, resp := client.GetCostEstimationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/devops-guru-2020-12-01/GetCostEstimation +func (c *DevOpsGuru) GetCostEstimationRequest(input *GetCostEstimationInput) (req *request.Request, output *GetCostEstimationOutput) { + op := &request.Operation{ + Name: opGetCostEstimation, + HTTPMethod: "GET", + HTTPPath: "/cost-estimation", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "", + TruncationToken: "", + }, + } + + if input == nil { + input = &GetCostEstimationInput{} + } + + output = &GetCostEstimationOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetCostEstimation API operation for Amazon DevOps Guru. +// +// Returns an estimate of the monthly cost for DevOps Guru to analyze your AWS +// resources. For more information, see Estimate your Amazon DevOps Guru costs +// (https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html) +// and Amazon DevOps Guru pricing (http://aws.amazon.com/devops-guru/pricing/). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon DevOps Guru's +// API operation GetCostEstimation for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. For more information, see +// Access Management (https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) +// in the IAM User Guide. +// +// * InternalServerException +// An internal failure in an Amazon service occurred. +// +// * ResourceNotFoundException +// A requested resource could not be found +// +// * ThrottlingException +// The request was denied due to a request throttling. +// +// * ValidationException +// Contains information about data passed in to a field during a request that +// is not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/devops-guru-2020-12-01/GetCostEstimation +func (c *DevOpsGuru) GetCostEstimation(input *GetCostEstimationInput) (*GetCostEstimationOutput, error) { + req, out := c.GetCostEstimationRequest(input) + return out, req.Send() +} + +// GetCostEstimationWithContext is the same as GetCostEstimation with the addition of +// the ability to pass a context and additional request options. +// +// See GetCostEstimation for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *DevOpsGuru) GetCostEstimationWithContext(ctx aws.Context, input *GetCostEstimationInput, opts ...request.Option) (*GetCostEstimationOutput, error) { + req, out := c.GetCostEstimationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// GetCostEstimationPages iterates over the pages of a GetCostEstimation operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See GetCostEstimation method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a GetCostEstimation operation. +// pageNum := 0 +// err := client.GetCostEstimationPages(params, +// func(page *devopsguru.GetCostEstimationOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *DevOpsGuru) GetCostEstimationPages(input *GetCostEstimationInput, fn func(*GetCostEstimationOutput, bool) bool) error { + return c.GetCostEstimationPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// GetCostEstimationPagesWithContext same as GetCostEstimationPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *DevOpsGuru) GetCostEstimationPagesWithContext(ctx aws.Context, input *GetCostEstimationInput, fn func(*GetCostEstimationOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *GetCostEstimationInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.GetCostEstimationRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*GetCostEstimationOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opGetResourceCollection = "GetResourceCollection" // GetResourceCollectionRequest generates a "aws/request.Request" representing the @@ -911,7 +1068,7 @@ func (c *DevOpsGuru) GetResourceCollectionRequest(input *GetResourceCollectionIn // Returns lists AWS resources that are of the specified resource collection // type. The one type of AWS resource collection supported is AWS CloudFormation // stacks. DevOps Guru can be configured to analyze only the AWS resources that -// are defined in the stacks. +// are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2146,6 +2303,107 @@ func (c *DevOpsGuru) SearchInsightsPagesWithContext(ctx aws.Context, input *Sear return p.Err() } +const opStartCostEstimation = "StartCostEstimation" + +// StartCostEstimationRequest generates a "aws/request.Request" representing the +// client's request for the StartCostEstimation operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See StartCostEstimation for more information on using the StartCostEstimation +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the StartCostEstimationRequest method. +// req, resp := client.StartCostEstimationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/devops-guru-2020-12-01/StartCostEstimation +func (c *DevOpsGuru) StartCostEstimationRequest(input *StartCostEstimationInput) (req *request.Request, output *StartCostEstimationOutput) { + op := &request.Operation{ + Name: opStartCostEstimation, + HTTPMethod: "PUT", + HTTPPath: "/cost-estimation", + } + + if input == nil { + input = &StartCostEstimationInput{} + } + + output = &StartCostEstimationOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// StartCostEstimation API operation for Amazon DevOps Guru. +// +// Starts the creation of an estimate of the monthly cost to analyze your AWS +// resources. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon DevOps Guru's +// API operation StartCostEstimation for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You don't have permissions to perform the requested operation. The user or +// role that is making the request must have at least one IAM permissions policy +// attached that grants the required permissions. For more information, see +// Access Management (https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) +// in the IAM User Guide. +// +// * ConflictException +// An exception that is thrown when a conflict occurs. +// +// * InternalServerException +// An internal failure in an Amazon service occurred. +// +// * ResourceNotFoundException +// A requested resource could not be found +// +// * ThrottlingException +// The request was denied due to a request throttling. +// +// * ValidationException +// Contains information about data passed in to a field during a request that +// is not valid. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/devops-guru-2020-12-01/StartCostEstimation +func (c *DevOpsGuru) StartCostEstimation(input *StartCostEstimationInput) (*StartCostEstimationOutput, error) { + req, out := c.StartCostEstimationRequest(input) + return out, req.Send() +} + +// StartCostEstimationWithContext is the same as StartCostEstimation with the addition of +// the ability to pass a context and additional request options. +// +// See StartCostEstimation for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *DevOpsGuru) StartCostEstimationWithContext(ctx aws.Context, input *StartCostEstimationInput, opts ...request.Option) (*StartCostEstimationOutput, error) { + req, out := c.StartCostEstimationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opUpdateResourceCollection = "UpdateResourceCollection" // UpdateResourceCollectionRequest generates a "aws/request.Request" representing the @@ -2194,8 +2452,8 @@ func (c *DevOpsGuru) UpdateResourceCollectionRequest(input *UpdateResourceCollec // Updates the collection of resources that DevOps Guru analyzes. The one type // of AWS resource collection supported is AWS CloudFormation stacks. DevOps // Guru can be configured to analyze only the AWS resources that are defined -// in the stacks. This method also creates the IAM role required for you to -// use DevOps Guru. +// in the stacks. You can specify up to 500 AWS CloudFormation stacks. This +// method also creates the IAM role required for you to use DevOps Guru. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2539,9 +2797,9 @@ func (s *AnomalyTimeRange) SetStartTime(v time.Time) *AnomalyTimeRange { return s } -// Information about AWS CloudFormation stacks. You can use stacks to specify -// which AWS resources in your account to analyze. For more information, see -// Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) +// Information about AWS CloudFormation stacks. You can use up to 500 stacks +// to specify which AWS resources in your account to analyze. For more information, +// see Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) // in the AWS CloudFormation User Guide. type CloudFormationCollection struct { _ struct{} `type:"structure"` @@ -2566,9 +2824,9 @@ func (s *CloudFormationCollection) SetStackNames(v []*string) *CloudFormationCol return s } -// Information about AWS CloudFormation stacks. You can use stacks to specify -// which AWS resources in your account to analyze. For more information, see -// Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) +// Information about AWS CloudFormation stacks. You can use up to 500 stacks +// to specify which AWS resources in your account to analyze. For more information, +// see Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) // in the AWS CloudFormation User Guide. type CloudFormationCollectionFilter struct { _ struct{} `type:"structure"` @@ -2593,6 +2851,48 @@ func (s *CloudFormationCollectionFilter) SetStackNames(v []*string) *CloudFormat return s } +// Information about an AWS CloudFormation stack used to create a monthly cost +// estimate for DevOps Guru to analyze AWS resources. The maximum number of +// stacks you can specify for a cost estimate is one. The estimate created is +// for the cost to analyze the AWS resources defined by the stack. For more +// information, see Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) +// in the AWS CloudFormation User Guide. +type CloudFormationCostEstimationResourceCollectionFilter struct { + _ struct{} `type:"structure"` + + // An array of CloudFormation stack names. Its size is fixed at 1 item. + StackNames []*string `min:"1" type:"list"` +} + +// String returns the string representation +func (s CloudFormationCostEstimationResourceCollectionFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CloudFormationCostEstimationResourceCollectionFilter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CloudFormationCostEstimationResourceCollectionFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CloudFormationCostEstimationResourceCollectionFilter"} + if s.StackNames != nil && len(s.StackNames) < 1 { + invalidParams.Add(request.NewErrParamMinLen("StackNames", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetStackNames sets the StackNames field's value. +func (s *CloudFormationCostEstimationResourceCollectionFilter) SetStackNames(v []*string) *CloudFormationCostEstimationResourceCollectionFilter { + s.StackNames = v + return s +} + // Information about the health of AWS resources in your account that are specified // by an AWS CloudFormation stack. type CloudFormationHealth struct { @@ -2806,6 +3106,82 @@ func (s *ConflictException) RequestID() string { return s.RespMetadata.RequestID } +// Information about a filter used to specify which AWS resources are analyzed +// to create a monthly DevOps Guru cost estimate. For more information, see +// Estimate your Amazon DevOps Guru costs (https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html) +// and Amazon DevOps Guru pricing (http://aws.amazon.com/devops-guru/pricing/). +type CostEstimationResourceCollectionFilter struct { + _ struct{} `type:"structure"` + + // An object that specifies the CloudFormation stack that defines the AWS resources + // used to create a monthly estimate for DevOps Guru. + CloudFormation *CloudFormationCostEstimationResourceCollectionFilter `type:"structure"` +} + +// String returns the string representation +func (s CostEstimationResourceCollectionFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CostEstimationResourceCollectionFilter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CostEstimationResourceCollectionFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CostEstimationResourceCollectionFilter"} + if s.CloudFormation != nil { + if err := s.CloudFormation.Validate(); err != nil { + invalidParams.AddNested("CloudFormation", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCloudFormation sets the CloudFormation field's value. +func (s *CostEstimationResourceCollectionFilter) SetCloudFormation(v *CloudFormationCostEstimationResourceCollectionFilter) *CostEstimationResourceCollectionFilter { + s.CloudFormation = v + return s +} + +// The time range of a cost estimation. +type CostEstimationTimeRange struct { + _ struct{} `type:"structure"` + + // The end time of the cost estimation. + EndTime *time.Time `type:"timestamp"` + + // The start time of the cost estimation. + StartTime *time.Time `type:"timestamp"` +} + +// String returns the string representation +func (s CostEstimationTimeRange) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CostEstimationTimeRange) GoString() string { + return s.String() +} + +// SetEndTime sets the EndTime field's value. +func (s *CostEstimationTimeRange) SetEndTime(v time.Time) *CostEstimationTimeRange { + s.EndTime = &v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *CostEstimationTimeRange) SetStartTime(v time.Time) *CostEstimationTimeRange { + s.StartTime = &v + return s +} + type DescribeAccountHealthInput struct { _ struct{} `type:"structure"` } @@ -3027,10 +3403,10 @@ func (s *DescribeAnomalyInput) SetId(v string) *DescribeAnomalyInput { type DescribeAnomalyOutput struct { _ struct{} `type:"structure"` - // An ReactiveAnomaly object that represents the requested anomaly. + // A ReactiveAnomaly object that represents the requested anomaly. ProactiveAnomaly *ProactiveAnomaly `type:"structure"` - // An ProactiveAnomaly object that represents the requested anomaly. + // A ProactiveAnomaly object that represents the requested anomaly. ReactiveAnomaly *ReactiveAnomaly `type:"structure"` } @@ -3159,10 +3535,10 @@ func (s *DescribeInsightInput) SetId(v string) *DescribeInsightInput { type DescribeInsightOutput struct { _ struct{} `type:"structure"` - // An ProactiveInsight object that represents the requested insight. + // A ProactiveInsight object that represents the requested insight. ProactiveInsight *ProactiveInsight `type:"structure"` - // An ReactiveInsight object that represents the requested insight. + // A ReactiveInsight object that represents the requested insight. ReactiveInsight *ReactiveInsight `type:"structure"` } @@ -3198,7 +3574,7 @@ type DescribeResourceCollectionHealthInput struct { // An AWS resource collection type. This type specifies how analyzed AWS resources // are defined. The one type of AWS resource collection supported is AWS CloudFormation // stacks. DevOps Guru can be configured to analyze only the AWS resources that - // are defined in the stacks. + // are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks. // // ResourceCollectionType is a required field ResourceCollectionType *string `location:"uri" locationName:"ResourceCollectionType" type:"string" required:"true" enum:"ResourceCollectionType"` @@ -3257,6 +3633,10 @@ type DescribeResourceCollectionHealthOutput struct { // The pagination token to use to retrieve the next page of results for this // operation. If there are no more pages, this value is null. NextToken *string `min:"36" type:"string"` + + // An array of ServiceHealth objects that describes the health of the AWS services + // associated with the resources in the collection. + Service []*ServiceHealth `type:"list"` } // String returns the string representation @@ -3281,6 +3661,12 @@ func (s *DescribeResourceCollectionHealthOutput) SetNextToken(v string) *Describ return s } +// SetService sets the Service field's value. +func (s *DescribeResourceCollectionHealthOutput) SetService(v []*ServiceHealth) *DescribeResourceCollectionHealthOutput { + s.Service = v + return s +} + type DescribeServiceIntegrationInput struct { _ struct{} `type:"structure"` } @@ -3379,6 +3765,7 @@ type Event struct { // A collection of AWS resources supported by DevOps Guru. The one type of AWS // resource collection supported is AWS CloudFormation stacks. DevOps Guru can // be configured to analyze only the AWS resources that are defined in the stacks. + // You can specify up to 500 AWS CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` // An EventResource object that contains information about the resource that @@ -3513,36 +3900,147 @@ func (s EventTimeRange) String() string { return awsutil.Prettify(s) } -// GoString returns the string representation -func (s EventTimeRange) GoString() string { - return s.String() +// GoString returns the string representation +func (s EventTimeRange) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EventTimeRange) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EventTimeRange"} + if s.FromTime == nil { + invalidParams.Add(request.NewErrParamRequired("FromTime")) + } + if s.ToTime == nil { + invalidParams.Add(request.NewErrParamRequired("ToTime")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFromTime sets the FromTime field's value. +func (s *EventTimeRange) SetFromTime(v time.Time) *EventTimeRange { + s.FromTime = &v + return s +} + +// SetToTime sets the ToTime field's value. +func (s *EventTimeRange) SetToTime(v time.Time) *EventTimeRange { + s.ToTime = &v + return s +} + +type GetCostEstimationInput struct { + _ struct{} `type:"structure"` + + // The pagination token to use to retrieve the next page of results for this + // operation. If this value is null, it retrieves the first page. + NextToken *string `location:"querystring" locationName:"NextToken" min:"36" type:"string"` +} + +// String returns the string representation +func (s GetCostEstimationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetCostEstimationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetCostEstimationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetCostEstimationInput"} + if s.NextToken != nil && len(*s.NextToken) < 36 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetNextToken sets the NextToken field's value. +func (s *GetCostEstimationInput) SetNextToken(v string) *GetCostEstimationInput { + s.NextToken = &v + return s +} + +type GetCostEstimationOutput struct { + _ struct{} `type:"structure"` + + // An array of ResourceCost objects that each contains details about the monthly + // cost estimate to analyze one of your AWS resources. + Costs []*ServiceResourceCost `type:"list"` + + // The pagination token to use to retrieve the next page of results for this + // operation. If there are no more pages, this value is null. + NextToken *string `min:"36" type:"string"` + + // The collection of the AWS resources used to create your monthly DevOps Guru + // cost estimate. + ResourceCollection *CostEstimationResourceCollectionFilter `type:"structure"` + + // The status of creating this cost estimate. If it's still in progress, the + // status ONGOING is returned. If it is finished, the status COMPLETED is returned. + Status *string `type:"string" enum:"CostEstimationStatus"` + + // The start and end time of the cost estimation. + TimeRange *CostEstimationTimeRange `type:"structure"` + + // The estimated monthly cost to analyze the AWS resources. This value is the + // sum of the estimated costs to analyze each resource in the Costs object in + // this response. + TotalCost *float64 `type:"double"` +} + +// String returns the string representation +func (s GetCostEstimationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetCostEstimationOutput) GoString() string { + return s.String() +} + +// SetCosts sets the Costs field's value. +func (s *GetCostEstimationOutput) SetCosts(v []*ServiceResourceCost) *GetCostEstimationOutput { + s.Costs = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetCostEstimationOutput) SetNextToken(v string) *GetCostEstimationOutput { + s.NextToken = &v + return s +} + +// SetResourceCollection sets the ResourceCollection field's value. +func (s *GetCostEstimationOutput) SetResourceCollection(v *CostEstimationResourceCollectionFilter) *GetCostEstimationOutput { + s.ResourceCollection = v + return s } -// Validate inspects the fields of the type to determine if they are valid. -func (s *EventTimeRange) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "EventTimeRange"} - if s.FromTime == nil { - invalidParams.Add(request.NewErrParamRequired("FromTime")) - } - if s.ToTime == nil { - invalidParams.Add(request.NewErrParamRequired("ToTime")) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetStatus sets the Status field's value. +func (s *GetCostEstimationOutput) SetStatus(v string) *GetCostEstimationOutput { + s.Status = &v + return s } -// SetFromTime sets the FromTime field's value. -func (s *EventTimeRange) SetFromTime(v time.Time) *EventTimeRange { - s.FromTime = &v +// SetTimeRange sets the TimeRange field's value. +func (s *GetCostEstimationOutput) SetTimeRange(v *CostEstimationTimeRange) *GetCostEstimationOutput { + s.TimeRange = v return s } -// SetToTime sets the ToTime field's value. -func (s *EventTimeRange) SetToTime(v time.Time) *EventTimeRange { - s.ToTime = &v +// SetTotalCost sets the TotalCost field's value. +func (s *GetCostEstimationOutput) SetTotalCost(v float64) *GetCostEstimationOutput { + s.TotalCost = &v return s } @@ -3610,7 +4108,8 @@ type GetResourceCollectionOutput struct { // The requested list of AWS resource collections. The one type of AWS resource // collection supported is AWS CloudFormation stacks. DevOps Guru can be configured - // to analyze only the AWS resources that are defined in the stacks. + // to analyze only the AWS resources that are defined in the stacks. You can + // specify up to 500 AWS CloudFormation stacks. ResourceCollection *ResourceCollectionFilter `type:"structure"` } @@ -3965,6 +4464,7 @@ type ListEventsFilters struct { // A collection of AWS resources supported by DevOps Guru. The one type of AWS // resource collection supported is AWS CloudFormation stacks. DevOps Guru can // be configured to analyze only the AWS resources that are defined in the stacks. + // You can specify up to 500 AWS CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` } @@ -4544,6 +5044,9 @@ type ListRecommendationsInput struct { // InsightId is a required field InsightId *string `min:"1" type:"string" required:"true"` + // A locale that specifies the language to use for recommendations. + Locale *string `type:"string" enum:"Locale"` + // The pagination token to use to retrieve the next page of results for this // operation. If this value is null, it retrieves the first page. NextToken *string `min:"36" type:"string"` @@ -4584,6 +5087,12 @@ func (s *ListRecommendationsInput) SetInsightId(v string) *ListRecommendationsIn return s } +// SetLocale sets the Locale field's value. +func (s *ListRecommendationsInput) SetLocale(v string) *ListRecommendationsInput { + s.Locale = &v + return s +} + // SetNextToken sets the NextToken field's value. func (s *ListRecommendationsInput) SetNextToken(v string) *ListRecommendationsInput { s.NextToken = &v @@ -4843,6 +5352,7 @@ type ProactiveAnomaly struct { // A collection of AWS resources supported by DevOps Guru. The one type of AWS // resource collection supported is AWS CloudFormation stacks. DevOps Guru can // be configured to analyze only the AWS resources that are defined in the stacks. + // You can specify up to 500 AWS CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` // The severity of a proactive anomaly. @@ -4955,6 +5465,7 @@ type ProactiveAnomalySummary struct { // A collection of AWS resources supported by DevOps Guru. The one type of AWS // resource collection supported is AWS CloudFormation stacks. DevOps Guru can // be configured to analyze only the AWS resources that are defined in the stacks. + // You can specify up to 500 AWS CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` // The severity of the anomaly. @@ -5062,6 +5573,7 @@ type ProactiveInsight struct { // A collection of AWS resources supported by DevOps Guru. The one type of AWS // resource collection supported is AWS CloudFormation stacks. DevOps Guru can // be configured to analyze only the AWS resources that are defined in the stacks. + // You can specify up to 500 AWS CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` // The severity of the proactive insight. @@ -5155,8 +5667,12 @@ type ProactiveInsightSummary struct { // A collection of AWS resources supported by DevOps Guru. The one type of AWS // resource collection supported is AWS CloudFormation stacks. DevOps Guru can // be configured to analyze only the AWS resources that are defined in the stacks. + // You can specify up to 500 AWS CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` + // A collection of the names of AWS services. + ServiceCollection *ServiceCollection `type:"structure"` + // The severity of the proactive insight. Severity *string `type:"string" enum:"InsightSeverity"` @@ -5204,6 +5720,12 @@ func (s *ProactiveInsightSummary) SetResourceCollection(v *ResourceCollection) * return s } +// SetServiceCollection sets the ServiceCollection field's value. +func (s *ProactiveInsightSummary) SetServiceCollection(v *ServiceCollection) *ProactiveInsightSummary { + s.ServiceCollection = v + return s +} + // SetSeverity sets the Severity field's value. func (s *ProactiveInsightSummary) SetSeverity(v string) *ProactiveInsightSummary { s.Severity = &v @@ -5286,6 +5808,7 @@ type ReactiveAnomaly struct { // A collection of AWS resources supported by DevOps Guru. The one type of AWS // resource collection supported is AWS CloudFormation stacks. DevOps Guru can // be configured to analyze only the AWS resources that are defined in the stacks. + // You can specify up to 500 AWS CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` // The severity of the anomaly. @@ -5369,6 +5892,7 @@ type ReactiveAnomalySummary struct { // A collection of AWS resources supported by DevOps Guru. The one type of AWS // resource collection supported is AWS CloudFormation stacks. DevOps Guru can // be configured to analyze only the AWS resources that are defined in the stacks. + // You can specify up to 500 AWS CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` // The severity of the reactive anomaly. @@ -5451,6 +5975,7 @@ type ReactiveInsight struct { // A collection of AWS resources supported by DevOps Guru. The one type of AWS // resource collection supported is AWS CloudFormation stacks. DevOps Guru can // be configured to analyze only the AWS resources that are defined in the stacks. + // You can specify up to 500 AWS CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` // The severity of a reactive insight. @@ -5534,8 +6059,12 @@ type ReactiveInsightSummary struct { // A collection of AWS resources supported by DevOps Guru. The one type of AWS // resource collection supported is AWS CloudFormation stacks. DevOps Guru can // be configured to analyze only the AWS resources that are defined in the stacks. + // You can specify up to 500 AWS CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` + // A collection of the names of AWS services. + ServiceCollection *ServiceCollection `type:"structure"` + // The severity of a reactive insight. Severity *string `type:"string" enum:"InsightSeverity"` @@ -5577,6 +6106,12 @@ func (s *ReactiveInsightSummary) SetResourceCollection(v *ResourceCollection) *R return s } +// SetServiceCollection sets the ServiceCollection field's value. +func (s *ReactiveInsightSummary) SetServiceCollection(v *ServiceCollection) *ReactiveInsightSummary { + s.ServiceCollection = v + return s +} + // SetSeverity sets the Severity field's value. func (s *ReactiveInsightSummary) SetSeverity(v string) *ReactiveInsightSummary { s.Severity = &v @@ -5798,7 +6333,7 @@ type RecommendationRelatedEvent struct { Name *string `type:"string"` // A ResourceCollection object that contains arrays of the names of AWS CloudFormation - // stacks. + // stacks. You can specify up to 500 AWS CloudFormation stacks. Resources []*RecommendationRelatedEventResource `type:"list"` } @@ -5918,11 +6453,13 @@ func (s RemoveNotificationChannelOutput) GoString() string { // A collection of AWS resources supported by DevOps Guru. The one type of AWS // resource collection supported is AWS CloudFormation stacks. DevOps Guru can // be configured to analyze only the AWS resources that are defined in the stacks. +// You can specify up to 500 AWS CloudFormation stacks. type ResourceCollection struct { _ struct{} `type:"structure"` // An array of the names of AWS CloudFormation stacks. The stacks define AWS - // resources that DevOps Guru analyzes. + // resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation + // stacks. CloudFormation *CloudFormationCollection `type:"structure"` } @@ -5947,9 +6484,9 @@ func (s *ResourceCollection) SetCloudFormation(v *CloudFormationCollection) *Res type ResourceCollectionFilter struct { _ struct{} `type:"structure"` - // Information about AWS CloudFormation stacks. You can use stacks to specify - // which AWS resources in your account to analyze. For more information, see - // Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) + // Information about AWS CloudFormation stacks. You can use up to 500 stacks + // to specify which AWS resources in your account to analyze. For more information, + // see Stacks (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html) // in the AWS CloudFormation User Guide. CloudFormation *CloudFormationCollectionFilter `type:"structure"` } @@ -6044,8 +6581,12 @@ type SearchInsightsFilters struct { // A collection of AWS resources supported by DevOps Guru. The one type of AWS // resource collection supported is AWS CloudFormation stacks. DevOps Guru can // be configured to analyze only the AWS resources that are defined in the stacks. + // You can specify up to 500 AWS CloudFormation stacks. ResourceCollection *ResourceCollection `type:"structure"` + // A collection of the names of AWS services. + ServiceCollection *ServiceCollection `type:"structure"` + // An array of severity values used to search for insights. Severities []*string `type:"list"` @@ -6069,6 +6610,12 @@ func (s *SearchInsightsFilters) SetResourceCollection(v *ResourceCollection) *Se return s } +// SetServiceCollection sets the ServiceCollection field's value. +func (s *SearchInsightsFilters) SetServiceCollection(v *ServiceCollection) *SearchInsightsFilters { + s.ServiceCollection = v + return s +} + // SetSeverities sets the Severities field's value. func (s *SearchInsightsFilters) SetSeverities(v []*string) *SearchInsightsFilters { s.Severities = v @@ -6212,6 +6759,98 @@ func (s *SearchInsightsOutput) SetReactiveInsights(v []*ReactiveInsightSummary) return s } +// A collection of the names of AWS services. +type ServiceCollection struct { + _ struct{} `type:"structure"` + + // An array of strings that each specifies the name of an AWS service. + ServiceNames []*string `type:"list"` +} + +// String returns the string representation +func (s ServiceCollection) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ServiceCollection) GoString() string { + return s.String() +} + +// SetServiceNames sets the ServiceNames field's value. +func (s *ServiceCollection) SetServiceNames(v []*string) *ServiceCollection { + s.ServiceNames = v + return s +} + +// Represents the health of an AWS service. +type ServiceHealth struct { + _ struct{} `type:"structure"` + + // Represents the health of an AWS service. This is a ServiceInsightHealth that + // contains the number of open proactive and reactive insights for this service. + Insight *ServiceInsightHealth `type:"structure"` + + // The name of the AWS service. + ServiceName *string `type:"string" enum:"ServiceName"` +} + +// String returns the string representation +func (s ServiceHealth) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ServiceHealth) GoString() string { + return s.String() +} + +// SetInsight sets the Insight field's value. +func (s *ServiceHealth) SetInsight(v *ServiceInsightHealth) *ServiceHealth { + s.Insight = v + return s +} + +// SetServiceName sets the ServiceName field's value. +func (s *ServiceHealth) SetServiceName(v string) *ServiceHealth { + s.ServiceName = &v + return s +} + +// Contains the number of open proactive and reactive insights in an analyzed +// AWS service. +type ServiceInsightHealth struct { + _ struct{} `type:"structure"` + + // The number of open proactive insights in the AWS service + OpenProactiveInsights *int64 `type:"integer"` + + // The number of open reactive insights in the AWS service + OpenReactiveInsights *int64 `type:"integer"` +} + +// String returns the string representation +func (s ServiceInsightHealth) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ServiceInsightHealth) GoString() string { + return s.String() +} + +// SetOpenProactiveInsights sets the OpenProactiveInsights field's value. +func (s *ServiceInsightHealth) SetOpenProactiveInsights(v int64) *ServiceInsightHealth { + s.OpenProactiveInsights = &v + return s +} + +// SetOpenReactiveInsights sets the OpenReactiveInsights field's value. +func (s *ServiceInsightHealth) SetOpenReactiveInsights(v int64) *ServiceInsightHealth { + s.OpenReactiveInsights = &v + return s +} + // Information about the integration of DevOps Guru with another AWS service, // such as AWS Systems Manager. type ServiceIntegrationConfig struct { @@ -6294,6 +6933,76 @@ func (s *ServiceQuotaExceededException) RequestID() string { return s.RespMetadata.RequestID } +// An object that contains information about the estimated monthly cost to analyze +// an AWS resource. For more information, see Estimate your Amazon DevOps Guru +// costs (https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html) +// and Amazon DevOps Guru pricing (http://aws.amazon.com/devops-guru/pricing/). +type ServiceResourceCost struct { + _ struct{} `type:"structure"` + + // The total estimated monthly cost to analyze the active resources for this + // resource. + Cost *float64 `type:"double"` + + // The number of active resources analyzed for this service to create a monthly + // cost estimate. + Count *int64 `type:"integer"` + + // The state of the resource. The resource is ACTIVE if it produces metrics, + // events, or logs within an hour, otherwise it is INACTIVE. You pay for the + // number of active AWS resource hours analyzed for each resource. Inactive + // resources are not charged. + State *string `type:"string" enum:"CostEstimationServiceResourceState"` + + // The type of the AWS resource. + Type *string `min:"1" type:"string"` + + // The price per hour to analyze the resources in the service. For more information, + // see Estimate your Amazon DevOps Guru costs (https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html) + // and Amazon DevOps Guru pricing (http://aws.amazon.com/devops-guru/pricing/). + UnitCost *float64 `type:"double"` +} + +// String returns the string representation +func (s ServiceResourceCost) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ServiceResourceCost) GoString() string { + return s.String() +} + +// SetCost sets the Cost field's value. +func (s *ServiceResourceCost) SetCost(v float64) *ServiceResourceCost { + s.Cost = &v + return s +} + +// SetCount sets the Count field's value. +func (s *ServiceResourceCost) SetCount(v int64) *ServiceResourceCost { + s.Count = &v + return s +} + +// SetState sets the State field's value. +func (s *ServiceResourceCost) SetState(v string) *ServiceResourceCost { + s.State = &v + return s +} + +// SetType sets the Type field's value. +func (s *ServiceResourceCost) SetType(v string) *ServiceResourceCost { + s.Type = &v + return s +} + +// SetUnitCost sets the UnitCost field's value. +func (s *ServiceResourceCost) SetUnitCost(v float64) *ServiceResourceCost { + s.UnitCost = &v + return s +} + // Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification // Service topic. // @@ -6343,6 +7052,76 @@ func (s *SnsChannelConfig) SetTopicArn(v string) *SnsChannelConfig { return s } +type StartCostEstimationInput struct { + _ struct{} `type:"structure"` + + // The idempotency token used to identify each cost estimate request. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // The collection of AWS resources used to create a monthly DevOps Guru cost + // estimate. + // + // ResourceCollection is a required field + ResourceCollection *CostEstimationResourceCollectionFilter `type:"structure" required:"true"` +} + +// String returns the string representation +func (s StartCostEstimationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartCostEstimationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartCostEstimationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartCostEstimationInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.ResourceCollection == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceCollection")) + } + if s.ResourceCollection != nil { + if err := s.ResourceCollection.Validate(); err != nil { + invalidParams.AddNested("ResourceCollection", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *StartCostEstimationInput) SetClientToken(v string) *StartCostEstimationInput { + s.ClientToken = &v + return s +} + +// SetResourceCollection sets the ResourceCollection field's value. +func (s *StartCostEstimationInput) SetResourceCollection(v *CostEstimationResourceCollectionFilter) *StartCostEstimationInput { + s.ResourceCollection = v + return s +} + +type StartCostEstimationOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s StartCostEstimationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartCostEstimationOutput) GoString() string { + return s.String() +} + // A time range used to specify when the behavior of an insight or anomaly started. type StartTimeRange struct { _ struct{} `type:"structure"` @@ -6443,11 +7222,12 @@ func (s *ThrottlingException) RequestID() string { } // Contains the names of AWS CloudFormation stacks used to update a collection -// of stacks. +// of stacks. You can specify up to 500 AWS CloudFormation stacks. type UpdateCloudFormationCollectionFilter struct { _ struct{} `type:"structure"` - // An array of the name of stacks to update. + // An array of the names of the AWS CloudFormation stacks to update. You can + // specify up to 500 AWS CloudFormation stacks. StackNames []*string `type:"list"` } @@ -6471,7 +7251,8 @@ func (s *UpdateCloudFormationCollectionFilter) SetStackNames(v []*string) *Updat type UpdateResourceCollectionFilter struct { _ struct{} `type:"structure"` - // An collection of AWS CloudFormation stacks. + // An collection of AWS CloudFormation stacks. You can specify up to 500 AWS + // CloudFormation stacks. CloudFormation *UpdateCloudFormationCollectionFilter `type:"structure"` } @@ -6815,6 +7596,38 @@ func CloudWatchMetricsStat_Values() []string { } } +const ( + // CostEstimationServiceResourceStateActive is a CostEstimationServiceResourceState enum value + CostEstimationServiceResourceStateActive = "ACTIVE" + + // CostEstimationServiceResourceStateInactive is a CostEstimationServiceResourceState enum value + CostEstimationServiceResourceStateInactive = "INACTIVE" +) + +// CostEstimationServiceResourceState_Values returns all elements of the CostEstimationServiceResourceState enum +func CostEstimationServiceResourceState_Values() []string { + return []string{ + CostEstimationServiceResourceStateActive, + CostEstimationServiceResourceStateInactive, + } +} + +const ( + // CostEstimationStatusOngoing is a CostEstimationStatus enum value + CostEstimationStatusOngoing = "ONGOING" + + // CostEstimationStatusCompleted is a CostEstimationStatus enum value + CostEstimationStatusCompleted = "COMPLETED" +) + +// CostEstimationStatus_Values returns all elements of the CostEstimationStatus enum +func CostEstimationStatus_Values() []string { + return []string{ + CostEstimationStatusOngoing, + CostEstimationStatusCompleted, + } +} + const ( // EventClassInfrastructure is a EventClass enum value EventClassInfrastructure = "INFRASTRUCTURE" @@ -6939,6 +7752,58 @@ func InsightType_Values() []string { } } +const ( + // LocaleDeDe is a Locale enum value + LocaleDeDe = "DE_DE" + + // LocaleEnUs is a Locale enum value + LocaleEnUs = "EN_US" + + // LocaleEnGb is a Locale enum value + LocaleEnGb = "EN_GB" + + // LocaleEsEs is a Locale enum value + LocaleEsEs = "ES_ES" + + // LocaleFrFr is a Locale enum value + LocaleFrFr = "FR_FR" + + // LocaleItIt is a Locale enum value + LocaleItIt = "IT_IT" + + // LocaleJaJp is a Locale enum value + LocaleJaJp = "JA_JP" + + // LocaleKoKr is a Locale enum value + LocaleKoKr = "KO_KR" + + // LocalePtBr is a Locale enum value + LocalePtBr = "PT_BR" + + // LocaleZhCn is a Locale enum value + LocaleZhCn = "ZH_CN" + + // LocaleZhTw is a Locale enum value + LocaleZhTw = "ZH_TW" +) + +// Locale_Values returns all elements of the Locale enum +func Locale_Values() []string { + return []string{ + LocaleDeDe, + LocaleEnUs, + LocaleEnGb, + LocaleEsEs, + LocaleFrFr, + LocaleItIt, + LocaleJaJp, + LocaleKoKr, + LocalePtBr, + LocaleZhCn, + LocaleZhTw, + } +} + // Specifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem // for each created insight. const ( @@ -6960,12 +7825,124 @@ func OptInStatus_Values() []string { const ( // ResourceCollectionTypeAwsCloudFormation is a ResourceCollectionType enum value ResourceCollectionTypeAwsCloudFormation = "AWS_CLOUD_FORMATION" + + // ResourceCollectionTypeAwsService is a ResourceCollectionType enum value + ResourceCollectionTypeAwsService = "AWS_SERVICE" ) // ResourceCollectionType_Values returns all elements of the ResourceCollectionType enum func ResourceCollectionType_Values() []string { return []string{ ResourceCollectionTypeAwsCloudFormation, + ResourceCollectionTypeAwsService, + } +} + +const ( + // ServiceNameApiGateway is a ServiceName enum value + ServiceNameApiGateway = "API_GATEWAY" + + // ServiceNameApplicationElb is a ServiceName enum value + ServiceNameApplicationElb = "APPLICATION_ELB" + + // ServiceNameAutoScalingGroup is a ServiceName enum value + ServiceNameAutoScalingGroup = "AUTO_SCALING_GROUP" + + // ServiceNameCloudFront is a ServiceName enum value + ServiceNameCloudFront = "CLOUD_FRONT" + + // ServiceNameDynamoDb is a ServiceName enum value + ServiceNameDynamoDb = "DYNAMO_DB" + + // ServiceNameEc2 is a ServiceName enum value + ServiceNameEc2 = "EC2" + + // ServiceNameEcs is a ServiceName enum value + ServiceNameEcs = "ECS" + + // ServiceNameEks is a ServiceName enum value + ServiceNameEks = "EKS" + + // ServiceNameElasticBeanstalk is a ServiceName enum value + ServiceNameElasticBeanstalk = "ELASTIC_BEANSTALK" + + // ServiceNameElastiCache is a ServiceName enum value + ServiceNameElastiCache = "ELASTI_CACHE" + + // ServiceNameElb is a ServiceName enum value + ServiceNameElb = "ELB" + + // ServiceNameEs is a ServiceName enum value + ServiceNameEs = "ES" + + // ServiceNameKinesis is a ServiceName enum value + ServiceNameKinesis = "KINESIS" + + // ServiceNameLambda is a ServiceName enum value + ServiceNameLambda = "LAMBDA" + + // ServiceNameNatGateway is a ServiceName enum value + ServiceNameNatGateway = "NAT_GATEWAY" + + // ServiceNameNetworkElb is a ServiceName enum value + ServiceNameNetworkElb = "NETWORK_ELB" + + // ServiceNameRds is a ServiceName enum value + ServiceNameRds = "RDS" + + // ServiceNameRedshift is a ServiceName enum value + ServiceNameRedshift = "REDSHIFT" + + // ServiceNameRoute53 is a ServiceName enum value + ServiceNameRoute53 = "ROUTE_53" + + // ServiceNameS3 is a ServiceName enum value + ServiceNameS3 = "S3" + + // ServiceNameSageMaker is a ServiceName enum value + ServiceNameSageMaker = "SAGE_MAKER" + + // ServiceNameSns is a ServiceName enum value + ServiceNameSns = "SNS" + + // ServiceNameSqs is a ServiceName enum value + ServiceNameSqs = "SQS" + + // ServiceNameStepFunctions is a ServiceName enum value + ServiceNameStepFunctions = "STEP_FUNCTIONS" + + // ServiceNameSwf is a ServiceName enum value + ServiceNameSwf = "SWF" +) + +// ServiceName_Values returns all elements of the ServiceName enum +func ServiceName_Values() []string { + return []string{ + ServiceNameApiGateway, + ServiceNameApplicationElb, + ServiceNameAutoScalingGroup, + ServiceNameCloudFront, + ServiceNameDynamoDb, + ServiceNameEc2, + ServiceNameEcs, + ServiceNameEks, + ServiceNameElasticBeanstalk, + ServiceNameElastiCache, + ServiceNameElb, + ServiceNameEs, + ServiceNameKinesis, + ServiceNameLambda, + ServiceNameNatGateway, + ServiceNameNetworkElb, + ServiceNameRds, + ServiceNameRedshift, + ServiceNameRoute53, + ServiceNameS3, + ServiceNameSageMaker, + ServiceNameSns, + ServiceNameSqs, + ServiceNameStepFunctions, + ServiceNameSwf, } } diff --git a/service/devopsguru/devopsguruiface/interface.go b/service/devopsguru/devopsguruiface/interface.go index d1b19cc070e..b96ee891e02 100644 --- a/service/devopsguru/devopsguruiface/interface.go +++ b/service/devopsguru/devopsguruiface/interface.go @@ -95,6 +95,13 @@ type DevOpsGuruAPI interface { DescribeServiceIntegrationWithContext(aws.Context, *devopsguru.DescribeServiceIntegrationInput, ...request.Option) (*devopsguru.DescribeServiceIntegrationOutput, error) DescribeServiceIntegrationRequest(*devopsguru.DescribeServiceIntegrationInput) (*request.Request, *devopsguru.DescribeServiceIntegrationOutput) + GetCostEstimation(*devopsguru.GetCostEstimationInput) (*devopsguru.GetCostEstimationOutput, error) + GetCostEstimationWithContext(aws.Context, *devopsguru.GetCostEstimationInput, ...request.Option) (*devopsguru.GetCostEstimationOutput, error) + GetCostEstimationRequest(*devopsguru.GetCostEstimationInput) (*request.Request, *devopsguru.GetCostEstimationOutput) + + GetCostEstimationPages(*devopsguru.GetCostEstimationInput, func(*devopsguru.GetCostEstimationOutput, bool) bool) error + GetCostEstimationPagesWithContext(aws.Context, *devopsguru.GetCostEstimationInput, func(*devopsguru.GetCostEstimationOutput, bool) bool, ...request.Option) error + GetResourceCollection(*devopsguru.GetResourceCollectionInput) (*devopsguru.GetResourceCollectionOutput, error) GetResourceCollectionWithContext(aws.Context, *devopsguru.GetResourceCollectionInput, ...request.Option) (*devopsguru.GetResourceCollectionOutput, error) GetResourceCollectionRequest(*devopsguru.GetResourceCollectionInput) (*request.Request, *devopsguru.GetResourceCollectionOutput) @@ -152,6 +159,10 @@ type DevOpsGuruAPI interface { SearchInsightsPages(*devopsguru.SearchInsightsInput, func(*devopsguru.SearchInsightsOutput, bool) bool) error SearchInsightsPagesWithContext(aws.Context, *devopsguru.SearchInsightsInput, func(*devopsguru.SearchInsightsOutput, bool) bool, ...request.Option) error + StartCostEstimation(*devopsguru.StartCostEstimationInput) (*devopsguru.StartCostEstimationOutput, error) + StartCostEstimationWithContext(aws.Context, *devopsguru.StartCostEstimationInput, ...request.Option) (*devopsguru.StartCostEstimationOutput, error) + StartCostEstimationRequest(*devopsguru.StartCostEstimationInput) (*request.Request, *devopsguru.StartCostEstimationOutput) + UpdateResourceCollection(*devopsguru.UpdateResourceCollectionInput) (*devopsguru.UpdateResourceCollectionOutput, error) UpdateResourceCollectionWithContext(aws.Context, *devopsguru.UpdateResourceCollectionInput, ...request.Option) (*devopsguru.UpdateResourceCollectionOutput, error) UpdateResourceCollectionRequest(*devopsguru.UpdateResourceCollectionInput) (*request.Request, *devopsguru.UpdateResourceCollectionOutput) diff --git a/service/health/api.go b/service/health/api.go index 7d720a222c8..d596322430f 100644 --- a/service/health/api.go +++ b/service/health/api.go @@ -744,10 +744,10 @@ func (c *Health) DescribeEventDetailsRequest(input *DescribeEventDetailsInput) ( // by DescribeEvents (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html)), // a detailed event description, and possible additional metadata that depends // upon the nature of the event. Affected entities are not included. To retrieve -// those, use the DescribeAffectedEntities (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html) +// the entities, use the DescribeAffectedEntities (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html) // operation. // -// If a specified event cannot be retrieved, an error message is returned for +// If a specified event can't be retrieved, an error message is returned for // that event. // // This operation supports resource-level permissions. You can use this operation @@ -833,12 +833,11 @@ func (c *Health) DescribeEventDetailsForOrganizationRequest(input *DescribeEvent // DescribeEventDetailsForOrganization API operation for AWS Health APIs and Notifications. // // Returns detailed information about one or more specified events for one or -// more accounts in your organization. Information includes standard event data -// (AWS Region, service, and so on, as returned by DescribeEventsForOrganization -// (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html)), -// a detailed event description, and possible additional metadata that depends -// upon the nature of the event. Affected entities are not included; to retrieve -// those, use the DescribeAffectedEntitiesForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html) +// more AWS accounts in your organization. This information includes standard +// event data (such as the AWS Region and service), an event description, and +// (depending on the event) possible metadata. This operation doesn't return +// affected entities, such as the resources related to the event. To return +// affected entities, use the DescribeAffectedEntitiesForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html) // operation. // // Before you can call this operation, you must first enable AWS Health to work @@ -846,19 +845,19 @@ func (c *Health) DescribeEventDetailsForOrganizationRequest(input *DescribeEvent // (https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html) // operation from your organization's management account. // -// When you call the DescribeEventDetailsForOrganization operation, you specify +// When you call the DescribeEventDetailsForOrganization operation, specify // the organizationEventDetailFilters object in the request. Depending on the // AWS Health event type, note the following differences: // -// * If the event is public, the awsAccountId parameter must be empty. If -// you specify an account ID for a public event, then an error message is -// returned. That's because the event might apply to all AWS accounts and -// isn't specific to an account in your organization. +// * To return event details for a public event, you must specify a null +// value for the awsAccountId parameter. If you specify an account ID for +// a public event, AWS Health returns an error message because public events +// aren't specific to an account. // -// * If the event is specific to an account, then you must specify the awsAccountId -// parameter in the request. If you don't specify an account ID, an error -// message returns because the event is specific to an AWS account in your -// organization. +// * To return event details for an event that is specific to an account +// in your organization, you must specify the awsAccountId parameter in the +// request. If you don't specify an account ID, AWS Health returns an error +// message because the event is specific to an account in your organization. // // For more information, see Event (https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html). // @@ -1608,10 +1607,10 @@ func (c *Health) EnableHealthServiceAccessForOrganizationRequest(input *EnableHe // // To call this operation, you must meet the following requirements: // -// * You must have a Business or Enterprise support plan from AWS Support +// * You must have a Business or Enterprise Support plan from AWS Support // (http://aws.amazon.com/premiumsupport/) to use the AWS Health API. If // you call the AWS Health API from an AWS account that doesn't have a Business -// or Enterprise support plan, you receive a SubscriptionRequiredException +// or Enterprise Support plan, you receive a SubscriptionRequiredException // error. // // * You must have permission to call this operation from the organization's @@ -1677,8 +1676,12 @@ type AffectedEntity struct { // The ID of the affected entity. EntityValue *string `locationName:"entityValue" type:"string"` - // The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 EventArn *string `locationName:"eventArn" type:"string"` // The most recent time that the entity was updated. @@ -1854,8 +1857,12 @@ func (s *DateTimeRange) SetTo(v time.Time) *DateTimeRange { type DescribeAffectedAccountsForOrganizationInput struct { _ struct{} `type:"structure"` - // The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 // // EventArn is a required field EventArn *string `locationName:"eventArn" type:"string" required:"true"` @@ -3047,8 +3054,12 @@ type EntityAggregate struct { // The number of entities that match the criteria for the specified events. Count *int64 `locationName:"count" type:"integer"` - // The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 EventArn *string `locationName:"eventArn" type:"string"` } @@ -3196,8 +3207,12 @@ func (s *EntityFilter) SetTags(v []map[string]*string) *EntityFilter { type Event struct { _ struct{} `type:"structure"` - // The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 Arn *string `locationName:"arn" type:"string"` // The AWS Availability Zone of the event. For example, us-east-1a. @@ -3233,7 +3248,7 @@ type Event struct { // The most recent date and time that the event was updated. LastUpdatedTime *time.Time `locationName:"lastUpdatedTime" type:"timestamp"` - // The AWS region name of the event. + // The AWS Region name of the event. Region *string `locationName:"region" min:"2" type:"string"` // The AWS service that is affected by the event. For example, EC2, RDS. @@ -3333,8 +3348,12 @@ type EventAccountFilter struct { // The 12-digit AWS account numbers that contains the affected entities. AwsAccountId *string `locationName:"awsAccountId" type:"string"` - // The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 // // EventArn is a required field EventArn *string `locationName:"eventArn" type:"string" required:"true"` @@ -3483,7 +3502,7 @@ func (s *EventDetails) SetEventMetadata(v map[string]*string) *EventDetails { } // Error information returned when a DescribeEventDetails (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetails.html) -// operation cannot find a specified event. +// operation can't find a specified event. type EventDetailsErrorItem struct { _ struct{} `type:"structure"` @@ -3493,8 +3512,12 @@ type EventDetailsErrorItem struct { // The name of the error. ErrorName *string `locationName:"errorName" type:"string"` - // The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 EventArn *string `locationName:"eventArn" type:"string"` } @@ -3532,7 +3555,7 @@ func (s *EventDetailsErrorItem) SetEventArn(v string) *EventDetailsErrorItem { type EventFilter struct { _ struct{} `type:"structure"` - // A list of AWS availability zones. + // A list of AWS Availability Zones. AvailabilityZones []*string `locationName:"availabilityZones" type:"list"` // A list of dates and times that the event ended. @@ -3561,7 +3584,7 @@ type EventFilter struct { // A list of dates and times that the event was last updated. LastUpdatedTimes []*DateTimeRange `locationName:"lastUpdatedTimes" min:"1" type:"list"` - // A list of AWS regions. + // A list of AWS Regions. Regions []*string `locationName:"regions" min:"1" type:"list"` // The AWS services associated with the event. For example, EC2, RDS. @@ -3882,7 +3905,7 @@ func (s *InvalidPaginationToken) RequestID() string { // Error information returned when a DescribeAffectedEntitiesForOrganization // (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html) -// operation cannot find or process a specific entity. +// operation can't find or process a specific entity. type OrganizationAffectedEntitiesErrorItem struct { _ struct{} `type:"structure"` @@ -3896,8 +3919,12 @@ type OrganizationAffectedEntitiesErrorItem struct { // The name of the error. ErrorName *string `locationName:"errorName" type:"string"` - // The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 EventArn *string `locationName:"eventArn" type:"string"` } @@ -3941,8 +3968,12 @@ func (s *OrganizationAffectedEntitiesErrorItem) SetEventArn(v string) *Organizat type OrganizationEvent struct { _ struct{} `type:"structure"` - // The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 Arn *string `locationName:"arn" type:"string"` // The date and time that the event ended. @@ -3977,7 +4008,7 @@ type OrganizationEvent struct { // The AWS Region name of the event. Region *string `locationName:"region" min:"2" type:"string"` - // The AWS service that is affected by the event. For example, EC2, RDS. + // The AWS service that is affected by the event, such as EC2 and RDS. Service *string `locationName:"service" min:"2" type:"string"` // The date and time that the event began. @@ -4131,22 +4162,41 @@ func (s *OrganizationEventDetails) SetEventMetadata(v map[string]*string) *Organ } // Error information returned when a DescribeEventDetailsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) -// operation cannot find a specified event. +// operation can't find a specified event. type OrganizationEventDetailsErrorItem struct { _ struct{} `type:"structure"` // Error information returned when a DescribeEventDetailsForOrganization (https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html) - // operation cannot find a specified event. + // operation can't find a specified event. AwsAccountId *string `locationName:"awsAccountId" type:"string"` // A message that describes the error. + // + // If you call the DescribeEventDetailsForOrganization operation and receive + // one of the following errors, follow the recommendations in the message: + // + // * We couldn't find a public event that matches your request. To find an + // event that is account specific, you must enter an AWS account ID in the + // request. + // + // * We couldn't find an account specific event for the specified AWS account. + // To find an event that is public, you must enter a null value for the AWS + // account ID in the request. + // + // * Your AWS account doesn't include the AWS Support plan required to use + // the AWS Health API. You must have either a Business or Enterprise Support + // plan. ErrorMessage *string `locationName:"errorMessage" type:"string"` // The name of the error. ErrorName *string `locationName:"errorName" type:"string"` - // The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID - // . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 + // The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID + // format. + // + // For example, an event ARN might look like the following: + // + // arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 EventArn *string `locationName:"eventArn" type:"string"` } diff --git a/service/health/doc.go b/service/health/doc.go index ded0c959569..b9ad7e966dd 100644 --- a/service/health/doc.go +++ b/service/health/doc.go @@ -8,13 +8,19 @@ // You can use the API operations to get information about AWS Health events // that affect your AWS services and resources. // -// You must have a Business or Enterprise support plan from AWS Support (http://aws.amazon.com/premiumsupport/) -// to use the AWS Health API. If you call the AWS Health API from an AWS account -// that doesn't have a Business or Enterprise support plan, you receive a SubscriptionRequiredException -// error. +// * You must have a Business or Enterprise Support plan from AWS Support +// (http://aws.amazon.com/premiumsupport/) to use the AWS Health API. If +// you call the AWS Health API from an AWS account that doesn't have a Business +// or Enterprise Support plan, you receive a SubscriptionRequiredException +// error. // -// AWS Health has a single endpoint: health.us-east-1.amazonaws.com (HTTPS). -// Use this endpoint to call the AWS Health API operations. +// * You can use the AWS Health endpoint health.us-east-1.amazonaws.com (HTTPS) +// to call the AWS Health API operations. AWS Health supports a multi-Region +// application architecture and has two regional endpoints in an active-passive +// configuration. You can use the high availability endpoint example to determine +// which AWS Region is active, so that you can get the latest information +// from the API. For more information, see Accessing the AWS Health API (https://docs.aws.amazon.com/health/latest/ug/health-api.html) +// in the AWS Health User Guide. // // For authentication of requests, AWS Health uses the Signature Version 4 Signing // Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). diff --git a/service/sagemaker/api.go b/service/sagemaker/api.go index ea0be74db40..97509a335e0 100644 --- a/service/sagemaker/api.go +++ b/service/sagemaker/api.go @@ -71,7 +71,7 @@ func (c *SageMaker) AddAssociationRequest(input *AddAssociationInput) (req *requ // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might @@ -245,7 +245,7 @@ func (c *SageMaker) AssociateTrialComponentRequest(input *AssociateTrialComponen // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might @@ -322,6 +322,11 @@ func (c *SageMaker) CreateActionRequest(input *CreateActionInput) (req *request. // an action involves at least one input or output artifact. For more information, // see Amazon SageMaker ML Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html). // +// CreateAction can only be invoked from within an SageMaker managed environment. +// This includes SageMaker training jobs, processing jobs, transform jobs, and +// SageMaker notebooks. A call to CreateAction from outside one of these environments +// results in an error. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -493,7 +498,7 @@ func (c *SageMaker) CreateAppRequest(input *CreateAppInput) (req *request.Reques // have too many training jobs created. // // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateApp func (c *SageMaker) CreateApp(input *CreateAppInput) (*CreateAppOutput, error) { @@ -574,7 +579,7 @@ func (c *SageMaker) CreateAppImageConfigRequest(input *CreateAppImageConfigInput // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateAppImageConfig func (c *SageMaker) CreateAppImageConfig(input *CreateAppImageConfigInput) (*CreateAppImageConfigOutput, error) { @@ -647,6 +652,11 @@ func (c *SageMaker) CreateArtifactRequest(input *CreateArtifactInput) (req *requ // and the ECR registry path of an image. For more information, see Amazon SageMaker // ML Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html). // +// CreateArtifact can only be invoked from within an SageMaker managed environment. +// This includes SageMaker training jobs, processing jobs, transform jobs, and +// SageMaker notebooks. A call to CreateArtifact from outside one of these environments +// results in an error. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -741,7 +751,7 @@ func (c *SageMaker) CreateAutoMLJobRequest(input *CreateAutoMLJobInput) (req *re // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might @@ -933,7 +943,7 @@ func (c *SageMaker) CreateCompilationJobRequest(input *CreateCompilationJobInput // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might @@ -1010,6 +1020,11 @@ func (c *SageMaker) CreateContextRequest(input *CreateContextInput) (req *reques // are an endpoint and a model package. For more information, see Amazon SageMaker // ML Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html). // +// CreateContext can only be invoked from within an SageMaker managed environment. +// This includes SageMaker training jobs, processing jobs, transform jobs, and +// SageMaker notebooks. A call to CreateContext from outside one of these environments +// results in an error. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1104,7 +1119,7 @@ func (c *SageMaker) CreateDataQualityJobDefinitionRequest(input *CreateDataQuali // have too many training jobs created. // // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateDataQualityJobDefinition func (c *SageMaker) CreateDataQualityJobDefinition(input *CreateDataQualityJobDefinitionInput) (*CreateDataQualityJobDefinitionOutput, error) { @@ -1184,7 +1199,7 @@ func (c *SageMaker) CreateDeviceFleetRequest(input *CreateDeviceFleetInput) (req // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might @@ -1308,7 +1323,7 @@ func (c *SageMaker) CreateDomainRequest(input *CreateDomainInput) (req *request. // have too many training jobs created. // // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateDomain func (c *SageMaker) CreateDomain(input *CreateDomainInput) (*CreateDomainOutput, error) { @@ -1718,10 +1733,10 @@ func (c *SageMaker) CreateExperimentRequest(input *CreateExperimentInput) (req * // the impact of a change to one or more inputs, while keeping the remaining // inputs constant. // -// When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, -// all experiments, trials, and trial components are automatically tracked, -// logged, and indexed. When you use the AWS SDK for Python (Boto), you must -// use the logging APIs provided by the SDK. +// When you use SageMaker Studio or the SageMaker Python SDK, all experiments, +// trials, and trial components are automatically tracked, logged, and indexed. +// When you use the AWS SDK for Python (Boto), you must use the logging APIs +// provided by the SDK. // // You can add tags to experiments, trials, trial components and then use the // Search API to search for the tags. @@ -1834,7 +1849,7 @@ func (c *SageMaker) CreateFeatureGroupRequest(input *CreateFeatureGroupInput) (r // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might @@ -1921,7 +1936,7 @@ func (c *SageMaker) CreateFlowDefinitionRequest(input *CreateFlowDefinitionInput // have too many training jobs created. // // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateFlowDefinition func (c *SageMaker) CreateFlowDefinition(input *CreateFlowDefinitionInput) (*CreateFlowDefinitionOutput, error) { @@ -2006,7 +2021,7 @@ func (c *SageMaker) CreateHumanTaskUiRequest(input *CreateHumanTaskUiInput) (req // have too many training jobs created. // // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateHumanTaskUi func (c *SageMaker) CreateHumanTaskUi(input *CreateHumanTaskUiInput) (*CreateHumanTaskUiOutput, error) { @@ -2089,7 +2104,7 @@ func (c *SageMaker) CreateHyperParameterTuningJobRequest(input *CreateHyperParam // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might @@ -2175,7 +2190,7 @@ func (c *SageMaker) CreateImageRequest(input *CreateImageInput) (req *request.Re // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might @@ -2260,14 +2275,14 @@ func (c *SageMaker) CreateImageVersionRequest(input *CreateImageVersionInput) (r // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might // have too many training jobs created. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateImageVersion func (c *SageMaker) CreateImageVersion(input *CreateImageVersionInput) (*CreateImageVersionOutput, error) { @@ -2383,7 +2398,7 @@ func (c *SageMaker) CreateLabelingJobRequest(input *CreateLabelingJobInput) (req // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might @@ -2580,7 +2595,7 @@ func (c *SageMaker) CreateModelBiasJobDefinitionRequest(input *CreateModelBiasJo // have too many training jobs created. // // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateModelBiasJobDefinition func (c *SageMaker) CreateModelBiasJobDefinition(input *CreateModelBiasJobDefinitionInput) (*CreateModelBiasJobDefinitionOutput, error) { @@ -2663,7 +2678,7 @@ func (c *SageMaker) CreateModelExplainabilityJobDefinitionRequest(input *CreateM // have too many training jobs created. // // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateModelExplainabilityJobDefinition func (c *SageMaker) CreateModelExplainabilityJobDefinition(input *CreateModelExplainabilityJobDefinitionInput) (*CreateModelExplainabilityJobDefinitionOutput, error) { @@ -2757,8 +2772,8 @@ func (c *SageMaker) CreateModelPackageRequest(input *CreateModelPackageInput) (r // // Returned Error Types: // * ConflictException -// There was a conflict when you attempted to modify an experiment, trial, or -// trial component. +// There was a conflict when you attempted to modify a SageMaker entity such +// as an Experiment or Artifact. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might @@ -2926,7 +2941,7 @@ func (c *SageMaker) CreateModelQualityJobDefinitionRequest(input *CreateModelQua // have too many training jobs created. // // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateModelQualityJobDefinition func (c *SageMaker) CreateModelQualityJobDefinition(input *CreateModelQualityJobDefinitionInput) (*CreateModelQualityJobDefinitionOutput, error) { @@ -3010,7 +3025,7 @@ func (c *SageMaker) CreateMonitoringScheduleRequest(input *CreateMonitoringSched // have too many training jobs created. // // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateMonitoringSchedule func (c *SageMaker) CreateMonitoringSchedule(input *CreateMonitoringScheduleInput) (*CreateMonitoringScheduleOutput, error) { @@ -3303,7 +3318,7 @@ func (c *SageMaker) CreatePipelineRequest(input *CreatePipelineInput) (req *requ // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might @@ -3395,7 +3410,7 @@ func (c *SageMaker) CreatePresignedDomainUrlRequest(input *CreatePresignedDomain // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreatePresignedDomainUrl func (c *SageMaker) CreatePresignedDomainUrl(input *CreatePresignedDomainUrlInput) (*CreatePresignedDomainUrlOutput, error) { @@ -3568,14 +3583,14 @@ func (c *SageMaker) CreateProcessingJobRequest(input *CreateProcessingJobInput) // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might // have too many training jobs created. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateProcessingJob func (c *SageMaker) CreateProcessingJob(input *CreateProcessingJobInput) (*CreateProcessingJobOutput, error) { @@ -3763,10 +3778,13 @@ func (c *SageMaker) CreateTrainingJobRequest(input *CreateTrainingJobInput) (req // // * StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds // to set a time limit for training. Use MaxWaitTimeInSeconds to specify -// how long you are willing to wait for a managed spot training job to complete. +// how long a managed spot training job has to complete. // // * Environment - The environment variables to set in the Docker container. // +// * RetryStrategy - The number of times to retry the job when the job fails +// due to an InternalServerError. +// // For more information about Amazon SageMaker, see How It Works (https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -3778,14 +3796,14 @@ func (c *SageMaker) CreateTrainingJobRequest(input *CreateTrainingJobInput) (req // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might // have too many training jobs created. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateTrainingJob func (c *SageMaker) CreateTrainingJob(input *CreateTrainingJobInput) (*CreateTrainingJobOutput, error) { @@ -3889,14 +3907,14 @@ func (c *SageMaker) CreateTransformJobRequest(input *CreateTransformJobInput) (r // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might // have too many training jobs created. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateTransformJob func (c *SageMaker) CreateTransformJob(input *CreateTransformJobInput) (*CreateTransformJobOutput, error) { @@ -3964,14 +3982,14 @@ func (c *SageMaker) CreateTrialRequest(input *CreateTrialInput) (req *request.Re // CreateTrial API operation for Amazon SageMaker Service. // -// Creates an Amazon SageMaker trial. A trial is a set of steps called trial -// components that produce a machine learning model. A trial is part of a single -// Amazon SageMaker experiment. +// Creates an SageMaker trial. A trial is a set of steps called trial components +// that produce a machine learning model. A trial is part of a single SageMaker +// experiment. // -// When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, -// all experiments, trials, and trial components are automatically tracked, -// logged, and indexed. When you use the AWS SDK for Python (Boto), you must -// use the logging APIs provided by the SDK. +// When you use SageMaker Studio or the SageMaker Python SDK, all experiments, +// trials, and trial components are automatically tracked, logged, and indexed. +// When you use the AWS SDK for Python (Boto), you must use the logging APIs +// provided by the SDK. // // You can add tags to a trial and then use the Search API to search for the // tags. @@ -3989,7 +4007,7 @@ func (c *SageMaker) CreateTrialRequest(input *CreateTrialInput) (req *request.Re // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might @@ -4068,18 +4086,18 @@ func (c *SageMaker) CreateTrialComponentRequest(input *CreateTrialComponentInput // Trial components include pre-processing jobs, training jobs, and batch transform // jobs. // -// When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, -// all experiments, trials, and trial components are automatically tracked, -// logged, and indexed. When you use the AWS SDK for Python (Boto), you must -// use the logging APIs provided by the SDK. +// When you use SageMaker Studio or the SageMaker Python SDK, all experiments, +// trials, and trial components are automatically tracked, logged, and indexed. +// When you use the AWS SDK for Python (Boto), you must use the logging APIs +// provided by the SDK. // // You can add tags to a trial component and then use the Search API to search // for the tags. // -// CreateTrialComponent can only be invoked from within an Amazon SageMaker -// managed environment. This includes Amazon SageMaker training jobs, processing -// jobs, transform jobs, and Amazon SageMaker notebooks. A call to CreateTrialComponent -// from outside one of these environments results in an error. +// CreateTrialComponent can only be invoked from within an SageMaker managed +// environment. This includes SageMaker training jobs, processing jobs, transform +// jobs, and SageMaker notebooks. A call to CreateTrialComponent from outside +// one of these environments results in an error. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4181,7 +4199,7 @@ func (c *SageMaker) CreateUserProfileRequest(input *CreateUserProfileInput) (req // have too many training jobs created. // // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateUserProfile func (c *SageMaker) CreateUserProfile(input *CreateUserProfileInput) (*CreateUserProfileOutput, error) { @@ -4354,7 +4372,7 @@ func (c *SageMaker) CreateWorkteamRequest(input *CreateWorkteamInput) (req *requ // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might @@ -4437,7 +4455,7 @@ func (c *SageMaker) DeleteActionRequest(input *DeleteActionInput) (req *request. // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteAction func (c *SageMaker) DeleteAction(input *DeleteActionInput) (*DeleteActionOutput, error) { @@ -4592,10 +4610,10 @@ func (c *SageMaker) DeleteAppRequest(input *DeleteAppInput) (req *request.Reques // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteApp func (c *SageMaker) DeleteApp(input *DeleteAppInput) (*DeleteAppOutput, error) { @@ -4675,7 +4693,7 @@ func (c *SageMaker) DeleteAppImageConfigRequest(input *DeleteAppImageConfigInput // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteAppImageConfig func (c *SageMaker) DeleteAppImageConfig(input *DeleteAppImageConfigInput) (*DeleteAppImageConfigOutput, error) { @@ -4754,7 +4772,7 @@ func (c *SageMaker) DeleteArtifactRequest(input *DeleteArtifactInput) (req *requ // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteArtifact func (c *SageMaker) DeleteArtifact(input *DeleteArtifactInput) (*DeleteArtifactOutput, error) { @@ -4833,7 +4851,7 @@ func (c *SageMaker) DeleteAssociationRequest(input *DeleteAssociationInput) (req // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteAssociation func (c *SageMaker) DeleteAssociation(input *DeleteAssociationInput) (*DeleteAssociationOutput, error) { @@ -4987,7 +5005,7 @@ func (c *SageMaker) DeleteContextRequest(input *DeleteContextInput) (req *reques // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteContext func (c *SageMaker) DeleteContext(input *DeleteContextInput) (*DeleteContextOutput, error) { @@ -5067,7 +5085,7 @@ func (c *SageMaker) DeleteDataQualityJobDefinitionRequest(input *DeleteDataQuali // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteDataQualityJobDefinition func (c *SageMaker) DeleteDataQualityJobDefinition(input *DeleteDataQualityJobDefinitionInput) (*DeleteDataQualityJobDefinitionOutput, error) { @@ -5147,7 +5165,7 @@ func (c *SageMaker) DeleteDeviceFleetRequest(input *DeleteDeviceFleetInput) (req // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteDeviceFleet func (c *SageMaker) DeleteDeviceFleet(input *DeleteDeviceFleetInput) (*DeleteDeviceFleetOutput, error) { @@ -5230,10 +5248,10 @@ func (c *SageMaker) DeleteDomainRequest(input *DeleteDomainInput) (req *request. // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteDomain func (c *SageMaker) DeleteDomain(input *DeleteDomainInput) (*DeleteDomainOutput, error) { @@ -5465,7 +5483,7 @@ func (c *SageMaker) DeleteExperimentRequest(input *DeleteExperimentInput) (req * // DeleteExperiment API operation for Amazon SageMaker Service. // -// Deletes an Amazon SageMaker experiment. All trials associated with the experiment +// Deletes an SageMaker experiment. All trials associated with the experiment // must be deleted first. Use the ListTrials API to get a list of the trials // associated with the experiment. // @@ -5478,7 +5496,7 @@ func (c *SageMaker) DeleteExperimentRequest(input *DeleteExperimentInput) (req * // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteExperiment func (c *SageMaker) DeleteExperiment(input *DeleteExperimentInput) (*DeleteExperimentOutput, error) { @@ -5563,7 +5581,7 @@ func (c *SageMaker) DeleteFeatureGroupRequest(input *DeleteFeatureGroupInput) (r // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteFeatureGroup func (c *SageMaker) DeleteFeatureGroup(input *DeleteFeatureGroupInput) (*DeleteFeatureGroupOutput, error) { @@ -5643,10 +5661,10 @@ func (c *SageMaker) DeleteFlowDefinitionRequest(input *DeleteFlowDefinitionInput // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteFlowDefinition func (c *SageMaker) DeleteFlowDefinition(input *DeleteFlowDefinitionInput) (*DeleteFlowDefinitionOutput, error) { @@ -5730,7 +5748,7 @@ func (c *SageMaker) DeleteHumanTaskUiRequest(input *DeleteHumanTaskUiInput) (req // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteHumanTaskUi func (c *SageMaker) DeleteHumanTaskUi(input *DeleteHumanTaskUiInput) (*DeleteHumanTaskUiOutput, error) { @@ -5811,10 +5829,10 @@ func (c *SageMaker) DeleteImageRequest(input *DeleteImageInput) (req *request.Re // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteImage func (c *SageMaker) DeleteImage(input *DeleteImageInput) (*DeleteImageOutput, error) { @@ -5895,10 +5913,10 @@ func (c *SageMaker) DeleteImageVersionRequest(input *DeleteImageVersionInput) (r // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteImageVersion func (c *SageMaker) DeleteImageVersion(input *DeleteImageVersionInput) (*DeleteImageVersionOutput, error) { @@ -6056,7 +6074,7 @@ func (c *SageMaker) DeleteModelBiasJobDefinitionRequest(input *DeleteModelBiasJo // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteModelBiasJobDefinition func (c *SageMaker) DeleteModelBiasJobDefinition(input *DeleteModelBiasJobDefinitionInput) (*DeleteModelBiasJobDefinitionOutput, error) { @@ -6136,7 +6154,7 @@ func (c *SageMaker) DeleteModelExplainabilityJobDefinitionRequest(input *DeleteM // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteModelExplainabilityJobDefinition func (c *SageMaker) DeleteModelExplainabilityJobDefinition(input *DeleteModelExplainabilityJobDefinitionInput) (*DeleteModelExplainabilityJobDefinitionOutput, error) { @@ -6220,8 +6238,8 @@ func (c *SageMaker) DeleteModelPackageRequest(input *DeleteModelPackageInput) (r // // Returned Error Types: // * ConflictException -// There was a conflict when you attempted to modify an experiment, trial, or -// trial component. +// There was a conflict when you attempted to modify a SageMaker entity such +// as an Experiment or Artifact. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteModelPackage func (c *SageMaker) DeleteModelPackage(input *DeleteModelPackageInput) (*DeleteModelPackageOutput, error) { @@ -6451,7 +6469,7 @@ func (c *SageMaker) DeleteModelQualityJobDefinitionRequest(input *DeleteModelQua // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteModelQualityJobDefinition func (c *SageMaker) DeleteModelQualityJobDefinition(input *DeleteModelQualityJobDefinitionInput) (*DeleteModelQualityJobDefinitionOutput, error) { @@ -6533,7 +6551,7 @@ func (c *SageMaker) DeleteMonitoringScheduleRequest(input *DeleteMonitoringSched // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteMonitoringSchedule func (c *SageMaker) DeleteMonitoringSchedule(input *DeleteMonitoringScheduleInput) (*DeleteMonitoringScheduleOutput, error) { @@ -6756,7 +6774,10 @@ func (c *SageMaker) DeletePipelineRequest(input *DeletePipelineInput) (req *requ // DeletePipeline API operation for Amazon SageMaker Service. // -// Deletes a pipeline if there are no in-progress executions. +// Deletes a pipeline if there are no running instances of the pipeline. To +// delete a pipeline, you must stop all running instances of the pipeline using +// the StopPipelineExecution API. When you delete a pipeline, all instances +// of the pipeline are deleted. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6767,7 +6788,7 @@ func (c *SageMaker) DeletePipelineRequest(input *DeletePipelineInput) (req *requ // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeletePipeline func (c *SageMaker) DeletePipeline(input *DeletePipelineInput) (*DeletePipelineOutput, error) { @@ -7004,7 +7025,7 @@ func (c *SageMaker) DeleteTrialRequest(input *DeleteTrialInput) (req *request.Re // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteTrial func (c *SageMaker) DeleteTrial(input *DeleteTrialInput) (*DeleteTrialOutput, error) { @@ -7085,7 +7106,7 @@ func (c *SageMaker) DeleteTrialComponentRequest(input *DeleteTrialComponentInput // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteTrialComponent func (c *SageMaker) DeleteTrialComponent(input *DeleteTrialComponentInput) (*DeleteTrialComponentOutput, error) { @@ -7166,10 +7187,10 @@ func (c *SageMaker) DeleteUserProfileRequest(input *DeleteUserProfileInput) (req // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteUserProfile func (c *SageMaker) DeleteUserProfile(input *DeleteUserProfileInput) (*DeleteUserProfileOutput, error) { @@ -7488,7 +7509,7 @@ func (c *SageMaker) DescribeActionRequest(input *DescribeActionInput) (req *requ // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeAction func (c *SageMaker) DescribeAction(input *DescribeActionInput) (*DescribeActionOutput, error) { @@ -7641,7 +7662,7 @@ func (c *SageMaker) DescribeAppRequest(input *DescribeAppInput) (req *request.Re // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeApp func (c *SageMaker) DescribeApp(input *DescribeAppInput) (*DescribeAppOutput, error) { @@ -7720,7 +7741,7 @@ func (c *SageMaker) DescribeAppImageConfigRequest(input *DescribeAppImageConfigI // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeAppImageConfig func (c *SageMaker) DescribeAppImageConfig(input *DescribeAppImageConfigInput) (*DescribeAppImageConfigOutput, error) { @@ -7799,7 +7820,7 @@ func (c *SageMaker) DescribeArtifactRequest(input *DescribeArtifactInput) (req * // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeArtifact func (c *SageMaker) DescribeArtifact(input *DescribeArtifactInput) (*DescribeArtifactOutput, error) { @@ -7878,7 +7899,7 @@ func (c *SageMaker) DescribeAutoMLJobRequest(input *DescribeAutoMLJobInput) (req // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeAutoMLJob func (c *SageMaker) DescribeAutoMLJob(input *DescribeAutoMLJobInput) (*DescribeAutoMLJobOutput, error) { @@ -8034,7 +8055,7 @@ func (c *SageMaker) DescribeCompilationJobRequest(input *DescribeCompilationJobI // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeCompilationJob func (c *SageMaker) DescribeCompilationJob(input *DescribeCompilationJobInput) (*DescribeCompilationJobOutput, error) { @@ -8113,7 +8134,7 @@ func (c *SageMaker) DescribeContextRequest(input *DescribeContextInput) (req *re // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeContext func (c *SageMaker) DescribeContext(input *DescribeContextInput) (*DescribeContextOutput, error) { @@ -8192,7 +8213,7 @@ func (c *SageMaker) DescribeDataQualityJobDefinitionRequest(input *DescribeDataQ // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeDataQualityJobDefinition func (c *SageMaker) DescribeDataQualityJobDefinition(input *DescribeDataQualityJobDefinitionInput) (*DescribeDataQualityJobDefinitionOutput, error) { @@ -8271,7 +8292,7 @@ func (c *SageMaker) DescribeDeviceRequest(input *DescribeDeviceInput) (req *requ // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeDevice func (c *SageMaker) DescribeDevice(input *DescribeDeviceInput) (*DescribeDeviceOutput, error) { @@ -8350,7 +8371,7 @@ func (c *SageMaker) DescribeDeviceFleetRequest(input *DescribeDeviceFleetInput) // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeDeviceFleet func (c *SageMaker) DescribeDeviceFleet(input *DescribeDeviceFleetInput) (*DescribeDeviceFleetOutput, error) { @@ -8429,7 +8450,7 @@ func (c *SageMaker) DescribeDomainRequest(input *DescribeDomainInput) (req *requ // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeDomain func (c *SageMaker) DescribeDomain(input *DescribeDomainInput) (*DescribeDomainOutput, error) { @@ -8508,7 +8529,7 @@ func (c *SageMaker) DescribeEdgePackagingJobRequest(input *DescribeEdgePackaging // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeEdgePackagingJob func (c *SageMaker) DescribeEdgePackagingJob(input *DescribeEdgePackagingJobInput) (*DescribeEdgePackagingJobOutput, error) { @@ -8736,7 +8757,7 @@ func (c *SageMaker) DescribeExperimentRequest(input *DescribeExperimentInput) (r // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeExperiment func (c *SageMaker) DescribeExperiment(input *DescribeExperimentInput) (*DescribeExperimentOutput, error) { @@ -8817,7 +8838,7 @@ func (c *SageMaker) DescribeFeatureGroupRequest(input *DescribeFeatureGroupInput // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeFeatureGroup func (c *SageMaker) DescribeFeatureGroup(input *DescribeFeatureGroupInput) (*DescribeFeatureGroupOutput, error) { @@ -8896,7 +8917,7 @@ func (c *SageMaker) DescribeFlowDefinitionRequest(input *DescribeFlowDefinitionI // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeFlowDefinition func (c *SageMaker) DescribeFlowDefinition(input *DescribeFlowDefinitionInput) (*DescribeFlowDefinitionOutput, error) { @@ -8976,7 +8997,7 @@ func (c *SageMaker) DescribeHumanTaskUiRequest(input *DescribeHumanTaskUiInput) // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeHumanTaskUi func (c *SageMaker) DescribeHumanTaskUi(input *DescribeHumanTaskUiInput) (*DescribeHumanTaskUiOutput, error) { @@ -9055,7 +9076,7 @@ func (c *SageMaker) DescribeHyperParameterTuningJobRequest(input *DescribeHyperP // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeHyperParameterTuningJob func (c *SageMaker) DescribeHyperParameterTuningJob(input *DescribeHyperParameterTuningJobInput) (*DescribeHyperParameterTuningJobOutput, error) { @@ -9134,7 +9155,7 @@ func (c *SageMaker) DescribeImageRequest(input *DescribeImageInput) (req *reques // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeImage func (c *SageMaker) DescribeImage(input *DescribeImageInput) (*DescribeImageOutput, error) { @@ -9213,7 +9234,7 @@ func (c *SageMaker) DescribeImageVersionRequest(input *DescribeImageVersionInput // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeImageVersion func (c *SageMaker) DescribeImageVersion(input *DescribeImageVersionInput) (*DescribeImageVersionOutput, error) { @@ -9292,7 +9313,7 @@ func (c *SageMaker) DescribeLabelingJobRequest(input *DescribeLabelingJobInput) // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeLabelingJob func (c *SageMaker) DescribeLabelingJob(input *DescribeLabelingJobInput) (*DescribeLabelingJobOutput, error) { @@ -9445,7 +9466,7 @@ func (c *SageMaker) DescribeModelBiasJobDefinitionRequest(input *DescribeModelBi // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeModelBiasJobDefinition func (c *SageMaker) DescribeModelBiasJobDefinition(input *DescribeModelBiasJobDefinitionInput) (*DescribeModelBiasJobDefinitionOutput, error) { @@ -9524,7 +9545,7 @@ func (c *SageMaker) DescribeModelExplainabilityJobDefinitionRequest(input *Descr // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeModelExplainabilityJobDefinition func (c *SageMaker) DescribeModelExplainabilityJobDefinition(input *DescribeModelExplainabilityJobDefinitionInput) (*DescribeModelExplainabilityJobDefinitionOutput, error) { @@ -9755,7 +9776,7 @@ func (c *SageMaker) DescribeModelQualityJobDefinitionRequest(input *DescribeMode // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeModelQualityJobDefinition func (c *SageMaker) DescribeModelQualityJobDefinition(input *DescribeModelQualityJobDefinitionInput) (*DescribeModelQualityJobDefinitionOutput, error) { @@ -9834,7 +9855,7 @@ func (c *SageMaker) DescribeMonitoringScheduleRequest(input *DescribeMonitoringS // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeMonitoringSchedule func (c *SageMaker) DescribeMonitoringSchedule(input *DescribeMonitoringScheduleInput) (*DescribeMonitoringScheduleOutput, error) { @@ -10064,7 +10085,7 @@ func (c *SageMaker) DescribePipelineRequest(input *DescribePipelineInput) (req * // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribePipeline func (c *SageMaker) DescribePipeline(input *DescribePipelineInput) (*DescribePipelineOutput, error) { @@ -10143,7 +10164,7 @@ func (c *SageMaker) DescribePipelineDefinitionForExecutionRequest(input *Describ // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribePipelineDefinitionForExecution func (c *SageMaker) DescribePipelineDefinitionForExecution(input *DescribePipelineDefinitionForExecutionInput) (*DescribePipelineDefinitionForExecutionOutput, error) { @@ -10222,7 +10243,7 @@ func (c *SageMaker) DescribePipelineExecutionRequest(input *DescribePipelineExec // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribePipelineExecution func (c *SageMaker) DescribePipelineExecution(input *DescribePipelineExecutionInput) (*DescribePipelineExecutionOutput, error) { @@ -10301,7 +10322,7 @@ func (c *SageMaker) DescribeProcessingJobRequest(input *DescribeProcessingJobInp // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeProcessingJob func (c *SageMaker) DescribeProcessingJob(input *DescribeProcessingJobInput) (*DescribeProcessingJobOutput, error) { @@ -10534,7 +10555,7 @@ func (c *SageMaker) DescribeTrainingJobRequest(input *DescribeTrainingJobInput) // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeTrainingJob func (c *SageMaker) DescribeTrainingJob(input *DescribeTrainingJobInput) (*DescribeTrainingJobOutput, error) { @@ -10613,7 +10634,7 @@ func (c *SageMaker) DescribeTransformJobRequest(input *DescribeTransformJobInput // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeTransformJob func (c *SageMaker) DescribeTransformJob(input *DescribeTransformJobInput) (*DescribeTransformJobOutput, error) { @@ -10692,7 +10713,7 @@ func (c *SageMaker) DescribeTrialRequest(input *DescribeTrialInput) (req *reques // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeTrial func (c *SageMaker) DescribeTrial(input *DescribeTrialInput) (*DescribeTrialOutput, error) { @@ -10771,7 +10792,7 @@ func (c *SageMaker) DescribeTrialComponentRequest(input *DescribeTrialComponentI // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeTrialComponent func (c *SageMaker) DescribeTrialComponent(input *DescribeTrialComponentInput) (*DescribeTrialComponentOutput, error) { @@ -10850,7 +10871,7 @@ func (c *SageMaker) DescribeUserProfileRequest(input *DescribeUserProfileInput) // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeUserProfile func (c *SageMaker) DescribeUserProfile(input *DescribeUserProfileInput) (*DescribeUserProfileOutput, error) { @@ -11168,7 +11189,7 @@ func (c *SageMaker) DisassociateTrialComponentRequest(input *DisassociateTrialCo // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DisassociateTrialComponent func (c *SageMaker) DisassociateTrialComponent(input *DisassociateTrialComponentInput) (*DisassociateTrialComponentOutput, error) { @@ -11632,7 +11653,7 @@ func (c *SageMaker) ListActionsRequest(input *ListActionsInput) (req *request.Re // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListActions func (c *SageMaker) ListActions(input *ListActionsInput) (*ListActionsOutput, error) { @@ -12167,7 +12188,7 @@ func (c *SageMaker) ListArtifactsRequest(input *ListArtifactsInput) (req *reques // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListArtifacts func (c *SageMaker) ListArtifacts(input *ListArtifactsInput) (*ListArtifactsOutput, error) { @@ -12304,7 +12325,7 @@ func (c *SageMaker) ListAssociationsRequest(input *ListAssociationsInput) (req * // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListAssociations func (c *SageMaker) ListAssociations(input *ListAssociationsInput) (*ListAssociationsOutput, error) { @@ -12573,7 +12594,7 @@ func (c *SageMaker) ListCandidatesForAutoMLJobRequest(input *ListCandidatesForAu // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListCandidatesForAutoMLJob func (c *SageMaker) ListCandidatesForAutoMLJob(input *ListCandidatesForAutoMLJobInput) (*ListCandidatesForAutoMLJobOutput, error) { @@ -12977,7 +12998,7 @@ func (c *SageMaker) ListContextsRequest(input *ListContextsInput) (req *request. // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListContexts func (c *SageMaker) ListContexts(input *ListContextsInput) (*ListContextsOutput, error) { @@ -14702,7 +14723,7 @@ func (c *SageMaker) ListImageVersionsRequest(input *ListImageVersionsInput) (req // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListImageVersions func (c *SageMaker) ListImageVersions(input *ListImageVersionsInput) (*ListImageVersionsOutput, error) { @@ -15105,7 +15126,7 @@ func (c *SageMaker) ListLabelingJobsForWorkteamRequest(input *ListLabelingJobsFo // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListLabelingJobsForWorkteam func (c *SageMaker) ListLabelingJobsForWorkteam(input *ListLabelingJobsForWorkteamInput) (*ListLabelingJobsForWorkteamOutput, error) { @@ -16564,7 +16585,7 @@ func (c *SageMaker) ListPipelineExecutionStepsRequest(input *ListPipelineExecuti // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListPipelineExecutionSteps func (c *SageMaker) ListPipelineExecutionSteps(input *ListPipelineExecutionStepsInput) (*ListPipelineExecutionStepsOutput, error) { @@ -16701,7 +16722,7 @@ func (c *SageMaker) ListPipelineExecutionsRequest(input *ListPipelineExecutionsI // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListPipelineExecutions func (c *SageMaker) ListPipelineExecutions(input *ListPipelineExecutionsInput) (*ListPipelineExecutionsOutput, error) { @@ -16838,7 +16859,7 @@ func (c *SageMaker) ListPipelineParametersForExecutionRequest(input *ListPipelin // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListPipelineParametersForExecution func (c *SageMaker) ListPipelineParametersForExecution(input *ListPipelineParametersForExecutionInput) (*ListPipelineParametersForExecutionOutput, error) { @@ -17631,14 +17652,15 @@ func (c *SageMaker) ListTrainingJobsRequest(input *ListTrainingJobsInput) (req * // When StatusEquals and MaxResults are set at the same time, the MaxResults // number of training jobs are first retrieved ignoring the StatusEquals parameter // and then they are filtered by the StatusEquals parameter, which is returned -// as a response. For example, if ListTrainingJobs is invoked with the following -// parameters: +// as a response. +// +// For example, if ListTrainingJobs is invoked with the following parameters: // // { ... MaxResults: 100, StatusEquals: InProgress ... } // -// Then, 100 trainings jobs with any status including those other than InProgress -// are selected first (sorted according the creation time, from the latest to -// the oldest) and those with status InProgress are returned. +// First, 100 trainings jobs with any status, including those other than InProgress, +// are selected (sorted according to the creation time, from the most current +// to the oldest). Next, those with a status of InProgress are returned. // // You can quickly test the API using the following AWS CLI code. // @@ -17786,7 +17808,7 @@ func (c *SageMaker) ListTrainingJobsForHyperParameterTuningJobRequest(input *Lis // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob func (c *SageMaker) ListTrainingJobsForHyperParameterTuningJob(input *ListTrainingJobsForHyperParameterTuningJobInput) (*ListTrainingJobsForHyperParameterTuningJobOutput, error) { @@ -18064,7 +18086,7 @@ func (c *SageMaker) ListTrialComponentsRequest(input *ListTrialComponentsInput) // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListTrialComponents func (c *SageMaker) ListTrialComponents(input *ListTrialComponentsInput) (*ListTrialComponentsOutput, error) { @@ -18205,7 +18227,7 @@ func (c *SageMaker) ListTrialsRequest(input *ListTrialsInput) (req *request.Requ // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListTrials func (c *SageMaker) ListTrials(input *ListTrialsInput) (*ListTrialsOutput, error) { @@ -18893,7 +18915,7 @@ func (c *SageMaker) RenderUiTemplateRequest(input *RenderUiTemplateInput) (req * // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/RenderUiTemplate func (c *SageMaker) RenderUiTemplate(input *RenderUiTemplateInput) (*RenderUiTemplateOutput, error) { @@ -19114,7 +19136,7 @@ func (c *SageMaker) StartMonitoringScheduleRequest(input *StartMonitoringSchedul // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StartMonitoringSchedule func (c *SageMaker) StartMonitoringSchedule(input *StartMonitoringScheduleInput) (*StartMonitoringScheduleOutput, error) { @@ -19278,7 +19300,7 @@ func (c *SageMaker) StartPipelineExecutionRequest(input *StartPipelineExecutionI // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // * ResourceLimitExceeded // You have exceeded an Amazon SageMaker resource limit. For example, you might @@ -19362,7 +19384,7 @@ func (c *SageMaker) StopAutoMLJobRequest(input *StopAutoMLJobInput) (req *reques // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StopAutoMLJob func (c *SageMaker) StopAutoMLJob(input *StopAutoMLJobInput) (*StopAutoMLJobOutput, error) { @@ -19451,7 +19473,7 @@ func (c *SageMaker) StopCompilationJobRequest(input *StopCompilationJobInput) (r // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StopCompilationJob func (c *SageMaker) StopCompilationJob(input *StopCompilationJobInput) (*StopCompilationJobOutput, error) { @@ -19612,7 +19634,7 @@ func (c *SageMaker) StopHyperParameterTuningJobRequest(input *StopHyperParameter // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StopHyperParameterTuningJob func (c *SageMaker) StopHyperParameterTuningJob(input *StopHyperParameterTuningJobInput) (*StopHyperParameterTuningJobOutput, error) { @@ -19694,7 +19716,7 @@ func (c *SageMaker) StopLabelingJobRequest(input *StopLabelingJobInput) (req *re // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StopLabelingJob func (c *SageMaker) StopLabelingJob(input *StopLabelingJobInput) (*StopLabelingJobOutput, error) { @@ -19774,7 +19796,7 @@ func (c *SageMaker) StopMonitoringScheduleRequest(input *StopMonitoringScheduleI // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StopMonitoringSchedule func (c *SageMaker) StopMonitoringSchedule(input *StopMonitoringScheduleInput) (*StopMonitoringScheduleOutput, error) { @@ -19936,7 +19958,7 @@ func (c *SageMaker) StopPipelineExecutionRequest(input *StopPipelineExecutionInp // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StopPipelineExecution func (c *SageMaker) StopPipelineExecution(input *StopPipelineExecutionInput) (*StopPipelineExecutionOutput, error) { @@ -20016,7 +20038,7 @@ func (c *SageMaker) StopProcessingJobRequest(input *StopProcessingJobInput) (req // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StopProcessingJob func (c *SageMaker) StopProcessingJob(input *StopProcessingJobInput) (*StopProcessingJobOutput, error) { @@ -20103,7 +20125,7 @@ func (c *SageMaker) StopTrainingJobRequest(input *StopTrainingJobInput) (req *re // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StopTrainingJob func (c *SageMaker) StopTrainingJob(input *StopTrainingJobInput) (*StopTrainingJobOutput, error) { @@ -20188,7 +20210,7 @@ func (c *SageMaker) StopTransformJobRequest(input *StopTransformJobInput) (req * // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StopTransformJob func (c *SageMaker) StopTransformJob(input *StopTransformJobInput) (*StopTransformJobOutput, error) { @@ -20267,11 +20289,11 @@ func (c *SageMaker) UpdateActionRequest(input *UpdateActionInput) (req *request. // // Returned Error Types: // * ConflictException -// There was a conflict when you attempted to modify an experiment, trial, or -// trial component. +// There was a conflict when you attempted to modify a SageMaker entity such +// as an Experiment or Artifact. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateAction func (c *SageMaker) UpdateAction(input *UpdateActionInput) (*UpdateActionOutput, error) { @@ -20350,7 +20372,7 @@ func (c *SageMaker) UpdateAppImageConfigRequest(input *UpdateAppImageConfigInput // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateAppImageConfig func (c *SageMaker) UpdateAppImageConfig(input *UpdateAppImageConfigInput) (*UpdateAppImageConfigOutput, error) { @@ -20429,11 +20451,11 @@ func (c *SageMaker) UpdateArtifactRequest(input *UpdateArtifactInput) (req *requ // // Returned Error Types: // * ConflictException -// There was a conflict when you attempted to modify an experiment, trial, or -// trial component. +// There was a conflict when you attempted to modify a SageMaker entity such +// as an Experiment or Artifact. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateArtifact func (c *SageMaker) UpdateArtifact(input *UpdateArtifactInput) (*UpdateArtifactOutput, error) { @@ -20586,11 +20608,11 @@ func (c *SageMaker) UpdateContextRequest(input *UpdateContextInput) (req *reques // // Returned Error Types: // * ConflictException -// There was a conflict when you attempted to modify an experiment, trial, or -// trial component. +// There was a conflict when you attempted to modify a SageMaker entity such +// as an Experiment or Artifact. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateContext func (c *SageMaker) UpdateContext(input *UpdateContextInput) (*UpdateContextOutput, error) { @@ -20670,7 +20692,7 @@ func (c *SageMaker) UpdateDeviceFleetRequest(input *UpdateDeviceFleetInput) (req // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateDeviceFleet func (c *SageMaker) UpdateDeviceFleet(input *UpdateDeviceFleetInput) (*UpdateDeviceFleetOutput, error) { @@ -20828,10 +20850,10 @@ func (c *SageMaker) UpdateDomainRequest(input *UpdateDomainInput) (req *request. // have too many training jobs created. // // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateDomain func (c *SageMaker) UpdateDomain(input *UpdateDomainInput) (*UpdateDomainOutput, error) { @@ -21089,11 +21111,11 @@ func (c *SageMaker) UpdateExperimentRequest(input *UpdateExperimentInput) (req * // // Returned Error Types: // * ConflictException -// There was a conflict when you attempted to modify an experiment, trial, or -// trial component. +// There was a conflict when you attempted to modify a SageMaker entity such +// as an Experiment or Artifact. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateExperiment func (c *SageMaker) UpdateExperiment(input *UpdateExperimentInput) (*UpdateExperimentOutput, error) { @@ -21173,10 +21195,10 @@ func (c *SageMaker) UpdateImageRequest(input *UpdateImageInput) (req *request.Re // // Returned Error Types: // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateImage func (c *SageMaker) UpdateImage(input *UpdateImageInput) (*UpdateImageOutput, error) { @@ -21333,7 +21355,7 @@ func (c *SageMaker) UpdateMonitoringScheduleRequest(input *UpdateMonitoringSched // have too many training jobs created. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateMonitoringSchedule func (c *SageMaker) UpdateMonitoringSchedule(input *UpdateMonitoringScheduleInput) (*UpdateMonitoringScheduleOutput, error) { @@ -21577,7 +21599,7 @@ func (c *SageMaker) UpdatePipelineRequest(input *UpdatePipelineInput) (req *requ // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdatePipeline func (c *SageMaker) UpdatePipeline(input *UpdatePipelineInput) (*UpdatePipelineOutput, error) { @@ -21656,7 +21678,7 @@ func (c *SageMaker) UpdatePipelineExecutionRequest(input *UpdatePipelineExecutio // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdatePipelineExecution func (c *SageMaker) UpdatePipelineExecution(input *UpdatePipelineExecutionInput) (*UpdatePipelineExecutionOutput, error) { @@ -21735,7 +21757,7 @@ func (c *SageMaker) UpdateTrainingJobRequest(input *UpdateTrainingJobInput) (req // // Returned Error Types: // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateTrainingJob func (c *SageMaker) UpdateTrainingJob(input *UpdateTrainingJobInput) (*UpdateTrainingJobOutput, error) { @@ -21814,11 +21836,11 @@ func (c *SageMaker) UpdateTrialRequest(input *UpdateTrialInput) (req *request.Re // // Returned Error Types: // * ConflictException -// There was a conflict when you attempted to modify an experiment, trial, or -// trial component. +// There was a conflict when you attempted to modify a SageMaker entity such +// as an Experiment or Artifact. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateTrial func (c *SageMaker) UpdateTrial(input *UpdateTrialInput) (*UpdateTrialOutput, error) { @@ -21897,11 +21919,11 @@ func (c *SageMaker) UpdateTrialComponentRequest(input *UpdateTrialComponentInput // // Returned Error Types: // * ConflictException -// There was a conflict when you attempted to modify an experiment, trial, or -// trial component. +// There was a conflict when you attempted to modify a SageMaker entity such +// as an Experiment or Artifact. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateTrialComponent func (c *SageMaker) UpdateTrialComponent(input *UpdateTrialComponentInput) (*UpdateTrialComponentOutput, error) { @@ -21984,10 +22006,10 @@ func (c *SageMaker) UpdateUserProfileRequest(input *UpdateUserProfileInput) (req // have too many training jobs created. // // * ResourceInUse -// Resource being accessed is in use. +// The resource being accessed is in use. // // * ResourceNotFound -// Resource being access is not found. +// The resource being accessed was not found. // // See also, https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UpdateUserProfile func (c *SageMaker) UpdateUserProfile(input *UpdateUserProfileInput) (*UpdateUserProfileOutput, error) { @@ -26445,8 +26467,8 @@ func (s *ConditionStepMetadata) SetOutcome(v string) *ConditionStepMetadata { return s } -// There was a conflict when you attempted to modify an experiment, trial, or -// trial component. +// There was a conflict when you attempted to modify a SageMaker entity such +// as an Experiment or Artifact. type ConflictException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -28650,6 +28672,9 @@ type CreateDomainInput struct { // Tags to associated with the Domain. Each tag consists of a key and an optional // value. Tag keys must be unique per resource. Tags are searchable using the // Search API. + // + // Tags that you specify for the Domain are also added to all Apps that the + // Domain launches. Tags []*Tag `type:"list"` // The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication. @@ -33033,6 +33058,9 @@ type CreateTrainingJobInput struct { // ResourceConfig is a required field ResourceConfig *ResourceConfig `type:"structure" required:"true"` + // The number of times to retry the job when the job fails due to an InternalServerError. + RetryStrategy *RetryStrategy `type:"structure"` + // The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume // to perform tasks on your behalf. // @@ -33049,9 +33077,10 @@ type CreateTrainingJobInput struct { // RoleArn is a required field RoleArn *string `min:"20" type:"string" required:"true"` - // Specifies a limit to how long a model training job can run. When the job - // reaches the time limit, Amazon SageMaker ends the training job. Use this - // API to cap model training costs. + // Specifies a limit to how long a model training job can run. It also specifies + // how long a managed Spot training job has to complete. When the job reaches + // the time limit, Amazon SageMaker ends the training job. Use this API to cap + // model training costs. // // To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which // delays job termination for 120 seconds. Algorithms can use this 120-second @@ -33186,6 +33215,11 @@ func (s *CreateTrainingJobInput) Validate() error { invalidParams.AddNested("ResourceConfig", err.(request.ErrInvalidParams)) } } + if s.RetryStrategy != nil { + if err := s.RetryStrategy.Validate(); err != nil { + invalidParams.AddNested("RetryStrategy", err.(request.ErrInvalidParams)) + } + } if s.StoppingCondition != nil { if err := s.StoppingCondition.Validate(); err != nil { invalidParams.AddNested("StoppingCondition", err.(request.ErrInvalidParams)) @@ -33308,6 +33342,12 @@ func (s *CreateTrainingJobInput) SetResourceConfig(v *ResourceConfig) *CreateTra return s } +// SetRetryStrategy sets the RetryStrategy field's value. +func (s *CreateTrainingJobInput) SetRetryStrategy(v *RetryStrategy) *CreateTrainingJobInput { + s.RetryStrategy = v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *CreateTrainingJobInput) SetRoleArn(v string) *CreateTrainingJobInput { s.RoleArn = &v @@ -33981,9 +34021,12 @@ type CreateUserProfileInput struct { // Each tag consists of a key and an optional value. Tag keys must be unique // per resource. + // + // Tags that you specify for the User Profile are also added to all Apps that + // the User Profile launches. Tags []*Tag `type:"list"` - // A name for the UserProfile. + // A name for the UserProfile. This value is not case sensitive. // // UserProfileName is a required field UserProfileName *string `type:"string" required:"true"` @@ -44455,6 +44498,9 @@ type DescribeTrainingJobOutput struct { // ResourceConfig is a required field ResourceConfig *ResourceConfig `type:"structure" required:"true"` + // The number of times to retry the job when the job fails due to an InternalServerError. + RetryStrategy *RetryStrategy `type:"structure"` + // The AWS Identity and Access Management (IAM) role configured for the training // job. RoleArn *string `min:"20" type:"string"` @@ -44523,9 +44569,9 @@ type DescribeTrainingJobOutput struct { SecondaryStatusTransitions []*SecondaryStatusTransition `type:"list"` // Specifies a limit to how long a model training job can run. It also specifies - // the maximum time to wait for a spot instance. When the job reaches the time - // limit, Amazon SageMaker ends the training job. Use this API to cap model - // training costs. + // how long a managed Spot training job has to complete. When the job reaches + // the time limit, Amazon SageMaker ends the training job. Use this API to cap + // model training costs. // // To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which // delays job termination for 120 seconds. Algorithms can use this 120-second @@ -44761,6 +44807,12 @@ func (s *DescribeTrainingJobOutput) SetResourceConfig(v *ResourceConfig) *Descri return s } +// SetRetryStrategy sets the RetryStrategy field's value. +func (s *DescribeTrainingJobOutput) SetRetryStrategy(v *RetryStrategy) *DescribeTrainingJobOutput { + s.RetryStrategy = v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *DescribeTrainingJobOutput) SetRoleArn(v string) *DescribeTrainingJobOutput { s.RoleArn = &v @@ -45479,7 +45531,7 @@ type DescribeUserProfileInput struct { // DomainId is a required field DomainId *string `type:"string" required:"true"` - // The user profile name. + // The user profile name. This value is not case sensitive. // // UserProfileName is a required field UserProfileName *string `type:"string" required:"true"` @@ -46832,7 +46884,7 @@ type EndpointInput struct { ProbabilityThresholdAttribute *float64 `type:"double"` // Whether input data distributed in Amazon S3 is fully replicated or sharded - // by an S3 key. Defauts to FullyReplicated + // by an S3 key. Defaults to FullyReplicated S3DataDistributionType *string `type:"string" enum:"ProcessingS3DataDistributionType"` // Whether the Pipe or File is used as the input mode for transfering data for @@ -50281,6 +50333,9 @@ type HyperParameterTrainingJobDefinition struct { // ResourceConfig is a required field ResourceConfig *ResourceConfig `type:"structure" required:"true"` + // The number of times to retry the job when the job fails due to an InternalServerError. + RetryStrategy *RetryStrategy `type:"structure"` + // The Amazon Resource Name (ARN) of the IAM role associated with the training // jobs that the tuning job launches. // @@ -50292,9 +50347,9 @@ type HyperParameterTrainingJobDefinition struct { StaticHyperParameters map[string]*string `type:"map"` // Specifies a limit to how long a model hyperparameter training job can run. - // It also specifies how long you are willing to wait for a managed spot training - // job to complete. When the job reaches the a limit, Amazon SageMaker ends - // the training job. Use this API to cap model training costs. + // It also specifies how long a managed spot training job has to complete. When + // the job reaches the time limit, Amazon SageMaker ends the training job. Use + // this API to cap model training costs. // // StoppingCondition is a required field StoppingCondition *StoppingCondition `type:"structure" required:"true"` @@ -50384,6 +50439,11 @@ func (s *HyperParameterTrainingJobDefinition) Validate() error { invalidParams.AddNested("ResourceConfig", err.(request.ErrInvalidParams)) } } + if s.RetryStrategy != nil { + if err := s.RetryStrategy.Validate(); err != nil { + invalidParams.AddNested("RetryStrategy", err.(request.ErrInvalidParams)) + } + } if s.StoppingCondition != nil { if err := s.StoppingCondition.Validate(); err != nil { invalidParams.AddNested("StoppingCondition", err.(request.ErrInvalidParams)) @@ -50466,6 +50526,12 @@ func (s *HyperParameterTrainingJobDefinition) SetResourceConfig(v *ResourceConfi return s } +// SetRetryStrategy sets the RetryStrategy field's value. +func (s *HyperParameterTrainingJobDefinition) SetRetryStrategy(v *RetryStrategy) *HyperParameterTrainingJobDefinition { + s.RetryStrategy = v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *HyperParameterTrainingJobDefinition) SetRoleArn(v string) *HyperParameterTrainingJobDefinition { s.RoleArn = &v @@ -52462,7 +52528,10 @@ type LabelingJobOutputConfig struct { // S3OutputPath is a required field S3OutputPath *string `type:"string" required:"true"` - // An Amazon Simple Notification Service (Amazon SNS) output topic ARN. + // An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide + // a SnsTopicArn if you want to do real time chaining to another streaming job + // and receive an Amazon SNS notifications each time a data object is submitted + // by a worker. // // If you provide an SnsTopicArn in OutputConfig, when workers complete labeling // tasks, Ground Truth will send labeling task output data to the SNS output @@ -55175,7 +55244,8 @@ type ListEndpointsInput struct { // timestamp. LastModifiedTimeBefore *time.Time `type:"timestamp"` - // The maximum number of endpoints to return in the response. + // The maximum number of endpoints to return in the response. This value defaults + // to 10. MaxResults *int64 `min:"1" type:"integer"` // A string in endpoint names. This filter returns only endpoints whose name @@ -63417,6 +63487,11 @@ type MonitoringStoppingCondition struct { // The maximum runtime allowed in seconds. // + // The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data + // quality and model explainability, this can be up to 3600 seconds for an hourly + // schedule. For model bias and model quality hourly schedules, this can be + // up to 1800 seconds. + // // MaxRuntimeInSeconds is a required field MaxRuntimeInSeconds *int64 `min:"1" type:"integer" required:"true"` } @@ -68235,7 +68310,7 @@ func (s *ResourceConfig) SetVolumeSizeInGB(v int64) *ResourceConfig { return s } -// Resource being accessed is in use. +// The resource being accessed is in use. type ResourceInUse struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -68410,7 +68485,7 @@ func (s *ResourceLimits) SetMaxParallelTrainingJobs(v int64) *ResourceLimits { return s } -// Resource being access is not found. +// The resource being accessed was not found. type ResourceNotFound struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -68537,6 +68612,52 @@ func (s *RetentionPolicy) SetHomeEfsFileSystem(v string) *RetentionPolicy { return s } +// The retry strategy to use when a training job fails due to an InternalServerError. +// RetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob +// requests. You can add the StoppingCondition parameter to the request to limit +// the training time for the complete job. +type RetryStrategy struct { + _ struct{} `type:"structure"` + + // The number of times to retry the job. When the job is retried, it's SecondaryStatus + // is changed to STARTING. + // + // MaximumRetryAttempts is a required field + MaximumRetryAttempts *int64 `min:"1" type:"integer" required:"true"` +} + +// String returns the string representation +func (s RetryStrategy) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s RetryStrategy) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RetryStrategy) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RetryStrategy"} + if s.MaximumRetryAttempts == nil { + invalidParams.Add(request.NewErrParamRequired("MaximumRetryAttempts")) + } + if s.MaximumRetryAttempts != nil && *s.MaximumRetryAttempts < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaximumRetryAttempts", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaximumRetryAttempts sets the MaximumRetryAttempts field's value. +func (s *RetryStrategy) SetMaximumRetryAttempts(v int64) *RetryStrategy { + s.MaximumRetryAttempts = &v + return s +} + // Describes the S3 data source. type S3DataSource struct { _ struct{} `type:"structure"` @@ -70551,10 +70672,11 @@ func (s StopTransformJobOutput) GoString() string { return s.String() } -// Specifies a limit to how long a model training or compilation job can run. -// It also specifies how long you are willing to wait for a managed spot training -// job to complete. When the job reaches the time limit, Amazon SageMaker ends -// the training or compilation job. Use this API to cap model training costs. +// Specifies a limit to how long a model training job, model compilation job, +// or hyperparameter tuning job can run. It also specifies how long a managed +// Spot training job has to complete. When the job reaches the time limit, Amazon +// SageMaker ends the training or compilation job. Use this API to cap model +// training costs. // // To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which // delays job termination for 120 seconds. Algorithms can use this 120-second @@ -70573,16 +70695,25 @@ func (s StopTransformJobOutput) GoString() string { type StoppingCondition struct { _ struct{} `type:"structure"` - // The maximum length of time, in seconds, that the training or compilation - // job can run. If job does not complete during this time, Amazon SageMaker - // ends the job. If value is not specified, default value is 1 day. The maximum - // value is 28 days. + // The maximum length of time, in seconds, that a training or compilation job + // can run. If the job does not complete during this time, Amazon SageMaker + // ends the job. + // + // When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies + // the maximum time for all of the attempts in total, not each individual attempt. + // + // The default value is 1 day. The maximum value is 28 days. MaxRuntimeInSeconds *int64 `min:"1" type:"integer"` - // The maximum length of time, in seconds, how long you are willing to wait - // for a managed spot training job to complete. It is the amount of time spent - // waiting for Spot capacity plus the amount of time the training job runs. - // It must be equal to or greater than MaxRuntimeInSeconds. + // The maximum length of time, in seconds, that a managed Spot training job + // has to complete. It is the amount of time spent waiting for Spot capacity + // plus the amount of time the job can run. It must be equal to or greater than + // MaxRuntimeInSeconds. If the job does not complete during this time, Amazon + // SageMaker ends the job. + // + // When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds + // specifies the maximum time for all of the attempts in total, not each individual + // attempt. MaxWaitTimeInSeconds *int64 `min:"1" type:"integer"` } @@ -71099,6 +71230,9 @@ type TrainingJob struct { // configured for model training. ResourceConfig *ResourceConfig `type:"structure"` + // The number of times to retry the job when the job fails due to an InternalServerError. + RetryStrategy *RetryStrategy `type:"structure"` + // The AWS Identity and Access Management (IAM) role configured for the training // job. RoleArn *string `min:"20" type:"string"` @@ -71158,9 +71292,10 @@ type TrainingJob struct { // through. SecondaryStatusTransitions []*SecondaryStatusTransition `type:"list"` - // Specifies a limit to how long a model training job can run. When the job - // reaches the time limit, Amazon SageMaker ends the training job. Use this - // API to cap model training costs. + // Specifies a limit to how long a model training job can run. It also specifies + // how long a managed Spot training job has to complete. When the job reaches + // the time limit, Amazon SageMaker ends the training job. Use this API to cap + // model training costs. // // To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which // delays job termination for 120 seconds. Algorithms can use this 120-second @@ -71369,6 +71504,12 @@ func (s *TrainingJob) SetResourceConfig(v *ResourceConfig) *TrainingJob { return s } +// SetRetryStrategy sets the RetryStrategy field's value. +func (s *TrainingJob) SetRetryStrategy(v *RetryStrategy) *TrainingJob { + s.RetryStrategy = v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *TrainingJob) SetRoleArn(v string) *TrainingJob { s.RoleArn = &v @@ -71477,9 +71618,10 @@ type TrainingJobDefinition struct { // ResourceConfig is a required field ResourceConfig *ResourceConfig `type:"structure" required:"true"` - // Specifies a limit to how long a model training job can run. When the job - // reaches the time limit, Amazon SageMaker ends the training job. Use this - // API to cap model training costs. + // Specifies a limit to how long a model training job can run. It also specifies + // how long a managed Spot training job has to complete. When the job reaches + // the time limit, Amazon SageMaker ends the training job. Use this API to cap + // model training costs. // // To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which // delays job termination for 120 seconds. Algorithms can use this 120-second @@ -72025,7 +72167,7 @@ type TransformInput struct { // // For more information about RecordIO, see Create a Dataset Using RecordIO // (https://mxnet.apache.org/api/faq/recordio) in the MXNet documentation. For - // more information about TFRecord, see Consuming TFRecord data (https://www.tensorflow.org/guide/datasets#consuming_tfrecord_data) + // more information about TFRecord, see Consuming TFRecord data (https://www.tensorflow.org/guide/data#consuming_tfrecord_data) // in the TensorFlow documentation. SplitType *string `type:"string" enum:"SplitType"` } @@ -80566,6 +80708,9 @@ const ( // SecondaryStatusUpdating is a SecondaryStatus enum value SecondaryStatusUpdating = "Updating" + + // SecondaryStatusRestarting is a SecondaryStatus enum value + SecondaryStatusRestarting = "Restarting" ) // SecondaryStatus_Values returns all elements of the SecondaryStatus enum @@ -80586,6 +80731,7 @@ func SecondaryStatus_Values() []string { SecondaryStatusInterrupted, SecondaryStatusMaxWaitTimeExceeded, SecondaryStatusUpdating, + SecondaryStatusRestarting, } } diff --git a/service/sagemaker/errors.go b/service/sagemaker/errors.go index c201ba6a4ce..cdd34100dfa 100644 --- a/service/sagemaker/errors.go +++ b/service/sagemaker/errors.go @@ -11,14 +11,14 @@ const ( // ErrCodeConflictException for service response error code // "ConflictException". // - // There was a conflict when you attempted to modify an experiment, trial, or - // trial component. + // There was a conflict when you attempted to modify a SageMaker entity such + // as an Experiment or Artifact. ErrCodeConflictException = "ConflictException" // ErrCodeResourceInUse for service response error code // "ResourceInUse". // - // Resource being accessed is in use. + // The resource being accessed is in use. ErrCodeResourceInUse = "ResourceInUse" // ErrCodeResourceLimitExceeded for service response error code @@ -31,7 +31,7 @@ const ( // ErrCodeResourceNotFound for service response error code // "ResourceNotFound". // - // Resource being access is not found. + // The resource being accessed was not found. ErrCodeResourceNotFound = "ResourceNotFound" )