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 throttling limit which determines the number of times the action can be called per second. For more information, see API Rate Limits in ACM Private CA in the ACM Private CA user guide.
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.
", - "CreateCertificateAuthorityAuditReport": "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.
", - "CreatePermission": "Assigns permissions from a private CA to a designated AWS service. Services are specified by their service principals and can be given permission to create and retrieve certificates on a private CA. Services can also be given permission to list the active permissions that the private CA has granted. For ACM to automatically renew your private CA's certificates, you must assign all possible permissions from the CA to the ACM service principal.
At this time, you can only assign permissions to ACM (acm.amazonaws.com). Permissions can be revoked with the DeletePermission action and listed with the ListPermissions action.
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 that a private CA assigned to a designated AWS service. Permissions can be created with the CreatePermission action and listed with the ListPermissions action.
", - "DescribeCertificateAuthority": "Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:
CREATING - ACM Private CA is creating your private certificate authority.
PENDING_CERTIFICATE - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.
ACTIVE - Your private CA is active.
DISABLED - Your private CA has been disabled.
EXPIRED - Your private CA certificate has expired.
FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.
DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.
Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action.
", - "GetCertificate": "Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the IssueCertificate action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate action. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of the certificates issued and revoked by your private CA.
", - "GetCertificateAuthorityCertificate": "Retrieves the certificate and certificate chain for your private certificate authority (CA). Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it.
", - "GetCertificateAuthorityCsr": "Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into ACM Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string.
", - "ImportCertificateAuthorityCertificate": "Imports a signed private CA certificate into ACM Private CA. This action is used when you are using a chain of trust whose root is located outside ACM Private CA. Before you can call this action, the following preparations must in place:
In ACM Private CA, call the CreateCertificateAuthority action to create the private CA that that you plan to back with the imported certificate.
Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).
Sign the CSR using a root or intermediate CA hosted either by an on-premises PKI hierarchy or a commercial CA..
Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.
The following requirements apply when you import a CA certificate.
You cannot import a non-self-signed certificate for use as a root CA.
You cannot import a self-signed certificate for use as a subordinate CA.
Your certificate chain must not include the private CA certificate that you are importing.
Your ACM Private CA-hosted or on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.
The chain must be PEM-encoded.
Uses your private certificate authority (CA) to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN.
You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using ACM Private CA.
Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.
", - "ListPermissions": "Lists all the permissions, if any, that have been assigned by a private CA. Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.
", - "ListTags": "Lists the tags, if any, that are associated with your private CA. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.
", - "RestoreCertificateAuthority": "Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the DELETED state by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended.
Revokes a certificate that was issued inside ACM Private CA. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM Private CA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the CrlConfiguration structure. ACM Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.
You cannot revoke a root CA self-signed certificate.
Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are associated with your CA.
", - "UntagCertificateAuthority": "Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this action, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are associated with your CA.
", - "UpdateCertificateAuthority": "Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it. You can disable a private CA that is in the ACTIVE state or make a CA that is in the DISABLED state active again.
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.
", + "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.
Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.
If you delete a policy that was applied through AWS Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.
The AWS Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy.
The current policy can be shown with GetPolicy and updated with PutPolicy.
About Policies
A policy grants access on a private CA to an AWS customer account, to AWS Organizations, or to an AWS Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.
A policy permits a user of AWS Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.
For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.
Updates made in AWS Resource Manager (RAM) are reflected in policies. For more information, see Using AWS Resource Access Manager (RAM) with ACM Private CA.
Lists information about your private certificate authority (CA) or one that has been shared with you. You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:
CREATING - ACM Private CA is creating your private certificate authority.
PENDING_CERTIFICATE - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.
ACTIVE - Your private CA is active.
DISABLED - Your private CA has been disabled.
EXPIRED - Your private CA certificate has expired.
FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.
DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.
Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action.
", + "GetCertificate": "Retrieves a certificate from your private CA or one that has been shared with you. The ARN of the certificate is returned when you call the IssueCertificate action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate action. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of the certificates issued and revoked by your private CA.
", + "GetCertificateAuthorityCertificate": "Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you. Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it.
", + "GetCertificateAuthorityCsr": "Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into ACM Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string.
", + "GetPolicy": "Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a ResourceNotFoundException.
The policy can be attached or updated with PutPolicy and removed with DeletePolicy.
About Policies
A policy grants access on a private CA to an AWS customer account, to AWS Organizations, or to an AWS Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.
A policy permits a user of AWS Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.
For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.
Updates made in AWS Resource Manager (RAM) are reflected in policies. For more information, see Using AWS Resource Access Manager (RAM) with ACM Private CA.
Imports a signed private CA certificate into ACM Private CA. This action is used when you are using a chain of trust whose root is located outside ACM Private CA. Before you can call this action, the following preparations must in place:
In ACM Private CA, call the CreateCertificateAuthority action to create the private CA that that you plan to back with the imported certificate.
Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).
Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA.
Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.
The following requirements apply when you import a CA certificate.
You cannot import a non-self-signed certificate for use as a root CA.
You cannot import a self-signed certificate for use as a subordinate CA.
Your certificate chain must not include the private CA certificate that you are importing.
Your ACM Private CA-hosted or on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.
The chain must be PEM-encoded.
The maximum allowed size of a certificate is 32 KB.
The maximum allowed size of a certificate chain is 2 MB.
Enforcement of Critical Constraints
ACM Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.
Basic constraints (must be marked critical)
Subject alternative names
Key usage
Extended key usage
Authority key identifier
Subject key identifier
Issuer alternative name
Subject directory attributes
Subject information access
Certificate policies
Policy mappings
Inhibit anyPolicy
ACM Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.
Name constraints
Policy constraints
CRL distribution points
Authority information access
Freshest CRL
Any other extension
Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN.
You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using ACM Private CA.
Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.
", + "ListPermissions": "List all permissions on a private CA, if any, 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.
Permissions can be granted with the CreatePermission action and revoked 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.
Lists the tags, if any, that are associated with your private CA or one that has been shared with you. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.
", + "PutPolicy": "Attaches a resource-based policy to a private CA.
A policy can also be applied by sharing a private CA through AWS Resource Access Manager (RAM).
The policy can be displayed with GetPolicy and removed with DeletePolicy.
About Policies
A policy grants access on a private CA to an AWS customer account, to AWS Organizations, or to an AWS Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.
A policy permits a user of AWS Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.
For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.
Updates made in AWS Resource Manager (RAM) are reflected in policies. For more information, see Using AWS Resource Access Manager (RAM) with ACM Private CA.
Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the DELETED state by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended.
Revokes a certificate that was issued inside ACM Private CA. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM Private CA writes the CRL to an S3 bucket that you specify. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For more information, see Supported CloudWatch Metrics.
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 also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.
You cannot revoke a root CA self-signed certificate.
Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are associated with your CA.
", + "UntagCertificateAuthority": "Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this action, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are associated with your CA.
", + "UpdateCertificateAuthority": "Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it. You can disable a private CA that is in the ACTIVE state or make a CA that is in the DISABLED state active again.
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.
Disambiguating information for the certificate subject.
", + "ASN1Subject$SerialNumber": "The certificate serial number.
" + } + }, "ASN1Subject": { "base": "Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each entity, but your private CA can issue more than one certificate with the same DN to the same entity.
", "refs": { "CertificateAuthorityConfiguration$Subject": "Structure that contains X.500 distinguished name information for your private CA.
" } }, + "AWSPolicy": { + "base": null, + "refs": { + "GetPolicyResponse$Policy": "The policy attached to the private CA as a JSON document.
", + "Permission$Policy": "The name of the policy that is associated with the permission.
", + "PutPolicyRequest$Policy": "The path and filename of a JSON-formatted IAM policy to attach to the specified private CA resource. If this policy does not contain all required statements or if it includes any statement that is not allowed, the PutPolicy action returns an InvalidPolicyException. For information about IAM policy and statement structure, see Overview of JSON Policies.
The AWS account ID that owns the certificate authority.
", "CreatePermissionRequest$SourceAccount": "The ID of the calling account.
", - "DeletePermissionRequest$SourceAccount": "The AWS account that calls this action.
" + "DeletePermissionRequest$SourceAccount": "The AWS account that calls this action.
", + "Permission$SourceAccount": "The ID of the account that assigned the permission.
" } }, "ActionList": { @@ -56,26 +76,29 @@ "CertificateAuthority$Arn": "Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .
The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the ListCertificateAuthorities action. This must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's ARN by calling the ListCertificateAuthorities action. This must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the ListCertificateAuthorities action. This must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's ARN by calling the ListCertificateAuthorities action. This must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The Amazon Resource Number (ARN) of the private CA that will have its policy deleted. You can find the CA's ARN by calling the ListCertificateAuthorities action. The ARN value must have the form arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab.
The Amazon Resource Name (ARN) of the private CA. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The Amazon Resource Name (ARN) of your private CA. This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template.
The following service-owned TemplateArn values are supported by ACM Private CA:
arn:aws:acm-pca:::template/EndEntityCertificate/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1
arn:aws:acm-pca:::template/RootCACertificate/V1
For more information, see Using Templates.
", + "GetPolicyRequest$ResourceArn": "The Amazon Resource Number (ARN) of the private CA that will have its policy retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.
", + "ImportCertificateAuthorityCertificateRequest$CertificateAuthorityArn": "The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.
Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.
The following service-owned TemplateArn values are supported by ACM Private CA:
arn:aws:acm-pca:::template/CodeSigningCertificate/V1
arn:aws:acm-pca:::template/CodeSigningCertificate_CSRPassthrough/V1
arn:aws:acm-pca:::template/EndEntityCertificate/V1
arn:aws:acm-pca:::template/EndEntityCertificate_CSRPassthrough/V1
arn:aws:acm-pca:::template/EndEntityClientAuthCertificate/V1
arn:aws:acm-pca:::template/EndEntityClientAuthCertificate_CSRPassthrough/V1
arn:aws:acm-pca:::template/EndEntityServerAuthCertificate/V1
arn:aws:acm-pca:::template/EndEntityServerAuthCertificate_CSRPassthrough/V1
arn:aws:acm-pca:::template/OCSPSigningCertificate/V1
arn:aws:acm-pca:::template/OCSPSigningCertificate_CSRPassthrough/V1
arn:aws:acm-pca:::template/RootCACertificate/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1
For more information, see Using Templates.
", "IssueCertificateResponse$CertificateArn": "The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 You can get a private CA's ARN by running the ListCertificateAuthorities action.
The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 You can get a private CA's ARN by running the ListCertificateAuthorities action.
The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The Amazon Resource Number (ARN) of the private CA from which the permission was issued.
", - "RestoreCertificateAuthorityRequest$CertificateAuthorityArn": "The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The Amazon Resource Number (ARN) of the private CA to associate with the policy. The ARN of the CA can be found by calling the ListCertificateAuthorities action.
", + "RestoreCertificateAuthorityRequest$CertificateAuthorityArn": "The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
An alphanumeric string that contains a report identifier.
", - "DescribeCertificateAuthorityAuditReportRequest$AuditReportId": "The report ID returned by calling the CreateCertificateAuthorityAuditReport action.
" + "DescribeCertificateAuthorityAuditReportRequest$AuditReportId": "The report ID returned by calling the CreateCertificateAuthorityAuditReport action.
" } }, "AuditReportResponseFormat": { @@ -101,7 +124,7 @@ "Boolean": { "base": null, "refs": { - "CrlConfiguration$Enabled": "Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority action or for an existing CA when you call the UpdateCertificateAuthority action.
" + "CrlConfiguration$Enabled": "Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority action or for an existing CA when you call the UpdateCertificateAuthority action.
" } }, "CertificateAuthorities": { @@ -111,14 +134,14 @@ } }, "CertificateAuthority": { - "base": "Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority action to create your private CA. You must then call the GetCertificateAuthorityCertificate action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed certificate into AWS Certificate Manager (ACM).
", + "base": "Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority action to create your private CA. You must then call the GetCertificateAuthorityCertificate action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed certificate into AWS Certificate Manager (ACM).
", "refs": { "CertificateAuthorities$member": null, - "DescribeCertificateAuthorityResponse$CertificateAuthority": "A CertificateAuthority structure that contains information about your private CA.
" + "DescribeCertificateAuthorityResponse$CertificateAuthority": "A CertificateAuthority structure that contains information about your private CA.
" } }, "CertificateAuthorityConfiguration": { - "base": "Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate. It also includes the signature algorithm that it uses when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the CreateCertificateAuthority action.
", + "base": "Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate. It also includes the signature algorithm that it uses when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the CreateCertificateAuthority action.
", "refs": { "CertificateAuthority$CertificateAuthorityConfiguration": "Your private CA configuration.
", "CreateCertificateAuthorityRequest$CertificateAuthorityConfiguration": "Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.
" @@ -206,7 +229,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.
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 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
Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.
" } @@ -214,7 +237,7 @@ "CsrBlob": { "base": null, "refs": { - "IssueCertificateRequest$Csr": "The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.
openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
If you have a configuration file, you can use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.
openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.
openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
If you have a configuration file, you can use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.
openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.
" } }, "CsrBody": { @@ -233,30 +256,29 @@ "refs": { } }, - "DescribeCertificateAuthorityAuditReportRequest": { + "DeletePolicyRequest": { "base": null, "refs": { } }, - "DescribeCertificateAuthorityAuditReportResponse": { + "DescribeCertificateAuthorityAuditReportRequest": { "base": null, "refs": { } }, - "DescribeCertificateAuthorityRequest": { + "DescribeCertificateAuthorityAuditReportResponse": { "base": null, "refs": { } }, - "DescribeCertificateAuthorityResponse": { + "DescribeCertificateAuthorityRequest": { "base": null, "refs": { } }, - "DistinguishedNameQualifierString": { + "DescribeCertificateAuthorityResponse": { "base": null, "refs": { - "ASN1Subject$DistinguishedNameQualifier": "Disambiguating information for the certificate subject.
" } }, "FailureReason": { @@ -295,10 +317,20 @@ "refs": { } }, + "GetPolicyRequest": { + "base": null, + "refs": { + } + }, + "GetPolicyResponse": { + "base": null, + "refs": { + } + }, "IdempotencyToken": { "base": null, "refs": { - "CreateCertificateAuthorityRequest$IdempotencyToken": "Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority. Idempotency tokens time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within a five minute period, ACM Private CA recognizes that you are requesting only one certificate. As a result, ACM Private CA issues only one. If you change the idempotency token for each call, however, ACM Private CA recognizes that you are requesting multiple certificates.
", + "CreateCertificateAuthorityRequest$IdempotencyToken": "Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority. For a given token, ACM Private CA creates exactly one CA. If you issue a subsequent call using the same token, ACM Private CA returns the ARN of the existing CA and takes no further action. If you change the idempotency token across multiple calls, ACM Private CA creates a unique CA for each unique token.
", "IssueCertificateRequest$IdempotencyToken": "Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.
" } }, @@ -324,12 +356,12 @@ } }, "InvalidNextTokenException": { - "base": "The token specified in the NextToken argument is not valid. Use the token returned from your previous call to ListCertificateAuthorities.
The token specified in the NextToken argument is not valid. Use the token returned from your previous call to ListCertificateAuthorities.
The S3 bucket policy is not valid. The policy must give ACM Private CA rights to read from and write to the bucket and find the bucket location.
", + "base": "The resource policy is invalid or is missing a required statement. For general information about IAM policy and statement structure, see Overview of JSON Policies.
", "refs": { } }, @@ -339,7 +371,7 @@ } }, "InvalidStateException": { - "base": "The private CA is in a state during which a report or certificate cannot be generated.
", + "base": "The state of the private CA does not allow this action to occur.
", "refs": { } }, @@ -365,7 +397,7 @@ } }, "LimitExceededException": { - "base": "An ACM Private CA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.
", + "base": "An ACM Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded.
", "refs": { } }, @@ -399,6 +431,11 @@ "refs": { } }, + "LockoutPreventedException": { + "base": "The current action was prevented because it would lock the caller out from performing subsequent actions. Verify that the specified parameters would not result in the caller being denied access to the resource.
", + "refs": { + } + }, "MalformedCSRException": { "base": "The certificate signing request is invalid.
", "refs": { @@ -435,7 +472,7 @@ } }, "Permission": { - "base": "Permissions designate which private CA actions can be performed by an AWS service or entity. In order for ACM to automatically renew private certificates, you must give the ACM service principal all available permissions (IssueCertificate, GetCertificate, and ListPermissions). Permissions can be assigned with the CreatePermission action, removed with the DeletePermission action, and listed with the ListPermissions action.
Permissions designate which private CA actions can be performed by an AWS service or entity. In order for ACM to automatically renew private certificates, you must give the ACM service principal all available permissions (IssueCertificate, GetCertificate, and ListPermissions). Permissions can be assigned with the CreatePermission action, removed with the DeletePermission action, and listed with the ListPermissions action.
Time period.
" + "Validity$Value": "A long integer interpreted according to the value of Type, below.
The AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.
The AWS service or identity that will have its CA permissions revoked. At this time, the only valid service principal is acm.amazonaws.com
The AWS service or identity that will have its CA permissions revoked. At this time, the only valid service principal is acm.amazonaws.com
The AWS service or entity that holds the permission. At this time, the only valid principal is acm.amazonaws.com.
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
", + "base": "A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.
", + "refs": { + } + }, + "ResourceOwner": { + "base": null, "refs": { + "ListCertificateAuthoritiesRequest$ResourceOwner": "Use this parameter to filter the returned set of certificate authorities based on their owner. The default is SELF.
" } }, "RestoreCertificateAuthorityRequest": { @@ -490,10 +539,10 @@ } }, "RevocationConfiguration": { - "base": "Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA) can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates revoked by your CA. For more information, see RevokeCertificate.
", + "base": "Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA) can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates revoked by your CA. For more information, see RevokeCertificate.
", "refs": { "CertificateAuthority$RevocationConfiguration": "Information about the certificate revocation list (CRL) created and maintained by your private CA.
", - "CreateCertificateAuthorityRequest$RevocationConfiguration": "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 the name of your bucket in the CRL Distribution Points extension of your CA certificate. For more information, see the CrlConfiguration structure.
", + "CreateCertificateAuthorityRequest$RevocationConfiguration": "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 the name of your bucket in the CRL Distribution Points extension of your CA certificate. For more information, see the CrlConfiguration structure.
", "UpdateCertificateAuthorityRequest$RevocationConfiguration": "Revocation information for your private CA.
" } }, @@ -508,11 +557,25 @@ "refs": { } }, + "S3BucketName": { + "base": null, + "refs": { + "CreateCertificateAuthorityAuditReportRequest$S3BucketName": "The name of the S3 bucket that will contain the audit report.
", + "DescribeCertificateAuthorityAuditReportResponse$S3BucketName": "Name of the S3 bucket that contains the report.
" + } + }, + "S3Key": { + "base": null, + "refs": { + "CreateCertificateAuthorityAuditReportResponse$S3Key": "The key that uniquely identifies the report file in your S3 bucket.
", + "DescribeCertificateAuthorityAuditReportResponse$S3Key": "S3 key that uniquely identifies the report file in your S3 bucket.
" + } + }, "SigningAlgorithm": { "base": null, "refs": { - "CertificateAuthorityConfiguration$SigningAlgorithm": "Name of the algorithm your private CA uses to sign certificate requests.
", - "IssueCertificateRequest$SigningAlgorithm": "The name of the algorithm that will be used to sign the certificate to be issued.
" + "CertificateAuthorityConfiguration$SigningAlgorithm": "Name of the algorithm your private CA uses to sign certificate requests.
This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are issued.
The name of the algorithm that will be used to sign the certificate to be issued.
This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR.
Serial number of your private CA.
", "CertificateMismatchException$message": null, "ConcurrentModificationException$message": null, - "CreateCertificateAuthorityAuditReportRequest$S3BucketName": "The name of the S3 bucket that will contain the audit report.
", - "CreateCertificateAuthorityAuditReportResponse$S3Key": "The key that uniquely identifies the report file in your S3 bucket.
", - "DescribeCertificateAuthorityAuditReportResponse$S3BucketName": "Name of the S3 bucket that contains the report.
", - "DescribeCertificateAuthorityAuditReportResponse$S3Key": "S3 key that uniquely identifies the report file in your S3 bucket.
", "InvalidArgsException$message": null, "InvalidArnException$message": null, "InvalidNextTokenException$message": null, @@ -533,11 +592,9 @@ "InvalidStateException$message": null, "InvalidTagException$message": null, "LimitExceededException$message": null, + "LockoutPreventedException$message": null, "MalformedCSRException$message": null, "MalformedCertificateException$message": null, - "Permission$Principal": "The AWS service or entity that holds the permission. At this time, the only valid principal is acm.amazonaws.com.
The ID of the account that assigned the permission.
", - "Permission$Policy": "The name of the policy that is associated with the permission.
", "PermissionAlreadyExistsException$message": null, "RequestAlreadyProcessedException$message": null, "RequestFailedException$message": null, @@ -552,7 +609,7 @@ "ASN1Subject$State": "State in which the subject of the certificate is located.
", "ASN1Subject$Locality": "The locality (such as a city or town) in which the certificate subject is located.
", "ASN1Subject$Pseudonym": "Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.
", - "RevokeCertificateRequest$CertificateSerial": "Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.
openssl x509 -in file_path -text -noout
You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API Reference.
" + "RevokeCertificateRequest$CertificateSerial": "Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.
openssl x509 -in file_path -text -noout
You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API Reference.
" } }, "String16": { @@ -576,7 +633,7 @@ "String3To255": { "base": null, "refs": { - "CrlConfiguration$S3BucketName": "Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority action. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket.
" + "CrlConfiguration$S3BucketName": "Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority action. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket.
" } }, "String40": { @@ -597,7 +654,6 @@ "ASN1Subject$Organization": "Legal name of the organization with which the certificate subject is affiliated.
", "ASN1Subject$OrganizationalUnit": "A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
", "ASN1Subject$CommonName": "Fully qualified domain name (FQDN) associated with the certificate subject.
", - "ASN1Subject$SerialNumber": "The certificate serial number.
", "ASN1Subject$Title": "A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.
" } }, @@ -608,13 +664,13 @@ "CertificateAuthority$LastStateChangeAt": "Date and time at which your private CA was last updated.
", "CertificateAuthority$NotBefore": "Date and time before which your private CA certificate is not valid.
", "CertificateAuthority$NotAfter": "Date and time after which your private CA certificate is not valid.
", - "CertificateAuthority$RestorableUntil": "The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.
The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.
The date and time at which the report was created.
", "Permission$CreatedAt": "The time at which the permission was created.
" } }, "Tag": { - "base": "Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority action.
", + "base": "Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority action.
", "refs": { "TagList$member": null } @@ -633,7 +689,7 @@ "TagList": { "base": null, "refs": { - "CreateCertificateAuthorityRequest$Tags": "Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with
IAM to manage permissions, see Controlling Access Using IAM Tags.
", + "CreateCertificateAuthorityRequest$Tags": "Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags.
", "ListTagsResponse$Tags": "The tags associated with your private CA.
", "TagCertificateAuthorityRequest$Tags": "List of tags to be associated with the CA.
", "UntagCertificateAuthorityRequest$Tags": "List of tags to be removed from the CA.
" @@ -661,15 +717,15 @@ } }, "Validity": { - "base": "Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the IssueCertificate action.
", + "base": "Validity specifies the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.
You can issue a certificate by calling the IssueCertificate action.
", "refs": { - "IssueCertificateRequest$Validity": "The type of the validity period.
" + "IssueCertificateRequest$Validity": "Information describing the validity period of the certificate.
When issuing a certificate, ACM Private CA sets the \"Not Before\" date in the validity field to date and time minus 60 minutes. This is intended to compensate for time inconsistencies across systems of 60 minutes or less.
The validity period configured on a certificate must not exceed the limit set by its parents in the CA hierarchy.
" } }, "ValidityPeriodType": { "base": null, "refs": { - "Validity$Type": "Specifies whether the Value parameter represents days, months, or years.
Determines how ACM Private CA interprets the Value parameter, an integer. Supported validity types include those listed below. Type definitions with values include a sample input value and the resulting output.
END_DATE: The specific date and time when the certificate will expire, expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) is greater than or equal to 50, the year is interpreted as 19YY. If the year field is less than 50, the year is interpreted as 20YY.
Sample input value: 491231235959 (UTCTime format)
Output expiration date/time: 12/31/2049 23:59:59
ABSOLUTE: The specific date and time when the certificate will expire, expressed in seconds since the Unix Epoch.
Sample input value: 2524608000
Output expiration date/time: 01/01/2050 00:00:00
DAYS, MONTHS, YEARS: The relative time from the moment of issuance until the certificate will expire, expressed in days, months, or years.
Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:
Sample input value: 90
Output expiration date: 01/10/2020 12:34:54 UTC
The media type associated with the image manifest.
", + "Image$imageManifestMediaType": "The manifest media type of the image.
", + "ImageDetail$imageManifestMediaType": "The media type of the image manifest.
", + "ImageDetail$artifactMediaType": "The artifact media type of the image.
", "Layer$mediaType": "The media type of the layer, such as application/vnd.docker.image.rootfs.diff.tar.gzip or application/vnd.oci.image.layer.v1.tar+gzip.
The media type of the image manifest. If you push an image manifest that does not contain the mediaType field, you must specify the imageManifestMediaType in the request.
A load balancer can distribute incoming traffic across your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered instances and ensures that it routes traffic only to healthy instances. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer and a protocol and port number for connections from the load balancer to the instances.
Elastic Load Balancing supports three types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers. You can select a load balancer based on your application needs. For more information, see the Elastic Load Balancing User Guide.
This reference covers the 2012-06-01 API, which supports Classic Load Balancers. The 2015-12-01 API supports Application Load Balancers and Network Load Balancers.
To get started, create a load balancer with one or more listeners using CreateLoadBalancer. Register your instances with the load balancer using RegisterInstancesWithLoadBalancer.
All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds with a 200 OK response code.
", + "service": "A load balancer can distribute incoming traffic across your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered instances and ensures that it routes traffic only to healthy instances. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer and a protocol and port number for connections from the load balancer to the instances.
Elastic Load Balancing supports three types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers. You can select a load balancer based on your application needs. For more information, see the Elastic Load Balancing User Guide.
This reference covers the 2012-06-01 API, which supports Classic Load Balancers. The 2015-12-01 API supports Application Load Balancers and Network Load Balancers.
To get started, create a load balancer with one or more listeners using CreateLoadBalancer. Register your instances with the load balancer using RegisterInstancesWithLoadBalancer.
All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds with a 200 OK response code.
", "operations": { - "AddTags": "Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags.
Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, AddTags updates its value.
For more information, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide.
", - "ApplySecurityGroupsToLoadBalancer": "Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups.
For more information, see Security Groups for Load Balancers in a VPC in the Classic Load Balancers Guide.
", - "AttachLoadBalancerToSubnets": "Adds one or more subnets to the set of configured subnets for the specified load balancer.
The load balancer evenly distributes requests across all registered subnets. For more information, see Add or Remove Subnets for Your Load Balancer in a VPC in the Classic Load Balancers Guide.
", - "ConfigureHealthCheck": "Specifies the health check settings to use when evaluating the health state of your EC2 instances.
For more information, see Configure Health Checks for Your Load Balancer in the Classic Load Balancers Guide.
", - "CreateAppCookieStickinessPolicy": "Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.
This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie, AWSELB, follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie.
If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.
For more information, see Application-Controlled Session Stickiness in the Classic Load Balancers Guide.
", - "CreateLBCookieStickinessPolicy": "Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.
When a load balancer implements this policy, the load balancer uses a special cookie to track the instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm.
A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.
For more information, see Duration-Based Session Stickiness in the Classic Load Balancers Guide.
", - "CreateLoadBalancer": "Creates a Classic Load Balancer.
You can add listeners, security groups, subnets, and tags when you create your load balancer, or you can add them later using CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer, AttachLoadBalancerToSubnets, and AddTags.
To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.
You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide.
", - "CreateLoadBalancerListeners": "Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener.
For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.
", + "AddTags": "Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags.
Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, AddTags updates its value.
For more information, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide.
", + "ApplySecurityGroupsToLoadBalancer": "Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups.
For more information, see Security Groups for Load Balancers in a VPC in the Classic Load Balancers Guide.
", + "AttachLoadBalancerToSubnets": "Adds one or more subnets to the set of configured subnets for the specified load balancer.
The load balancer evenly distributes requests across all registered subnets. For more information, see Add or Remove Subnets for Your Load Balancer in a VPC in the Classic Load Balancers Guide.
", + "ConfigureHealthCheck": "Specifies the health check settings to use when evaluating the health state of your EC2 instances.
For more information, see Configure Health Checks for Your Load Balancer in the Classic Load Balancers Guide.
", + "CreateAppCookieStickinessPolicy": "Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.
This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie, AWSELB, follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie.
If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.
For more information, see Application-Controlled Session Stickiness in the Classic Load Balancers Guide.
", + "CreateLBCookieStickinessPolicy": "Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.
When a load balancer implements this policy, the load balancer uses a special cookie to track the instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm.
A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.
For more information, see Duration-Based Session Stickiness in the Classic Load Balancers Guide.
", + "CreateLoadBalancer": "Creates a Classic Load Balancer.
You can add listeners, security groups, subnets, and tags when you create your load balancer, or you can add them later using CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer, AttachLoadBalancerToSubnets, and AddTags.
To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.
You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide.
", + "CreateLoadBalancerListeners": "Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener.
For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.
", "CreateLoadBalancerPolicy": "Creates a policy with the specified attributes for the specified load balancer.
Policies are settings that are saved for your load balancer and that can be applied to the listener or the application server, depending on the policy type.
", "DeleteLoadBalancer": "Deletes the specified load balancer.
If you are attempting to recreate a load balancer, you must reconfigure all settings. The DNS name associated with a deleted load balancer are no longer usable. The name and associated DNS record of the deleted load balancer no longer exist and traffic sent to any of its IP addresses is no longer delivered to your instances.
If the load balancer does not exist or has already been deleted, the call to DeleteLoadBalancer still succeeds.
Deletes the specified listeners from the specified load balancer.
", "DeleteLoadBalancerPolicy": "Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.
", - "DeregisterInstancesFromLoadBalancer": "Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.
You can use DescribeLoadBalancers to verify that the instance is deregistered from the load balancer.
For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide.
", - "DescribeAccountLimits": "Describes the current Elastic Load Balancing resource limits for your AWS account.
For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide.
", + "DeregisterInstancesFromLoadBalancer": "Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.
You can use DescribeLoadBalancers to verify that the instance is deregistered from the load balancer.
For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide.
", + "DescribeAccountLimits": "Describes the current Elastic Load Balancing resource limits for your AWS account.
For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide.
", "DescribeInstanceHealth": "Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned.
", "DescribeLoadBalancerAttributes": "Describes the attributes for the specified load balancer.
", "DescribeLoadBalancerPolicies": "Describes the specified policies.
If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. The names of the sample policies have the ELBSample- prefix.
Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.
", "DescribeTags": "Describes the tags associated with the specified load balancers.
", "DetachLoadBalancerFromSubnets": "Removes the specified subnets from the set of configured subnets for the load balancer.
After a subnet is removed, all EC2 instances registered with the load balancer in the removed subnet go into the OutOfService state. Then, the load balancer balances the traffic among the remaining routable subnets.
Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.
For load balancers in a non-default VPC, use DetachLoadBalancerFromSubnets.
There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones.
For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide.
", - "EnableAvailabilityZonesForLoadBalancer": "Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.
For load balancers in a non-default VPC, use AttachLoadBalancerToSubnets.
The load balancer evenly distributes requests across all its registered Availability Zones that contain instances. For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide.
", - "ModifyLoadBalancerAttributes": "Modifies the attributes of the specified load balancer.
You can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute ConnectionSettings by specifying an idle connection timeout value for your load balancer.
For more information, see the following in the Classic Load Balancers Guide:
", - "RegisterInstancesWithLoadBalancer": "Adds the specified instances to the specified load balancer.
The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC.
Note that RegisterInstanceWithLoadBalancer completes when the request has been registered. Instance registration takes a little time to complete. To check the state of the registered instances, use DescribeLoadBalancers or DescribeInstanceHealth.
After the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in one of the Availability Zones registered for the load balancer is moved to the OutOfService state. If an Availability Zone is added to the load balancer later, any instances registered with the load balancer move to the InService state.
To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.
For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide.
", + "DisableAvailabilityZonesForLoadBalancer": "Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.
For load balancers in a non-default VPC, use DetachLoadBalancerFromSubnets.
There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones.
For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide.
", + "EnableAvailabilityZonesForLoadBalancer": "Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.
For load balancers in a non-default VPC, use AttachLoadBalancerToSubnets.
The load balancer evenly distributes requests across all its registered Availability Zones that contain instances. For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide.
", + "ModifyLoadBalancerAttributes": "Modifies the attributes of the specified load balancer.
You can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute ConnectionSettings by specifying an idle connection timeout value for your load balancer.
For more information, see the following in the Classic Load Balancers Guide:
", + "RegisterInstancesWithLoadBalancer": "Adds the specified instances to the specified load balancer.
The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC.
Note that RegisterInstanceWithLoadBalancer completes when the request has been registered. Instance registration takes a little time to complete. To check the state of the registered instances, use DescribeLoadBalancers or DescribeInstanceHealth.
After the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in one of the Availability Zones registered for the load balancer is moved to the OutOfService state. If an Availability Zone is added to the load balancer later, any instances registered with the load balancer move to the InService state.
To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.
For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide.
", "RemoveTags": "Removes one or more tags from the specified load balancer.
", - "SetLoadBalancerListenerSSLCertificate": "Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port.
For more information about updating your SSL certificate, see Replace the SSL Certificate for Your Load Balancer in the Classic Load Balancers Guide.
", - "SetLoadBalancerPoliciesForBackendServer": "Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the instance ports; this policy type is composed of multiple public key policies.
Each time you use SetLoadBalancerPoliciesForBackendServer to enable the policies, use the PolicyNames parameter to list the policies that you want to enable.
You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to verify that the policy is associated with the EC2 instance.
For more information about enabling back-end instance authentication, see Configure Back-end Instance Authentication in the Classic Load Balancers Guide. For more information about Proxy Protocol, see Configure Proxy Protocol Support in the Classic Load Balancers Guide.
", - "SetLoadBalancerPoliciesOfListener": "Replaces the current set of policies for the specified load balancer port with the specified set of policies.
To enable back-end server authentication, use SetLoadBalancerPoliciesForBackendServer.
For more information about setting policies, see Update the SSL Negotiation Configuration, Duration-Based Session Stickiness, and Application-Controlled Session Stickiness in the Classic Load Balancers Guide.
" + "SetLoadBalancerListenerSSLCertificate": "Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port.
For more information about updating your SSL certificate, see Replace the SSL Certificate for Your Load Balancer in the Classic Load Balancers Guide.
", + "SetLoadBalancerPoliciesForBackendServer": "Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the instance ports; this policy type is composed of multiple public key policies.
Each time you use SetLoadBalancerPoliciesForBackendServer to enable the policies, use the PolicyNames parameter to list the policies that you want to enable.
You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to verify that the policy is associated with the EC2 instance.
For more information about enabling back-end instance authentication, see Configure Back-end Instance Authentication in the Classic Load Balancers Guide. For more information about Proxy Protocol, see Configure Proxy Protocol Support in the Classic Load Balancers Guide.
", + "SetLoadBalancerPoliciesOfListener": "Replaces the current set of policies for the specified load balancer port with the specified set of policies.
To enable back-end server authentication, use SetLoadBalancerPoliciesForBackendServer.
For more information about setting policies, see Update the SSL Negotiation Configuration, Duration-Based Session Stickiness, and Application-Controlled Session Stickiness in the Classic Load Balancers Guide.
" }, "shapes": { "AccessLog": { "base": "Information about the AccessLog attribute.
If enabled, the load balancer captures detailed information of all requests and delivers the information to the Amazon S3 bucket that you specify.
For more information, see Enable Access Logs in the Classic Load Balancers Guide.
" + "LoadBalancerAttributes$AccessLog": "If enabled, the load balancer captures detailed information of all requests and delivers the information to the Amazon S3 bucket that you specify.
For more information, see Enable Access Logs in the Classic Load Balancers Guide.
" } }, "AccessLogEnabled": { @@ -125,7 +125,7 @@ } }, "AdditionalAttribute": { - "base": "This data type is reserved.
", + "base": "Information about additional load balancer attributes.
", "refs": { "AdditionalAttributes$member": null } @@ -133,19 +133,19 @@ "AdditionalAttributeKey": { "base": null, "refs": { - "AdditionalAttribute$Key": "This parameter is reserved.
" + "AdditionalAttribute$Key": "The name of the attribute.
The following attribute is supported.
elb.http.desyncmitigationmode - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are monitor, defensive, and strictest. The default is defensive.
This parameter is reserved.
" + "AdditionalAttribute$Value": "This value of the attribute.
" } }, "AdditionalAttributes": { "base": null, "refs": { - "LoadBalancerAttributes$AdditionalAttributes": "This parameter is reserved.
" + "LoadBalancerAttributes$AdditionalAttributes": "Any additional attributes.
" } }, "AppCookieStickinessPolicies": { @@ -254,7 +254,7 @@ "ConnectionDraining": { "base": "Information about the ConnectionDraining attribute.
If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
For more information, see Configure Connection Draining in the Classic Load Balancers Guide.
" + "LoadBalancerAttributes$ConnectionDraining": "If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.
For more information, see Configure Connection Draining in the Classic Load Balancers Guide.
" } }, "ConnectionDrainingEnabled": { @@ -272,7 +272,7 @@ "ConnectionSettings": { "base": "Information about the ConnectionSettings attribute.
If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure Idle Connection Timeout in the Classic Load Balancers Guide.
" + "LoadBalancerAttributes$ConnectionSettings": "If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.
By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure Idle Connection Timeout in the Classic Load Balancers Guide.
" } }, "CookieExpirationPeriod": { @@ -348,7 +348,7 @@ "CrossZoneLoadBalancing": { "base": "Information about the CrossZoneLoadBalancing attribute.
If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
For more information, see Configure Cross-Zone Load Balancing in the Classic Load Balancers Guide.
" + "LoadBalancerAttributes$CrossZoneLoadBalancing": "If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
For more information, see Configure Cross-Zone Load Balancing in the Classic Load Balancers Guide.
" } }, "CrossZoneLoadBalancingEnabled": { @@ -362,7 +362,7 @@ "refs": { "CreateAccessPointOutput$DNSName": "The DNS name of the load balancer.
", "LoadBalancerDescription$DNSName": "The DNS name of the load balancer.
", - "LoadBalancerDescription$CanonicalHostedZoneName": "The DNS name of the load balancer.
For more information, see Configure a Custom Domain Name in the Classic Load Balancers Guide.
", + "LoadBalancerDescription$CanonicalHostedZoneName": "The DNS name of the load balancer.
For more information, see Configure a Custom Domain Name in the Classic Load Balancers Guide.
", "LoadBalancerDescription$CanonicalHostedZoneNameID": "The ID of the Amazon Route 53 hosted zone for the load balancer.
" } }, @@ -662,7 +662,7 @@ } }, "Listener": { - "base": "Information about a listener.
For information about the protocols and the ports supported by Elastic Load Balancing, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.
", + "base": "Information about a listener.
For information about the protocols and the ports supported by Elastic Load Balancing, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.
", "refs": { "ListenerDescription$Listener": "The listener.
", "Listeners$member": null @@ -688,7 +688,7 @@ "Listeners": { "base": null, "refs": { - "CreateAccessPointInput$Listeners": "The listeners.
For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.
", + "CreateAccessPointInput$Listeners": "The listeners.
For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.
", "CreateLoadBalancerListenerInput$Listeners": "The listeners.
" } }, @@ -734,7 +734,7 @@ "LoadBalancerScheme": { "base": null, "refs": { - "CreateAccessPointInput$Scheme": "The type of a load balancer. Valid only for load balancers in a VPC.
By default, Elastic Load Balancing creates an Internet-facing load balancer with a DNS name that resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Load Balancer Scheme in the Elastic Load Balancing User Guide.
Specify internal to create a load balancer with a DNS name that resolves to private IP addresses.
The type of a load balancer. Valid only for load balancers in a VPC.
By default, Elastic Load Balancing creates an Internet-facing load balancer with a DNS name that resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Load Balancer Scheme in the Elastic Load Balancing User Guide.
Specify internal to create a load balancer with a DNS name that resolves to private IP addresses.
The type of load balancer. Valid only for load balancers in a VPC.
If Scheme is internet-facing, the load balancer has a public DNS name that resolves to a public IP address.
If Scheme is internal, the load balancer has a public DNS name that resolves to a private IP address.
The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
", - "Listener$InstanceProtocol": "The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.
If the front-end protocol is HTTP, HTTPS, TCP, or SSL, InstanceProtocol must be at the same protocol.
If there is another listener with the same InstancePort whose InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure.
If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP.
The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.
If the front-end protocol is TCP or SSL, the back-end protocol must be TCP or SSL. If the front-end protocol is HTTP or HTTPS, the back-end protocol must be HTTP or HTTPS.
If there is another listener with the same InstancePort whose InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure.
If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP.
The tags.
", - "CreateAccessPointInput$Tags": "A list of tags to assign to the load balancer.
For more information about tagging your load balancer, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide.
", + "CreateAccessPointInput$Tags": "A list of tags to assign to the load balancer.
For more information about tagging your load balancer, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide.
", "TagDescription$Tags": "The tags.
" } }, diff --git a/models/apis/elasticloadbalancingv2/2015-12-01/docs-2.json b/models/apis/elasticloadbalancingv2/2015-12-01/docs-2.json index 99554e2fce..8e4a749376 100644 --- a/models/apis/elasticloadbalancingv2/2015-12-01/docs-2.json +++ b/models/apis/elasticloadbalancingv2/2015-12-01/docs-2.json @@ -6,11 +6,11 @@ "AddTags": "Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, and your target groups.
Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value.
To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags.
", "CreateListener": "Creates a listener for the specified Application Load Balancer or Network Load Balancer.
To update a listener, use ModifyListener. When you are finished with a listener, you can delete it using DeleteListener. If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer.
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.
For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide and Listeners for Your Network Load Balancers in the Network Load Balancers Guide.
", "CreateLoadBalancer": "Creates an Application Load Balancer or a Network Load Balancer.
When you create a load balancer, you can specify security groups, public subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups, SetSubnets, SetIpAddressType, and AddTags.
To create listeners for your load balancer, use CreateListener. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.
For limit information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide and Limits for Your Network Load Balancer in the Network Load Balancers Guide.
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.
For more information, see Application Load Balancers in the Application Load Balancers Guide and Network Load Balancers in the Network Load Balancers Guide.
", - "CreateRule": "Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.
Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener Rules in the Application Load Balancers Guide.
To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.
", + "CreateRule": "Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.
Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener Rules in the Application Load Balancers Guide.
To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.
", "CreateTargetGroup": "Creates a target group.
To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth.
To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule.
To delete a target group, use DeleteTargetGroup.
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.
For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide.
", "DeleteListener": "Deletes the specified listener.
Alternatively, your listener is deleted when you delete the load balancer to which it is attached, using DeleteLoadBalancer.
", "DeleteLoadBalancer": "Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners.
You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.
Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.
", - "DeleteRule": "Deletes the specified rule.
", + "DeleteRule": "Deletes the specified rule.
You can't delete the default rule.
", "DeleteTargetGroup": "Deletes the specified target group.
You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks.
", "DeregisterTargets": "Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.
", "DescribeAccountLimits": "Describes the current Elastic Load Balancing resource limits for your AWS account.
For more information, see Limits for Your Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide.
", @@ -44,7 +44,7 @@ } }, "Action": { - "base": "Information about an action.
", + "base": "Information about an action.
Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect, and it must be the last action to be performed.
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first. The last action to be performed must be one of the following types of actions: a forward, fixed-response, or redirect.
The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.
" } }, "ActionTypeEnum": { @@ -785,7 +785,7 @@ "HttpHeaderConditionConfig$Values": "One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If the same header appears multiple times in the request, we search them in order until a match is found.
If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.
", "HttpRequestMethodConditionConfig$Values": "The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.
If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.
", "PathPatternConditionConfig$Values": "One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).
If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use QueryStringConditionConfig.
", - "RuleCondition$Values": "The condition value. You can use Values if the rule contains only host-header and path-pattern conditions. Otherwise, you can use HostHeaderConfig for host-header conditions and PathPatternConfig for path-pattern conditions.
If Field is host-header, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.
A-Z, a-z, 0-9
- .
* (matches 0 or more characters)
? (matches exactly 1 character)
If Field is path-pattern, you can specify a single path pattern (for example, /img/*). A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.
A-Z, a-z, 0-9
_ - . $ / ~ \" ' @ : +
& (using &)
* (matches 0 or more characters)
? (matches exactly 1 character)
The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig.
If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.
A-Z, a-z, 0-9
- .
* (matches 0 or more characters)
? (matches exactly 1 character)
If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/*) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.
A-Z, a-z, 0-9
_ - . $ / ~ \" ' @ : +
& (using &)
* (matches 0 or more characters)
? (matches exactly 1 character)
One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.
If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig.
" } }, @@ -879,7 +879,7 @@ "LoadBalancerAttributeKey": { "base": null, "refs": { - "LoadBalancerAttribute$Key": "The name of the attribute.
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false.
access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.
access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs.
deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.
The following attributes are supported by only Application Load Balancers:
idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.
routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true) or routed to targets (false). The default is false.
routing.http2.enabled - Indicates whether HTTP/2 is enabled. The value is true or false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.
The following attributes are supported by only Network Load Balancers:
load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The value is true or false. The default is false.
The name of the attribute.
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false.
access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.
access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs.
deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.
The following attributes are supported by only Application Load Balancers:
idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.
routing.http.desync_mitigation_mode - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are monitor, defensive, and strictest. The default is defensive.
routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true) or routed to targets (false). The default is false.
routing.http2.enabled - Indicates whether HTTP/2 is enabled. The value is true or false. The default is true. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.
The following attributes are supported by only Network Load Balancers:
load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The value is true or false. The default is false.
Information to use when checking for a successful response from a target.
", "refs": { "CreateTargetGroupInput$Matcher": "[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.
", - "ModifyTargetGroupInput$Matcher": "[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.
With Network Load Balancers, you can't modify this setting.
", + "ModifyTargetGroupInput$Matcher": "[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target. The possible values are from 200 to 499. You can specify multiple values (for example, \"200,202\") or a range of values (for example, \"200-299\"). The default is 200.
With Network Load Balancers, you can't modify this setting.
", "TargetGroup$Matcher": "The HTTP codes to use when checking for a successful response from a target.
" } }, @@ -1237,7 +1237,7 @@ } }, "RuleCondition": { - "base": "Information about a condition for a rule.
", + "base": "Information about a condition for a rule.
Each rule can optionally include up to one of each of the following conditions: http-request-method, host-header, path-pattern, and source-ip. Each rule can also optionally include one or more of each of the following conditions: http-header and query-string.
The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.
The conditions. Each rule can optionally include up to one of each of the following conditions: http-request-method, host-header, path-pattern, and source-ip. Each rule can also optionally include one or more of each of the following conditions: http-header and query-string.
The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.
The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.
The name of the attribute.
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported.
stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false. The default is false.
stickiness.type - The type of sticky sessions. The possible values are lb_cookie for Application Load Balancers or source_ip for Network Load Balancers.
The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address:
load_balancing.algorithm.type - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is round_robin or least_outstanding_requests. The default is round_robin.
slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). Slow start mode is disabled by default.
stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function:
lambda.multi_value_headers.enabled - Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is true or false. The default is false. If the value is false and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client.
The following attribute is supported only by Network Load Balancers:
proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false.
The name of the attribute.
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported.
stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false. The default is false.
stickiness.type - The type of sticky sessions. The possible values are lb_cookie for Application Load Balancers or source_ip for Network Load Balancers.
The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address:
load_balancing.algorithm.type - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is round_robin or least_outstanding_requests. The default is round_robin.
slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled).
stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function:
lambda.multi_value_headers.enabled - Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is true or false. The default is false. If the value is false and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client.
The following attribute is supported only by Network Load Balancers:
proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false.
The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
instance - Targets are specified by instance ID. This is the default value. If the target group protocol is UDP or TCP_UDP, the target type must be instance.
ip - Targets are specified by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.
lambda - The target groups contains a single Lambda function.
The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
instance - Targets are specified by instance ID. This is the default value.
ip - Targets are specified by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.
lambda - The target groups contains a single Lambda function.
The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address).
Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.
", "operations": { "AddTagsToStream": "Adds or updates tags for the specified Kinesis data stream. Each time you invoke this operation, you can specify up to 10 tags. If you want to add more than 10 tags to your stream, you can invoke this operation multiple times. In total, each stream can have up to 50 tags.
If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys.
AddTagsToStream has a limit of five transactions per second per account.
", - "CreateStream": "Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.
You specify and control the number of shards that a stream is composed of. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. If the amount of data input increases or decreases, you can add or remove shards.
The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by AWS Region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different Regions, can have the same name.
CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Kinesis Data Streams immediately returns and sets the stream status to CREATING. After the stream is created, Kinesis Data Streams sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream.
You receive a LimitExceededException when making a CreateStream request when you try to do one of the following:
Have more than five streams in the CREATING state at any point in time.
Create more shards than are authorized for your account.
For the default shard limit for an AWS account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS Support.
You can use DescribeStream to check the stream status, which is returned in StreamStatus.
CreateStream has a limit of five transactions per second per account.
", + "CreateStream": "Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.
You specify and control the number of shards that a stream is composed of. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second. If the amount of data input increases or decreases, you can add or remove shards.
The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by AWS Region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different Regions, can have the same name.
CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Kinesis Data Streams immediately returns and sets the stream status to CREATING. After the stream is created, Kinesis Data Streams sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream.
You receive a LimitExceededException when making a CreateStream request when you try to do one of the following:
Have more than five streams in the CREATING state at any point in time.
Create more shards than are authorized for your account.
For the default shard limit for an AWS account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS Support.
You can use DescribeStream to check the stream status, which is returned in StreamStatus.
CreateStream has a limit of five transactions per second per account.
", "DecreaseStreamRetentionPeriod": "Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.
This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.
", "DeleteStream": "Deletes a Kinesis data stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it receives the exception ResourceNotFoundException.
If the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.
Note: Kinesis Data Streams might continue to accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the DELETING state until the stream deletion is complete.
When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.
You can use the DescribeStream operation to check the state of the stream, which is returned in StreamStatus.
DeleteStream has a limit of five transactions per second per account.
", - "DeregisterStreamConsumer": "To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its name and ARN.
This operation has a limit of five transactions per second per account.
", + "DeregisterStreamConsumer": "To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its name and ARN.
This operation has a limit of five transactions per second per stream.
", "DescribeLimits": "Describes the shard limits and usage for the account.
If you update your account limits, the old limits might be returned for a few minutes.
This operation has a limit of one transaction per second per account.
", - "DescribeStream": "Describes the specified Kinesis data stream.
The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.
You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream in the Amazon Kinesis Data Streams Developer Guide.
There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.
This operation has a limit of 10 transactions per second per account.
", - "DescribeStreamConsumer": "To get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to describe, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream.
This operation has a limit of 20 transactions per second per account.
", - "DescribeStreamSummary": "Provides a summarized description of the specified Kinesis data stream without the shard list.
The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count.
", + "DescribeStream": "Describes the specified Kinesis data stream.
The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.
You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream in the Amazon Kinesis Data Streams Developer Guide.
There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.
This operation has a limit of 10 transactions per second per account.
", + "DescribeStreamConsumer": "To get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to describe, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream.
This operation has a limit of 20 transactions per second per stream.
", + "DescribeStreamSummary": "Provides a summarized description of the specified Kinesis data stream without the shard list.
The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count.
DescribeStreamSummary has a limit of 20 transactions per second per account.
", "DisableEnhancedMonitoring": "Disables enhanced monitoring.
", "EnableEnhancedMonitoring": "Enables enhanced Kinesis data stream monitoring for shard-level metrics.
", - "GetRecords": "Gets data records from a Kinesis data stream's shard.
Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. It might take multiple calls to get to a portion of the shard that contains records.
You can scale by provisioning multiple shards per stream while considering service limits (for more information, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in NextShardIterator. Specify the shard iterator returned in NextShardIterator in subsequent calls to GetRecords. If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.
Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit. The maximum number of records that can be returned per call is 10,000.
The size of the data returned by GetRecords varies depending on the utilization of the shard. The maximum size of data that GetRecords can return is 10 MiB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw ProvisionedThroughputExceededException. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next 1 second throw ProvisionedThroughputExceededException. GetRecords doesn't return any data when it throws an exception. For this reason, we recommend that you wait 1 second between calls to GetRecords. However, it's possible that the application will get exceptions for longer than 1 second.
To detect whether the application is falling behind in processing, you can use the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon Kinesis Data Streams Developer Guide).
Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side time stamp, whereas a client-side time stamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with PutRecords). The time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order.
This operation has a limit of five transactions per second per account.
", - "GetShardIterator": "Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is returned to the requester.
A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.
You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type. Alternatively, the parameter can read right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier calls to PutRecord, PutRecords, GetRecords, or DescribeStream. In the request, you can specify the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in time, TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or LATEST so that you always read the most recent data in the shard.
When you read repeatedly from a stream, use a GetShardIterator request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard iterator is returned by every GetRecords request in NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords request.
If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException. For more information about throughput limits, see GetRecords, and Streams Limits in the Amazon Kinesis Data Streams Developer Guide.
If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using SplitShard or MergeShards.
GetShardIterator has a limit of five transactions per second per account per open shard.
", + "GetRecords": "Gets data records from a Kinesis data stream's shard.
Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. It might take multiple calls to get to a portion of the shard that contains records.
You can scale by provisioning multiple shards per stream while considering service limits (for more information, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in NextShardIterator. Specify the shard iterator returned in NextShardIterator in subsequent calls to GetRecords. If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.
Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit. The maximum number of records that can be returned per call is 10,000.
The size of the data returned by GetRecords varies depending on the utilization of the shard. The maximum size of data that GetRecords can return is 10 MiB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw ProvisionedThroughputExceededException. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next 1 second throw ProvisionedThroughputExceededException. GetRecords doesn't return any data when it throws an exception. For this reason, we recommend that you wait 1 second between calls to GetRecords. However, it's possible that the application will get exceptions for longer than 1 second.
To detect whether the application is falling behind in processing, you can use the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon Kinesis Data Streams Developer Guide).
Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side time stamp, whereas a client-side time stamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with PutRecords). The time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order.
This operation has a limit of five transactions per second per shard.
", + "GetShardIterator": "Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is returned to the requester.
A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.
You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type. Alternatively, the parameter can read right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier calls to PutRecord, PutRecords, GetRecords, or DescribeStream. In the request, you can specify the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in time, TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or LATEST so that you always read the most recent data in the shard.
When you read repeatedly from a stream, use a GetShardIterator request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard iterator is returned by every GetRecords request in NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords request.
If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException. For more information about throughput limits, see GetRecords, and Streams Limits in the Amazon Kinesis Data Streams Developer Guide.
If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using SplitShard or MergeShards.
GetShardIterator has a limit of five transactions per second per account per open shard.
", "IncreaseStreamRetentionPeriod": "Increases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours (7 days).
If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours remains inaccessible to consumer applications.
", "ListShards": "Lists the shards in a stream and provides information about each shard. This operation has a limit of 100 transactions per second per data stream.
This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.
Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer.
This operation has a limit of 10 transactions per second per account.
", + "ListStreamConsumers": "Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer.
This operation has a limit of 5 transactions per second per stream.
", "ListStreams": "Lists your Kinesis data streams.
The number of streams may be too large to return from a single call to ListStreams. You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Kinesis Data Streams uses the default limit, which is currently 10.
You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list.
ListStreams has a limit of five transactions per second per account.
", "ListTagsForStream": "Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account.
", - "MergeShards": "Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.
MergeShards is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see Merge Two Shards in the Amazon Kinesis Data Streams Developer Guide.
If the stream is in the ACTIVE state, you can call MergeShards. If a stream is in the CREATING, UPDATING, or DELETING state, MergeShards returns a ResourceInUseException. If the specified stream does not exist, MergeShards returns a ResourceNotFoundException.
You can use DescribeStream to check the state of the stream, which is returned in StreamStatus.
MergeShards is an asynchronous operation. Upon receiving a MergeShards request, Amazon Kinesis Data Streams immediately returns a response and sets the StreamStatus to UPDATING. After the operation is completed, Kinesis Data Streams sets the StreamStatus to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.
You use DescribeStream to determine the shard IDs that are specified in the MergeShards request.
If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards, or SplitShard, you receive a LimitExceededException.
MergeShards has a limit of five transactions per second per account.
Writes a single data record into an Amazon Kinesis data stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.
You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.
The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.
The partition key is used by Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs.
Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.
PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.
Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.
If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException.
By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
", - "PutRecords": "Writes multiple data records into a Kinesis data stream in a single call (also referred to as a PutRecords request). Use this operation to send data into the stream for data ingestion and processing.
Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.
You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.
The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.
The partition key is used by Kinesis Data Streams as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.
Each record in the Records array may include an optional parameter, ExplicitHashKey, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide.
The PutRecords response includes an array of response Records. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array.
The response Records array includes both successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records.
A successfully processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream.
An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide.
By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
", - "RegisterStreamConsumer": "Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can read data from the stream at a rate of up to 2 MiB per second. This rate is unaffected by the total number of consumers that read from the same stream.
You can register up to 5 consumers per stream. A given consumer can only be registered with one stream.
This operation has a limit of five transactions per second per account.
", + "MergeShards": "Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.
MergeShards is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see Merge Two Shards in the Amazon Kinesis Data Streams Developer Guide.
If the stream is in the ACTIVE state, you can call MergeShards. If a stream is in the CREATING, UPDATING, or DELETING state, MergeShards returns a ResourceInUseException. If the specified stream does not exist, MergeShards returns a ResourceNotFoundException.
You can use DescribeStream to check the state of the stream, which is returned in StreamStatus.
MergeShards is an asynchronous operation. Upon receiving a MergeShards request, Amazon Kinesis Data Streams immediately returns a response and sets the StreamStatus to UPDATING. After the operation is completed, Kinesis Data Streams sets the StreamStatus to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.
You use DescribeStream to determine the shard IDs that are specified in the MergeShards request.
If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards, or SplitShard, you receive a LimitExceededException.
MergeShards has a limit of five transactions per second per account.
Writes a single data record into an Amazon Kinesis data stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second.
You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.
The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.
The partition key is used by Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs.
Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.
PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.
Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.
After you write a record to a stream, you cannot modify that record or its order within the stream.
If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException.
By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
", + "PutRecords": "Writes multiple data records into a Kinesis data stream in a single call (also referred to as a PutRecords request). Use this operation to send data into the stream for data ingestion and processing.
Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second.
You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.
The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.
The partition key is used by Kinesis Data Streams as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.
Each record in the Records array may include an optional parameter, ExplicitHashKey, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide.
The PutRecords response includes an array of response Records. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array.
The response Records array includes both successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering of records. If you need to read records in the same order they are written to the stream, use PutRecord instead of PutRecords, and write to the same shard.
A successfully processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream.
An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide.
After you write a record to a stream, you cannot modify that record or its order within the stream.
By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
", + "RegisterStreamConsumer": "Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.
You can register up to 20 consumers per stream. A given consumer can only be registered with one stream at a time.
For an example of how to use this operations, see Enhanced Fan-Out Using the Kinesis Data Streams API.
The use of this operation has a limit of five transactions per second per account. Also, only 5 consumers can be created simultaneously. In other words, you cannot have more than 5 consumers in a CREATING status at the same time. Registering a 6th consumer while there are 5 in a CREATING status results in a LimitExceededException.
Removes tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes.
If you specify a tag that does not exist, it is ignored.
RemoveTagsFromStream has a limit of five transactions per second per account.
", - "SplitShard": "Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data. SplitShard is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested.
You can also use SplitShard when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call SplitShard to increase stream capacity, so that more Kinesis Data Streams applications can simultaneously read data from the stream for real-time processing.
You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information, see Split a Shard in the Amazon Kinesis Data Streams Developer Guide.
You can use DescribeStream to determine the shard ID and hash key values for the ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request.
SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Kinesis Data Streams immediately returns a response and sets the stream status to UPDATING. After the operation is completed, Kinesis Data Streams sets the stream status to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.
You can use DescribeStream to check the status of the stream, which is returned in StreamStatus. If the stream is in the ACTIVE state, you can call SplitShard. If a stream is in CREATING or UPDATING or DELETING states, DescribeStream returns a ResourceInUseException.
If the specified stream does not exist, DescribeStream returns a ResourceNotFoundException. If you try to create more shards than are authorized for your account, you receive a LimitExceededException.
For the default shard limit for an AWS account, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS Support.
If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException.
SplitShard has a limit of five transactions per second per account.
Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data. SplitShard is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested.
You can also use SplitShard when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call SplitShard to increase stream capacity, so that more Kinesis Data Streams applications can simultaneously read data from the stream for real-time processing.
You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information, see Split a Shard in the Amazon Kinesis Data Streams Developer Guide.
You can use DescribeStream to determine the shard ID and hash key values for the ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request.
SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Kinesis Data Streams immediately returns a response and sets the stream status to UPDATING. After the operation is completed, Kinesis Data Streams sets the stream status to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.
You can use DescribeStream to check the status of the stream, which is returned in StreamStatus. If the stream is in the ACTIVE state, you can call SplitShard. If a stream is in CREATING or UPDATING or DELETING states, DescribeStream returns a ResourceInUseException.
If the specified stream does not exist, DescribeStream returns a ResourceNotFoundException. If you try to create more shards than are authorized for your account, you receive a LimitExceededException.
For the default shard limit for an AWS account, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS Support.
If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException.
SplitShard has a limit of five transactions per second per account.
Enables or updates server-side encryption using an AWS KMS key for a specified stream.
Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, encryption begins for records written to the stream.
API Limits: You can successfully apply a new AWS KMS key for server-side encryption 25 times in a rolling 24-hour period.
Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from PutRecord or PutRecords.
Disables server-side encryption for a specified stream.
Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Stopping encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, records written to the stream are no longer encrypted by Kinesis Data Streams.
API Limits: You can successfully disable server-side encryption 25 times in a rolling 24-hour period.
Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are no longer subject to encryption. After you disabled encryption, you can verify that encryption is not applied by inspecting the API response from PutRecord or PutRecords.
Call this operation from your consumer after you call RegisterStreamConsumer to register the consumer with Kinesis Data Streams. If the call succeeds, your consumer starts receiving events of type SubscribeToShardEvent for up to 5 minutes, after which time you need to call SubscribeToShard again to renew the subscription if you want to continue to receive records.
You can make one call to SubscribeToShard per second per ConsumerARN. If your call succeeds, and then you call the operation again less than 5 seconds later, the second call generates a ResourceInUseException. If you call the operation a second time more than 5 seconds after the first call succeeds, the second call succeeds and the first connection gets shut down.
Updates the shard count of the specified stream to the specified number of shards.
Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is UPDATING.
To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. We recommend that you double or halve the shard count, as this results in the fewest number of splits or merges.
This operation has the following default limits. By default, you cannot do the following:
Scale more than twice per rolling 24-hour period per stream
Scale up to more than double your current shard count for a stream
Scale down below half your current shard count for a stream
Scale up to more than 500 shards in a stream
Scale a stream with more than 500 shards down unless the result is less than 500 shards
Scale up to more than the shard limit for your account
For the default limits for an AWS account, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the limits form.
" + "SubscribeToShard": "This operation establishes an HTTP/2 connection between the consumer you specify in the ConsumerARN parameter and the shard you specify in the ShardId parameter. After the connection is successfully established, Kinesis Data Streams pushes records from the shard to the consumer over this connection. Before you call this operation, call RegisterStreamConsumer to register the consumer with Kinesis Data Streams.
When the SubscribeToShard call succeeds, your consumer starts receiving events of type SubscribeToShardEvent over the HTTP/2 connection for up to 5 minutes, after which time you need to call SubscribeToShard again to renew the subscription if you want to continue to receive records.
You can make one call to SubscribeToShard per second per registered consumer per shard. For example, if you have a 4000 shard stream and two registered stream consumers, you can make one SubscribeToShard request per second for each combination of shard and registered consumer, allowing you to subscribe both consumers to all 4000 shards in one second.
If you call SubscribeToShard again with the same ConsumerARN and ShardId within 5 seconds of a successful call, you'll get a ResourceInUseException. If you call SubscribeToShard 5 seconds or more after a successful call, the first connection will expire and the second call will take over the subscription.
For an example of how to use this operations, see Enhanced Fan-Out Using the Kinesis Data Streams API.
", + "UpdateShardCount": "Updates the shard count of the specified stream to the specified number of shards.
Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is UPDATING.
To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. These short-lived shards count towards your total shard limit for your account in the Region.
When using this operation, we recommend that you specify a target shard count that is a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling action might take longer to complete.
This operation has the following default limits. By default, you cannot do the following:
Scale more than ten times per rolling 24-hour period per stream
Scale up to more than double your current shard count for a stream
Scale down below half your current shard count for a stream
Scale up to more than 500 shards in a stream
Scale a stream with more than 500 shards down unless the result is less than 500 shards
Scale up to more than the shard limit for your account
For the default limits for an AWS account, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the limits form.
" }, "shapes": { "AddTagsToStreamInput": { @@ -46,8 +46,21 @@ "StreamDescription$HasMoreShards": "If set to true, more shards in the stream are available to describe.
An object that represents the details of the consumer you registered.
", + "base": "An object that represents the details of the consumer you registered. This type of object is returned by RegisterStreamConsumer.
", "refs": { "ConsumerList$member": null, "RegisterStreamConsumerOutput$Consumer": "An object that represents the details of the consumer you registered. When you register a consumer, it gets an ARN that is generated by Kinesis Data Streams.
" @@ -70,7 +83,7 @@ } }, "ConsumerDescription": { - "base": "An object that represents the details of a registered consumer.
", + "base": "An object that represents the details of a registered consumer. This type of object is returned by DescribeStreamConsumer.
", "refs": { "DescribeStreamConsumerOutput$ConsumerDescription": "An object that represents the details of the consumer.
" } @@ -106,9 +119,9 @@ "Data": { "base": null, "refs": { - "PutRecordInput$Data": "The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
", - "PutRecordsRequestEntry$Data": "The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
", - "Record$Data": "The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
" + "PutRecordInput$Data": "The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MiB).
", + "PutRecordsRequestEntry$Data": "The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MiB).
", + "Record$Data": "The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MiB).
" } }, "DecreaseStreamRetentionPeriodInput": { @@ -256,7 +269,7 @@ "GetRecordsInputLimit": { "base": null, "refs": { - "GetRecordsInput$Limit": "The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.
The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException. The default value is 10,000.
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
", "refs": { + "ChildShard$HashKeyRange": null, "Shard$HashKeyRange": "The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
" } }, @@ -296,9 +310,9 @@ } }, "InternalFailureException": { - "base": null, + "base": "The processing of the request failed because of an unknown error, exception, or failure.
", "refs": { - "SubscribeToShardEventStream$InternalFailureException": null + "SubscribeToShardEventStream$InternalFailureException": "The processing of the request failed because of an unknown error, exception, or failure.
" } }, "InvalidArgumentException": { @@ -319,7 +333,7 @@ } }, "KMSInvalidStateException": { - "base": "The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
", + "base": "The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
", "refs": { "SubscribeToShardEventStream$KMSInvalidStateException": null } @@ -337,7 +351,7 @@ } }, "KMSThrottlingException": { - "base": "The request was denied due to request throttling. For more information about throttling, see Limits in the AWS Key Management Service Developer Guide.
", + "base": "The request was denied due to request throttling. For more information about throttling, see Limits in the AWS Key Management Service Developer Guide.
", "refs": { "SubscribeToShardEventStream$KMSThrottlingException": null } @@ -364,7 +378,7 @@ "ListShardsInputLimit": { "base": null, "refs": { - "ListShardsInput$MaxResults": "The maximum number of shards to return in a single call to ListShards. The minimum value you can specify for this parameter is 1, and the maximum is 1,000, which is also the default.
When the number of shards to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListShards to list the next set of shards.
The maximum number of shards to return in a single call to ListShards. The minimum value you can specify for this parameter is 1, and the maximum is 10,000, which is also the default.
When the number of shards to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListShards to list the next set of shards.
List of shard-level metrics to disable.
The following are the valid shard-level metrics. The value \"ALL\" disables every metric.
IncomingBytes
IncomingRecords
OutgoingBytes
OutgoingRecords
WriteProvisionedThroughputExceeded
ReadProvisionedThroughputExceeded
IteratorAgeMilliseconds
ALL
For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.
", - "EnableEnhancedMonitoringInput$ShardLevelMetrics": "List of shard-level metrics to enable.
The following are the valid shard-level metrics. The value \"ALL\" enables every metric.
IncomingBytes
IncomingRecords
OutgoingBytes
OutgoingRecords
WriteProvisionedThroughputExceeded
ReadProvisionedThroughputExceeded
IteratorAgeMilliseconds
ALL
For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.
", - "EnhancedMetrics$ShardLevelMetrics": "List of shard-level metrics.
The following are the valid shard-level metrics. The value \"ALL\" enhances every metric.
IncomingBytes
IncomingRecords
OutgoingBytes
OutgoingRecords
WriteProvisionedThroughputExceeded
ReadProvisionedThroughputExceeded
IteratorAgeMilliseconds
ALL
For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.
", + "DisableEnhancedMonitoringInput$ShardLevelMetrics": "List of shard-level metrics to disable.
The following are the valid shard-level metrics. The value \"ALL\" disables every metric.
IncomingBytes
IncomingRecords
OutgoingBytes
OutgoingRecords
WriteProvisionedThroughputExceeded
ReadProvisionedThroughputExceeded
IteratorAgeMilliseconds
ALL
For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.
", + "EnableEnhancedMonitoringInput$ShardLevelMetrics": "List of shard-level metrics to enable.
The following are the valid shard-level metrics. The value \"ALL\" enables every metric.
IncomingBytes
IncomingRecords
OutgoingBytes
OutgoingRecords
WriteProvisionedThroughputExceeded
ReadProvisionedThroughputExceeded
IteratorAgeMilliseconds
ALL
For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.
", + "EnhancedMetrics$ShardLevelMetrics": "List of shard-level metrics.
The following are the valid shard-level metrics. The value \"ALL\" enhances every metric.
IncomingBytes
IncomingRecords
OutgoingBytes
OutgoingRecords
WriteProvisionedThroughputExceeded
ReadProvisionedThroughputExceeded
IteratorAgeMilliseconds
ALL
For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.
", "EnhancedMonitoringOutput$CurrentShardLevelMetrics": "Represents the current state of the metrics that are in the enhanced state before the operation.
", "EnhancedMonitoringOutput$DesiredShardLevelMetrics": "Represents the list of all the metrics that would be in the enhanced state after the operation.
" } @@ -468,16 +482,15 @@ "PositiveIntegerObject": { "base": null, "refs": { - "CreateStreamInput$ShardCount": "The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.
DefaultShardLimit;
", + "CreateStreamInput$ShardCount": "The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.
", "PutRecordsOutput$FailedRecordCount": "The number of unsuccessfully processed records in a PutRecords request.
The current retention period, in hours.
", - "UpdateShardCountInput$TargetShardCount": "The new number of shards.
", + "UpdateShardCountInput$TargetShardCount": "The new number of shards. This value has the following default limits. By default, you cannot do the following:
Set this value to more than double your current shard count for a stream.
Set this value below half your current shard count for a stream.
Set this value to more than 500 shards in a stream (the default limit for shard count per stream is 500 per account per region), unless you request a limit increase.
Scale a stream with more than 500 shards down unless you set this value to less than 500 shards.
The current number of shards.
", "UpdateShardCountOutput$TargetShardCount": "The updated number of shards.
" } }, "ProvisionedThroughputExceededException": { - "base": "The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in AWS in the AWS General Reference.
", + "base": "The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in AWS in the AWS General Reference.
", "refs": { } }, @@ -570,7 +583,8 @@ "refs": { "DecreaseStreamRetentionPeriodInput$RetentionPeriodHours": "The new retention period of the stream, in hours. Must be less than the current retention period.
", "IncreaseStreamRetentionPeriodInput$RetentionPeriodHours": "The new retention period of the stream, in hours. Must be more than the current retention period.
", - "StreamDescription$RetentionPeriodHours": "The current retention period, in hours.
" + "StreamDescription$RetentionPeriodHours": "The current retention period, in hours. Minimum value of 24. Maximum value of 168.
", + "StreamDescriptionSummary$RetentionPeriodHours": "The current retention period, in hours.
" } }, "ScalingType": { @@ -589,8 +603,8 @@ "Record$SequenceNumber": "The unique identifier of the record within its shard.
", "SequenceNumberRange$StartingSequenceNumber": "The starting sequence number for the range.
", "SequenceNumberRange$EndingSequenceNumber": "The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.
Use this as StartingSequenceNumber in the next call to SubscribeToShard.
The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.
Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.
The number of open shards in the stream.
" } }, + "ShardFilter": { + "base": null, + "refs": { + "ListShardsInput$ShardFilter": null + } + }, + "ShardFilterType": { + "base": null, + "refs": { + "ShardFilter$Type": null + } + }, "ShardId": { "base": null, "refs": { + "ChildShard$ShardId": null, "DescribeStreamInput$ExclusiveStartShardId": "The shard ID of the shard to start with.
", "GetShardIteratorInput$ShardId": "The shard ID of the Kinesis Data Streams shard to get the iterator for.
", "ListShardsInput$ExclusiveStartShardId": "Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately follows ExclusiveStartShardId.
If you don't specify this parameter, the default behavior is for ListShards to list the shards starting with the first one in the stream.
You cannot specify this parameter if you specify NextToken.
The unique identifier of the shard within the stream.
", "Shard$ParentShardId": "The shard ID of the shard's parent.
", "Shard$AdjacentParentShardId": "The shard ID of the shard adjacent to the shard's parent.
", + "ShardFilter$ShardId": null, + "ShardIdList$member": null, "SplitShardInput$ShardToSplit": "The shard ID of the shard to split.
", "SubscribeToShardInput$ShardId": "The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.
" } }, + "ShardIdList": { + "base": null, + "refs": { + "ChildShard$ParentShards": null + } + }, "ShardIterator": { "base": null, "refs": { @@ -642,7 +677,7 @@ "base": null, "refs": { "GetShardIteratorInput$ShardIteratorType": "Determines how the shard iterator is used to start reading data records from the shard.
The following are the valid Amazon Kinesis shard iterator types:
AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.
AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.
AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.
TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.
LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.
You can set the starting position to one of the following values:
AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the sequence number specified in the SequenceNumber field.
AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.
AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp field.
TRIM_HORIZON: Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard.
LATEST: Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard.
After you call SubscribeToShard, Kinesis Data Streams sends events of this type to your consumer.
", + "base": "After you call SubscribeToShard, Kinesis Data Streams sends events of this type over an HTTP/2 connection to your consumer.
", "refs": { - "SubscribeToShardEventStream$SubscribeToShardEvent": null + "SubscribeToShardEventStream$SubscribeToShardEvent": "After you call SubscribeToShard, Kinesis Data Streams sends events of this type to your consumer. For an example of how to handle these events, see Enhanced Fan-Out Using the Kinesis Data Streams API.
" } }, "SubscribeToShardEventStream": { - "base": null, + "base": "This is a tagged union for all of the types of events an enhanced fan-out consumer can receive over HTTP/2 after a call to SubscribeToShard.
", "refs": { "SubscribeToShardOutput$EventStream": "The event stream that your consumer can use to read records from the shard.
" } @@ -812,7 +847,8 @@ "ListShardsInput$StreamCreationTimestamp": "Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.
You cannot specify this parameter if you specify the NextToken parameter.
Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for.
You can't specify this parameter if you specify the NextToken parameter.
", "Record$ApproximateArrivalTimestamp": "The approximate time that the record was inserted into the stream.
", - "StartingPosition$Timestamp": null, + "ShardFilter$Timestamp": null, + "StartingPosition$Timestamp": "The time stamp of the data record from which to start reading. To specify a time stamp, set StartingPosition to Type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact time stamp does not exist, records will be streamed from the next (later) record. If the time stamp is older than the current trim horizon, records will be streamed from the oldest untrimmed data record (TRIM_HORIZON).
The approximate time that the stream was created.
", "StreamDescriptionSummary$StreamCreationTimestamp": "The approximate time that the stream was created.
" } diff --git a/models/apis/quicksight/2018-04-01/api-2.json b/models/apis/quicksight/2018-04-01/api-2.json index d1f61566fb..6f094ea4b0 100644 --- a/models/apis/quicksight/2018-04-01/api-2.json +++ b/models/apis/quicksight/2018-04-01/api-2.json @@ -46,6 +46,24 @@ {"shape":"ResourceUnavailableException"} ] }, + "CreateAnalysis":{ + "name":"CreateAnalysis", + "http":{ + "method":"POST", + "requestUri":"/accounts/{AwsAccountId}/analyses/{AnalysisId}" + }, + "input":{"shape":"CreateAnalysisRequest"}, + "output":{"shape":"CreateAnalysisResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ConflictException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, "CreateDashboard":{ "name":"CreateDashboard", "http":{ @@ -292,6 +310,23 @@ {"shape":"ResourceUnavailableException"} ] }, + "DeleteAnalysis":{ + "name":"DeleteAnalysis", + "http":{ + "method":"DELETE", + "requestUri":"/accounts/{AwsAccountId}/analyses/{AnalysisId}" + }, + "input":{"shape":"DeleteAnalysisRequest"}, + "output":{"shape":"DeleteAnalysisResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, "DeleteDashboard":{ "name":"DeleteDashboard", "http":{ @@ -552,6 +587,39 @@ {"shape":"ResourceUnavailableException"} ] }, + "DescribeAnalysis":{ + "name":"DescribeAnalysis", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/analyses/{AnalysisId}" + }, + "input":{"shape":"DescribeAnalysisRequest"}, + "output":{"shape":"DescribeAnalysisResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, + "DescribeAnalysisPermissions":{ + "name":"DescribeAnalysisPermissions", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions" + }, + "input":{"shape":"DescribeAnalysisPermissionsRequest"}, + "output":{"shape":"DescribeAnalysisPermissionsResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, "DescribeDashboard":{ "name":"DescribeDashboard", "http":{ @@ -881,6 +949,21 @@ {"shape":"InternalFailureException"} ] }, + "ListAnalyses":{ + "name":"ListAnalyses", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/analyses" + }, + "input":{"shape":"ListAnalysesRequest"}, + "output":{"shape":"ListAnalysesResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, "ListDashboardVersions":{ "name":"ListDashboardVersions", "http":{ @@ -1232,6 +1315,40 @@ {"shape":"ResourceUnavailableException"} ] }, + "RestoreAnalysis":{ + "name":"RestoreAnalysis", + "http":{ + "method":"POST", + "requestUri":"/accounts/{AwsAccountId}/restore/analyses/{AnalysisId}" + }, + "input":{"shape":"RestoreAnalysisRequest"}, + "output":{"shape":"RestoreAnalysisResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, + "SearchAnalyses":{ + "name":"SearchAnalyses", + "http":{ + "method":"POST", + "requestUri":"/accounts/{AwsAccountId}/search/analyses" + }, + "input":{"shape":"SearchAnalysesRequest"}, + "output":{"shape":"SearchAnalysesResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InternalFailureException"} + ] + }, "SearchDashboards":{ "name":"SearchDashboards", "http":{ @@ -1316,6 +1433,41 @@ {"shape":"ResourceUnavailableException"} ] }, + "UpdateAnalysis":{ + "name":"UpdateAnalysis", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{AwsAccountId}/analyses/{AnalysisId}" + }, + "input":{"shape":"UpdateAnalysisRequest"}, + "output":{"shape":"UpdateAnalysisResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ConflictException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ] + }, + "UpdateAnalysisPermissions":{ + "name":"UpdateAnalysisPermissions", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions" + }, + "input":{"shape":"UpdateAnalysisPermissionsRequest"}, + "output":{"shape":"UpdateAnalysisPermissionsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"ConflictException"}, + {"shape":"InternalFailureException"} + ] + }, "UpdateDashboard":{ "name":"UpdateDashboard", "http":{ @@ -1661,6 +1813,103 @@ "Domain":{"shape":"Domain"} } }, + "Analysis":{ + "type":"structure", + "members":{ + "AnalysisId":{"shape":"RestrictiveResourceId"}, + "Arn":{"shape":"Arn"}, + "Name":{"shape":"AnalysisName"}, + "Status":{"shape":"ResourceStatus"}, + "Errors":{"shape":"AnalysisErrorList"}, + "DataSetArns":{"shape":"DataSetArnsList"}, + "ThemeArn":{"shape":"Arn"}, + "CreatedTime":{"shape":"Timestamp"}, + "LastUpdatedTime":{"shape":"Timestamp"} + } + }, + "AnalysisError":{ + "type":"structure", + "members":{ + "Type":{"shape":"AnalysisErrorType"}, + "Message":{"shape":"NonEmptyString"} + } + }, + "AnalysisErrorList":{ + "type":"list", + "member":{"shape":"AnalysisError"}, + "min":1 + }, + "AnalysisErrorType":{ + "type":"string", + "enum":[ + "ACCESS_DENIED", + "SOURCE_NOT_FOUND", + "DATA_SET_NOT_FOUND", + "INTERNAL_FAILURE", + "PARAMETER_VALUE_INCOMPATIBLE", + "PARAMETER_TYPE_INVALID", + "PARAMETER_NOT_FOUND", + "COLUMN_TYPE_MISMATCH", + "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", + "COLUMN_REPLACEMENT_MISSING" + ] + }, + "AnalysisFilterAttribute":{ + "type":"string", + "enum":["QUICKSIGHT_USER"] + }, + "AnalysisName":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"[\\u0020-\\u00FF]+" + }, + "AnalysisSearchFilter":{ + "type":"structure", + "members":{ + "Operator":{"shape":"FilterOperator"}, + "Name":{"shape":"AnalysisFilterAttribute"}, + "Value":{"shape":"String"} + } + }, + "AnalysisSearchFilterList":{ + "type":"list", + "member":{"shape":"AnalysisSearchFilter"}, + "max":1 + }, + "AnalysisSourceEntity":{ + "type":"structure", + "members":{ + "SourceTemplate":{"shape":"AnalysisSourceTemplate"} + } + }, + "AnalysisSourceTemplate":{ + "type":"structure", + "required":[ + "DataSetReferences", + "Arn" + ], + "members":{ + "DataSetReferences":{"shape":"DataSetReferenceList"}, + "Arn":{"shape":"Arn"} + } + }, + "AnalysisSummary":{ + "type":"structure", + "members":{ + "Arn":{"shape":"Arn"}, + "AnalysisId":{"shape":"RestrictiveResourceId"}, + "Name":{"shape":"AnalysisName"}, + "Status":{"shape":"ResourceStatus"}, + "CreatedTime":{"shape":"Timestamp"}, + "LastUpdatedTime":{"shape":"Timestamp"} + } + }, + "AnalysisSummaryList":{ + "type":"list", + "member":{"shape":"AnalysisSummary"}, + "max":100 + }, "Arn":{"type":"string"}, "AssignmentStatus":{ "type":"string", @@ -1956,6 +2205,46 @@ } } }, + "CreateAnalysisRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "AnalysisId", + "Name", + "SourceEntity" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "AnalysisId":{ + "shape":"RestrictiveResourceId", + "location":"uri", + "locationName":"AnalysisId" + }, + "Name":{"shape":"AnalysisName"}, + "Parameters":{"shape":"Parameters"}, + "Permissions":{"shape":"ResourcePermissionList"}, + "SourceEntity":{"shape":"AnalysisSourceEntity"}, + "ThemeArn":{"shape":"Arn"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateAnalysisResponse":{ + "type":"structure", + "members":{ + "Arn":{"shape":"Arn"}, + "AnalysisId":{"shape":"RestrictiveResourceId"}, + "CreationStatus":{"shape":"ResourceStatus"}, + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + }, + "RequestId":{"shape":"String"} + } + }, "CreateColumnsOperation":{ "type":"structure", "required":["Columns"], @@ -2587,7 +2876,8 @@ "Arn":{"shape":"Arn"}, "SourceEntityArn":{"shape":"Arn"}, "DataSetArns":{"shape":"DataSetArnsList"}, - "Description":{"shape":"VersionDescription"} + "Description":{"shape":"VersionDescription"}, + "ThemeArn":{"shape":"Arn"} } }, "DashboardVersionSummary":{ @@ -2867,6 +3157,48 @@ } } }, + "DeleteAnalysisRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "AnalysisId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "AnalysisId":{ + "shape":"RestrictiveResourceId", + "location":"uri", + "locationName":"AnalysisId" + }, + "RecoveryWindowInDays":{ + "shape":"RecoveryWindowInDays", + "location":"querystring", + "locationName":"recovery-window-in-days" + }, + "ForceDeleteWithoutRecovery":{ + "shape":"boolean", + "location":"querystring", + "locationName":"force-delete-without-recovery" + } + } + }, + "DeleteAnalysisResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + }, + "Arn":{"shape":"Arn"}, + "AnalysisId":{"shape":"RestrictiveResourceId"}, + "DeletionTime":{"shape":"Timestamp"}, + "RequestId":{"shape":"String"} + } + }, "DeleteDashboardRequest":{ "type":"structure", "required":[ @@ -3385,6 +3717,68 @@ } } }, + "DescribeAnalysisPermissionsRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "AnalysisId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "AnalysisId":{ + "shape":"RestrictiveResourceId", + "location":"uri", + "locationName":"AnalysisId" + } + } + }, + "DescribeAnalysisPermissionsResponse":{ + "type":"structure", + "members":{ + "AnalysisId":{"shape":"RestrictiveResourceId"}, + "AnalysisArn":{"shape":"Arn"}, + "Permissions":{"shape":"ResourcePermissionList"}, + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + }, + "RequestId":{"shape":"String"} + } + }, + "DescribeAnalysisRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "AnalysisId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "AnalysisId":{ + "shape":"RestrictiveResourceId", + "location":"uri", + "locationName":"AnalysisId" + } + } + }, + "DescribeAnalysisResponse":{ + "type":"structure", + "members":{ + "Analysis":{"shape":"Analysis"}, + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + }, + "RequestId":{"shape":"String"} + } + }, "DescribeDashboardPermissionsRequest":{ "type":"structure", "required":[ @@ -4534,6 +4928,40 @@ "error":{"httpStatusCode":409}, "exception":true }, + "ListAnalysesRequest":{ + "type":"structure", + "required":["AwsAccountId"], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "NextToken":{ + "shape":"String", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"MaxResults", + "box":true, + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListAnalysesResponse":{ + "type":"structure", + "members":{ + "AnalysisSummaryList":{"shape":"AnalysisSummaryList"}, + "NextToken":{"shape":"String"}, + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + }, + "RequestId":{"shape":"String"} + } + }, "ListDashboardVersionsRequest":{ "type":"structure", "required":[ @@ -5583,6 +6011,11 @@ "Database":{"shape":"Database"} } }, + "RecoveryWindowInDays":{ + "type":"long", + "max":30, + "min":7 + }, "RedshiftParameters":{ "type":"structure", "required":["Database"], @@ -5719,7 +6152,8 @@ "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", - "UPDATE_FAILED" + "UPDATE_FAILED", + "DELETED" ] }, "ResourceUnavailableException":{ @@ -5732,6 +6166,37 @@ "error":{"httpStatusCode":503}, "exception":true }, + "RestoreAnalysisRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "AnalysisId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "AnalysisId":{ + "shape":"RestrictiveResourceId", + "location":"uri", + "locationName":"AnalysisId" + } + } + }, + "RestoreAnalysisResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + }, + "Arn":{"shape":"Arn"}, + "AnalysisId":{"shape":"RestrictiveResourceId"}, + "RequestId":{"shape":"String"} + } + }, "RestrictiveResourceId":{ "type":"string", "max":2048, @@ -5811,6 +6276,38 @@ "InputColumns":{"shape":"InputColumnList"} } }, + "SearchAnalysesRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "Filters" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "Filters":{"shape":"AnalysisSearchFilterList"}, + "NextToken":{"shape":"String"}, + "MaxResults":{ + "shape":"MaxResults", + "box":true + } + } + }, + "SearchAnalysesResponse":{ + "type":"structure", + "members":{ + "AnalysisSummaryList":{"shape":"AnalysisSummaryList"}, + "NextToken":{"shape":"String"}, + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + }, + "RequestId":{"shape":"String"} + } + }, "SearchDashboardsRequest":{ "type":"structure", "required":[ @@ -5825,7 +6322,10 @@ }, "Filters":{"shape":"DashboardSearchFilterList"}, "NextToken":{"shape":"String"}, - "MaxResults":{"shape":"MaxResults"} + "MaxResults":{ + "shape":"MaxResults", + "box":true + } } }, "SearchDashboardsResponse":{ @@ -6059,7 +6559,8 @@ "enum":[ "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", - "INTERNAL_FAILURE" + "INTERNAL_FAILURE", + "ACCESS_DENIED" ] }, "TemplateName":{ @@ -6118,7 +6619,8 @@ "Status":{"shape":"ResourceStatus"}, "DataSetConfigurations":{"shape":"DataSetConfigurationList"}, "Description":{"shape":"VersionDescription"}, - "SourceEntityArn":{"shape":"Arn"} + "SourceEntityArn":{"shape":"Arn"}, + "ThemeArn":{"shape":"Arn"} } }, "TemplateVersionSummary":{ @@ -6439,6 +6941,78 @@ } } }, + "UpdateAnalysisPermissionsRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "AnalysisId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "AnalysisId":{ + "shape":"RestrictiveResourceId", + "location":"uri", + "locationName":"AnalysisId" + }, + "GrantPermissions":{"shape":"UpdateResourcePermissionList"}, + "RevokePermissions":{"shape":"UpdateResourcePermissionList"} + } + }, + "UpdateAnalysisPermissionsResponse":{ + "type":"structure", + "members":{ + "AnalysisArn":{"shape":"Arn"}, + "AnalysisId":{"shape":"RestrictiveResourceId"}, + "Permissions":{"shape":"ResourcePermissionList"}, + "RequestId":{"shape":"String"}, + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + } + } + }, + "UpdateAnalysisRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "AnalysisId", + "Name", + "SourceEntity" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "location":"uri", + "locationName":"AwsAccountId" + }, + "AnalysisId":{ + "shape":"RestrictiveResourceId", + "location":"uri", + "locationName":"AnalysisId" + }, + "Name":{"shape":"AnalysisName"}, + "Parameters":{"shape":"Parameters"}, + "SourceEntity":{"shape":"AnalysisSourceEntity"}, + "ThemeArn":{"shape":"Arn"} + } + }, + "UpdateAnalysisResponse":{ + "type":"structure", + "members":{ + "Arn":{"shape":"Arn"}, + "AnalysisId":{"shape":"RestrictiveResourceId"}, + "UpdateStatus":{"shape":"ResourceStatus"}, + "Status":{ + "shape":"StatusCode", + "location":"statusCode" + }, + "RequestId":{"shape":"String"} + } + }, "UpdateDashboardPermissionsRequest":{ "type":"structure", "required":[ diff --git a/models/apis/quicksight/2018-04-01/docs-2.json b/models/apis/quicksight/2018-04-01/docs-2.json index f3d5f474a0..b9e75547e5 100644 --- a/models/apis/quicksight/2018-04-01/docs-2.json +++ b/models/apis/quicksight/2018-04-01/docs-2.json @@ -3,8 +3,9 @@ "service": "Amazon QuickSight is a fully managed, serverless business intelligence service for the AWS Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.
", "operations": { "CancelIngestion": "Cancels an ongoing ingestion of data into SPICE.
", - "CreateAccountCustomization": "Creates a customization for the Amazon QuickSight subscription associated with your AWS account.
", - "CreateDashboard": "Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. The CreateDashboard, DescribeDashboard, and ListDashboardsByUser API operations act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.
Creates Amazon QuickSight customizations the current AWS Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an AWS account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Before you add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme won't be visible to your users even if you use this API operation to make it the default theme.
", + "CreateAnalysis": "Creates an analysis in Amazon QuickSight.
", + "CreateDashboard": "Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.
", "CreateDataSet": "Creates a dataset.
", "CreateDataSource": "Creates a data source.
", "CreateGroup": "Creates an Amazon QuickSight group.
The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .
The response is a group object.
", @@ -16,22 +17,25 @@ "CreateTemplateAlias": "Creates a template alias for a template.
", "CreateTheme": "Creates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
", "CreateThemeAlias": "Creates a theme alias for a theme.
", - "DeleteAccountCustomization": "Deletes customizations for the QuickSight subscription on your AWS account.
", + "DeleteAccountCustomization": "Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS Account and QuickSight namespace.
", + "DeleteAnalysis": "Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
", "DeleteDashboard": "Deletes a dashboard.
", "DeleteDataSet": "Deletes a dataset.
", - "DeleteDataSource": "Deletes the data source permanently. This action breaks all the datasets that reference the deleted data source.
", + "DeleteDataSource": "Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
", "DeleteGroup": "Removes a user group from Amazon QuickSight.
", "DeleteGroupMembership": "Removes a user from a group so that the user is no longer a member of the group.
", "DeleteIAMPolicyAssignment": "Deletes an existing IAM policy assignment.
", - "DeleteNamespace": "Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the APIs for the relevant asset.
", + "DeleteNamespace": "Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
", "DeleteTemplate": "Deletes a template.
", "DeleteTemplateAlias": "Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
", "DeleteTheme": "Deletes a theme.
", "DeleteThemeAlias": "Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
", "DeleteUser": "Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
", "DeleteUserByPrincipalId": "Deletes a user identified by its principal ID.
", - "DescribeAccountCustomization": "Describes the customizations associated with your AWS account.
", + "DescribeAccountCustomization": "Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS Region. The QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
AWS Account - The AWS account exists at the top of the hierarchy. It has the potential to use all of the AWS Regions and AWS Services. When you subscribe to QuickSight, you choose one AWS Region to use as your home region. That's where your free SPICE capacity is located. You can use QuickSight in any supported AWS Region.
AWS Region - In each AWS Region where you sign in to QuickSight at least once, QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to QuickSight in any AWS Region, unless they are constrained to a namespace.
To run the command in a different AWS Region, you change your region settings. If you're using the AWS CLI, you can use one of the following options:
Use command line options.
Use named profiles.
Run aws configure to change your default AWS Region. Use Enter to key the same settings for your keys. For more information, see Configuring the AWS CLI.
Namespace - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same AWS account and AWS Region.
Applied customizations - Within an AWS Region, a set of QuickSight customizations can apply to an AWS account or to a namespace. Settings that you apply to a namespace override settings that you apply to an AWS Account. All settings are isolated to a single AWS Region. To apply them in other AWS Regions, run the CreateAccountCustomization command in each AWS Region where you want to apply the same customizations.
Describes the settings that were used when your QuickSight subscription was first created in this AWS Account.
", + "DescribeAnalysis": "Provides a summary of the metadata for an analysis.
", + "DescribeAnalysisPermissions": "Provides the read and write permissions for an analysis.
", "DescribeDashboard": "Provides a summary for a dashboard.
", "DescribeDashboardPermissions": "Describes read and write permissions for a dashboard.
", "DescribeDataSet": "Describes a dataset.
", @@ -49,8 +53,9 @@ "DescribeThemeAlias": "Describes the alias for a theme.
", "DescribeThemePermissions": "Describes the read and write permissions for a theme.
", "DescribeUser": "Returns information about a user, given the user name.
", - "GetDashboardEmbedUrl": "Generates a URL and authorization code that you can embed in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
The resulting user session is valid for 10 hours.
For more information, see Embedding Amazon QuickSight Dashboards in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API Reference.
", - "GetSessionEmbedUrl": "Generates a session URL and authorization code that you can embed in your web server code.
", + "GetDashboardEmbedUrl": "Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
The resulting user session is valid for 10 hours.
For more information, see Embedding Amazon QuickSight in the Amazon QuickSight User Guide .
", + "GetSessionEmbedUrl": "Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:
Lists Amazon QuickSight analyses that exist in the specified AWS account.
", "ListDashboardVersions": "Lists all the versions of the dashboards in the QuickSight subscription.
", "ListDashboards": "Lists dashboards in an AWS account.
", "ListDataSets": "Lists all of the datasets belonging to the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
", "ListUsers": "Returns a list of all of the Amazon QuickSight users belonging to this account.
", "RegisterUser": "Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
", - "SearchDashboards": "Searchs for dashboards that belong to a user.
", + "RestoreAnalysis": "Restores an analysis.
", + "SearchAnalyses": "Searches for analyses that belong to the user specified in the filter.
", + "SearchDashboards": "Searches for dashboards that belong to a user.
", "TagResource": "Assigns one or more tags (key-value pairs) to the specified QuickSight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template.
Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:
You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
Removes a tag or tags from a resource.
", - "UpdateAccountCustomization": "Updates customizations associated with the QuickSight subscription on your AWS account.
", - "UpdateAccountSettings": "Updates the settings for the Amazon QuickSight subscription in your AWS Account.
", + "UpdateAccountCustomization": "Updates Amazon QuickSight customizations the current AWS Region. Currently, the only customization you can use is a theme.
You can use customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an AWS account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Updates the Amazon QuickSight settings in your AWS Account.
", + "UpdateAnalysis": "Updates an analysis in Amazon QuickSight
", + "UpdateAnalysisPermissions": "Updates the read and write permissions for an analysis.
", "UpdateDashboard": "Updates a dashboard in an AWS account.
", "UpdateDashboardPermissions": "Updates read and write permissions on a dashboard.
", "UpdateDashboardPublishedVersion": "Updates the published version of a dashboard.
", @@ -100,25 +109,25 @@ } }, "AccountCustomization": { - "base": "The customizations associated with your AWS account for QuickSight.
", + "base": "The Amazon QuickSight customizations associated with your AWS account or a QuickSight namespace in a specific AWS Region.
", "refs": { - "CreateAccountCustomizationRequest$AccountCustomization": "The customizations you're adding to the QuickSight subscription for the AWS account. For example, you could add a default theme by setting AccountCustomization to the midnight theme (DefaultTheme=\"arn:aws:quicksight::aws:theme/MIDNIGHT\") or to a custom theme (DefaultTheme=\"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\").
The customizations you're adding to the QuickSight subscription for the AWS account.
", - "DescribeAccountCustomizationResponse$AccountCustomization": "The customizations associated with QuickSight.
", - "UpdateAccountCustomizationRequest$AccountCustomization": "The customizations you want to update in QuickSight.
", - "UpdateAccountCustomizationResponse$AccountCustomization": "The customizations associated with your QuickSight subscription.
" + "CreateAccountCustomizationRequest$AccountCustomization": "The QuickSight customizations you're adding in the current AWS Region. You can add these to an AWS account and a QuickSight namespace.
For example, you could add a default theme by setting AccountCustomization to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. . Or, you could add a custom theme by specifying \"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\" }.
The QuickSight customizations you're adding in the current AWS Region.
", + "DescribeAccountCustomizationResponse$AccountCustomization": "The QuickSight customizations that exist in the current AWS Region.
", + "UpdateAccountCustomizationRequest$AccountCustomization": "The QuickSight customizations you're updating in the current AWS Region.
", + "UpdateAccountCustomizationResponse$AccountCustomization": "The QuickSight customizations you're updating in the current AWS Region.
" } }, "AccountSettings": { "base": "The QuickSight settings associated with your AWS account.
", "refs": { - "DescribeAccountSettingsResponse$AccountSettings": "The settings associated with the QuickSight subscription associated with this AWS account. This information includes the edition of Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the QuickSight subscription. The QuickSight console, the QuickSight subscription is sometimes referred to as a QuickSight \"account\" even though it is technically not an account, but a subscription in your AWS account.
" + "DescribeAccountSettingsResponse$AccountSettings": "The QuickSight settings for this AWS account. This information includes the edition of Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the QuickSight subscription. The QuickSight console, the QuickSight subscription is sometimes referred to as a QuickSight \"account\" even though it's technically not an account by itself. Instead, it's a subscription to the QuickSight service for your AWS account. The edition that you subscribe to applies to QuickSight in every AWS Region where you use it.
" } }, "ActionList": { "base": null, "refs": { - "ResourcePermission$Actions": "The action to grant or revoke permissions on, for example \"quicksight:DescribeDashboard\".
The IAM action to grant or revoke permissions on, for example \"quicksight:DescribeDashboard\".
Amazon Elasticsearch Service parameters.
" } }, + "Analysis": { + "base": "Metadata structure for an analysis in Amazon QuickSight
", + "refs": { + "DescribeAnalysisResponse$Analysis": "A metadata structure that contains summary information for the analysis that you're describing.
" + } + }, + "AnalysisError": { + "base": "A metadata error structure for an analysis.
", + "refs": { + "AnalysisErrorList$member": null + } + }, + "AnalysisErrorList": { + "base": null, + "refs": { + "Analysis$Errors": "Errors associated with the analysis.
" + } + }, + "AnalysisErrorType": { + "base": null, + "refs": { + "AnalysisError$Type": "The type of the analysis error.
" + } + }, + "AnalysisFilterAttribute": { + "base": null, + "refs": { + "AnalysisSearchFilter$Name": "The name of the value that you want to use as a filter, for example \"Name\": \"QUICKSIGHT_USER\".
The descriptive name of the analysis.
", + "AnalysisSummary$Name": "The name of the analysis. This name is displayed in the QuickSight console.
", + "CreateAnalysisRequest$Name": "A descriptive name for the analysis that you're creating. This name displays for the analysis in the QuickSight console.
", + "UpdateAnalysisRequest$Name": "A descriptive name for the analysis that you're updating. This name displays for the analysis in the QuickSight console.
" + } + }, + "AnalysisSearchFilter": { + "base": "A filter that you apply when searching for one or more analyses.
", + "refs": { + "AnalysisSearchFilterList$member": null + } + }, + "AnalysisSearchFilterList": { + "base": null, + "refs": { + "SearchAnalysesRequest$Filters": "The structure for the search filters that you want to apply to your search.
" + } + }, + "AnalysisSourceEntity": { + "base": "The source entity of an analysis.
", + "refs": { + "CreateAnalysisRequest$SourceEntity": "A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.
", + "UpdateAnalysisRequest$SourceEntity": "A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.
" + } + }, + "AnalysisSourceTemplate": { + "base": "The source template of an analysis.
", + "refs": { + "AnalysisSourceEntity$SourceTemplate": "The source template for the source entity of the analysis.
" + } + }, + "AnalysisSummary": { + "base": "The summary metadata that describes an analysis.
", + "refs": { + "AnalysisSummaryList$member": null + } + }, + "AnalysisSummaryList": { + "base": null, + "refs": { + "ListAnalysesResponse$AnalysisSummaryList": "Metadata describing each of the analyses that are listed.
", + "SearchAnalysesResponse$AnalysisSummaryList": "Metadata describing the analyses that you searched for.
" + } + }, "Arn": { "base": null, "refs": { "AccountCustomization$DefaultTheme": "The default theme for this QuickSight subscription.
", "ActiveIAMPolicyAssignment$PolicyArn": "The Amazon Resource Name (ARN) of the resource.
", + "Analysis$Arn": "The Amazon Resource Name (ARN) of the analysis.
", + "Analysis$ThemeArn": "The ARN of the theme of the analysis.
", + "AnalysisSourceTemplate$Arn": "The Amazon Resource Name (ARN) of the source template of an analysis.
", + "AnalysisSummary$Arn": "The Amazon Resource Name (ARN) for the analysis.
", "CancelIngestionResponse$Arn": "The Amazon Resource Name (ARN) for the data ingestion.
", + "CreateAnalysisRequest$ThemeArn": "The ARN for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.
", + "CreateAnalysisResponse$Arn": "The ARN for the analysis.
", "CreateDashboardRequest$ThemeArn": "The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.
", "CreateDashboardResponse$Arn": "The ARN of the dashboard.
", "CreateDashboardResponse$VersionArn": "The ARN of the dashboard, including the version number of the first version that is created.
", @@ -191,6 +283,7 @@ "DashboardSummary$Arn": "The Amazon Resource Name (ARN) of the resource.
", "DashboardVersion$Arn": "The Amazon Resource Name (ARN) of the resource.
", "DashboardVersion$SourceEntityArn": "Source entity ARN.
", + "DashboardVersion$ThemeArn": "The ARN of the theme associated with a version of the dashboard.
", "DashboardVersionSummary$Arn": "The Amazon Resource Name (ARN) of the resource.
", "DashboardVersionSummary$SourceEntityArn": "Source entity ARN.
", "DataSet$Arn": "The Amazon Resource Name (ARN) of the resource.
", @@ -198,6 +291,7 @@ "DataSetReference$DataSetArn": "Dataset Amazon Resource Name (ARN).
", "DataSetSummary$Arn": "The Amazon Resource Name (ARN) of the dataset.
", "DataSource$Arn": "The Amazon Resource Name (ARN) of the data source.
", + "DeleteAnalysisResponse$Arn": "The Amazon Resource Name (ARN) of the deleted analysis.
", "DeleteDashboardResponse$Arn": "The Secure Socket Layer (SSL) properties that apply for the resource.
", "DeleteDataSetResponse$Arn": "The Amazon Resource Name (ARN) of the dataset.
", "DeleteDataSourceResponse$Arn": "The Amazon Resource Name (ARN) of the data source that you deleted.
", @@ -205,13 +299,14 @@ "DeleteTemplateResponse$Arn": "The Amazon Resource Name (ARN) of the resource.
", "DeleteThemeAliasResponse$Arn": "The Amazon Resource Name (ARN) of the theme resource using the deleted alias.
", "DeleteThemeResponse$Arn": "The Amazon Resource Name (ARN) of the resource.
", + "DescribeAnalysisPermissionsResponse$AnalysisArn": "The Amazon Resource Name (ARN) of the analysis whose permissions you're describing.
", "DescribeDashboardPermissionsResponse$DashboardArn": "The Amazon Resource Name (ARN) of the dashboard.
", "DescribeDataSetPermissionsResponse$DataSetArn": "The Amazon Resource Name (ARN) of the dataset.
", "DescribeDataSourcePermissionsResponse$DataSourceArn": "The Amazon Resource Name (ARN) of the data source.
", "DescribeTemplatePermissionsResponse$TemplateArn": "The Amazon Resource Name (ARN) of the template.
", "DescribeThemePermissionsResponse$ThemeArn": "The Amazon Resource Name (ARN) of the theme.
", - "GetDashboardEmbedUrlRequest$UserArn": "The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:
Active Directory (AD) users or group members
Invited nonfederated users
IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.
The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:
Active Directory (AD) users or group members
Invited nonfederated users
IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.
The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:
Active Directory (AD) users or group members
Invited nonfederated users
IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.
Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
", + "GetSessionEmbedUrlRequest$UserArn": "The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:
Active Directory (AD) users or group members
Invited nonfederated users
IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation
Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
", "Group$Arn": "The Amazon Resource Name (ARN) for the group.
", "GroupMember$Arn": "The Amazon Resource Name (ARN) for the group member (user).
", "IAMPolicyAssignment$PolicyArn": "The Amazon Resource Name (ARN) for the IAM policy.
", @@ -219,6 +314,7 @@ "ListTagsForResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource that you want a list of tags for.
", "NamespaceInfoV2$Arn": "The namespace ARN.
", "RelationalTable$DataSourceArn": "The Amazon Resource Name (ARN) for the data source.
", + "RestoreAnalysisResponse$Arn": "The Amazon Resource Name (ARN) of the analysis that you're restoring.
", "RowLevelPermissionDataSet$Arn": "The Amazon Resource Name (ARN) of the permission dataset.
", "S3Source$DataSourceArn": "The amazon Resource Name (ARN) for the data source.
", "TagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource that you want to tag.
", @@ -227,7 +323,8 @@ "TemplateSourceAnalysis$Arn": "The Amazon Resource Name (ARN) of the resource.
", "TemplateSourceTemplate$Arn": "The Amazon Resource Name (ARN) of the resource.
", "TemplateSummary$Arn": "A summary of a template.
", - "TemplateVersion$SourceEntityArn": "The Amazon Resource Name (ARN) of the analysis or template which was used to create this template.
", + "TemplateVersion$SourceEntityArn": "The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
", + "TemplateVersion$ThemeArn": "The ARN of the theme associated with this version of the template.
", "TemplateVersionSummary$Arn": "The Amazon Resource Name (ARN) of the template version.
", "Theme$Arn": "The Amazon Resource Name (ARN) of the theme.
", "ThemeAlias$Arn": "The Amazon Resource Name (ARN) of the theme alias.
", @@ -235,6 +332,9 @@ "ThemeVersion$Arn": "The Amazon Resource Name (ARN) of the resource.
", "ThemeVersionSummary$Arn": "The Amazon Resource Name (ARN) of the theme version.
", "UntagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the resource that you want to untag.
", + "UpdateAnalysisPermissionsResponse$AnalysisArn": "The Amazon Resource Name (ARN) of the analysis that you updated.
", + "UpdateAnalysisRequest$ThemeArn": "The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.
", + "UpdateAnalysisResponse$Arn": "The ARN of the analysis that you're updating.
", "UpdateDashboardPermissionsResponse$DashboardArn": "The Amazon Resource Name (ARN) of the dashboard.
", "UpdateDashboardPublishedVersionResponse$DashboardArn": "The Amazon Resource Name (ARN) of the dashboard.
", "UpdateDashboardRequest$ThemeArn": "The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create the dashboard.
", @@ -293,6 +393,7 @@ "CancelIngestionRequest$AwsAccountId": "The AWS account ID.
", "CreateAccountCustomizationRequest$AwsAccountId": "The ID for the AWS account that you want to customize QuickSight for.
", "CreateAccountCustomizationResponse$AwsAccountId": "The ID for the AWS account that you want to customize QuickSight for.
", + "CreateAnalysisRequest$AwsAccountId": "The ID of the AWS account where you are creating an analysis.
", "CreateDashboardRequest$AwsAccountId": "The ID of the AWS account where you want to create the dashboard.
", "CreateDataSetRequest$AwsAccountId": "The AWS account ID.
", "CreateDataSourceRequest$AwsAccountId": "The AWS account ID.
", @@ -305,7 +406,8 @@ "CreateTemplateRequest$AwsAccountId": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", "CreateThemeAliasRequest$AwsAccountId": "The ID of the AWS account that contains the theme for the new theme alias.
", "CreateThemeRequest$AwsAccountId": "The ID of the AWS account where you want to store the new theme.
", - "DeleteAccountCustomizationRequest$AwsAccountId": "The ID for the AWS account that you want to delete QuickSight customizations from.
", + "DeleteAccountCustomizationRequest$AwsAccountId": "The ID for the AWS account that you want to delete QuickSight customizations from in this AWS Region.
", + "DeleteAnalysisRequest$AwsAccountId": "The ID of the AWS account where you want to delete an analysis.
", "DeleteDashboardRequest$AwsAccountId": "The ID of the AWS account that contains the dashboard that you're deleting.
", "DeleteDataSetRequest$AwsAccountId": "The AWS account ID.
", "DeleteDataSourceRequest$AwsAccountId": "The AWS account ID.
", @@ -320,8 +422,10 @@ "DeleteUserByPrincipalIdRequest$AwsAccountId": "The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", "DeleteUserRequest$AwsAccountId": "The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", "DescribeAccountCustomizationRequest$AwsAccountId": "The ID for the AWS account that you want to describe QuickSight customizations for.
", - "DescribeAccountCustomizationResponse$AwsAccountId": "The ID for the AWS account that you want to describe QuickSight customizations for.
", - "DescribeAccountSettingsRequest$AwsAccountId": "The ID for the AWS account that contains the QuickSight namespaces that you want to list.
", + "DescribeAccountCustomizationResponse$AwsAccountId": "The ID for the AWS account that you're describing.
", + "DescribeAccountSettingsRequest$AwsAccountId": "The ID for the AWS account that contains the settings that you want to list.
", + "DescribeAnalysisPermissionsRequest$AwsAccountId": "The ID of the AWS account that contains the analysis whose permissions you're describing. You must be using the AWS account that the analysis is in.
", + "DescribeAnalysisRequest$AwsAccountId": "The ID of the AWS account that contains the analysis. You must be using the AWS account that the analysis is in.
", "DescribeDashboardPermissionsRequest$AwsAccountId": "The ID of the AWS account that contains the dashboard that you're describing permissions for.
", "DescribeDashboardRequest$AwsAccountId": "The ID of the AWS account that contains the dashboard that you're describing.
", "DescribeDataSetPermissionsRequest$AwsAccountId": "The AWS account ID.
", @@ -339,8 +443,9 @@ "DescribeThemePermissionsRequest$AwsAccountId": "The ID of the AWS account that contains the theme that you're describing.
", "DescribeUserRequest$AwsAccountId": "The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", "GetDashboardEmbedUrlRequest$AwsAccountId": "The ID for the AWS account that contains the dashboard that you're embedding.
", - "GetSessionEmbedUrlRequest$AwsAccountId": "The ID for the AWS account that contains the QuickSight session that you're embedding.
", + "GetSessionEmbedUrlRequest$AwsAccountId": "The ID for the AWS account associated with your QuickSight subscription.
", "IAMPolicyAssignment$AwsAccountId": "The AWS account ID.
", + "ListAnalysesRequest$AwsAccountId": "The ID of the AWS account that contains the analyses.
", "ListDashboardVersionsRequest$AwsAccountId": "The ID of the AWS account that contains the dashboard that you're listing versions for.
", "ListDashboardsRequest$AwsAccountId": "The ID of the AWS account that contains the dashboards that you're listing.
", "ListDataSetsRequest$AwsAccountId": "The AWS account ID.
", @@ -360,10 +465,14 @@ "ListUserGroupsRequest$AwsAccountId": "The AWS account ID that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", "ListUsersRequest$AwsAccountId": "The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", "RegisterUserRequest$AwsAccountId": "The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
", + "RestoreAnalysisRequest$AwsAccountId": "The ID of the AWS account that contains the analysis.
", + "SearchAnalysesRequest$AwsAccountId": "The ID of the AWS account that contains the analyses that you're searching for.
", "SearchDashboardsRequest$AwsAccountId": "The ID of the AWS account that contains the user whose dashboards you're searching for.
", "UpdateAccountCustomizationRequest$AwsAccountId": "The ID for the AWS account that you want to update QuickSight customizations for.
", "UpdateAccountCustomizationResponse$AwsAccountId": "The ID for the AWS account that you want to update QuickSight customizations for.
", - "UpdateAccountSettingsRequest$AwsAccountId": "The ID for the AWS account that contains the QuickSight namespaces that you want to list.
", + "UpdateAccountSettingsRequest$AwsAccountId": "The ID for the AWS account that contains the QuickSight settings that you want to list.
", + "UpdateAnalysisPermissionsRequest$AwsAccountId": "The ID of the AWS account that contains the analysis whose permissions you're updating. You must be using the AWS account that the analysis is in.
", + "UpdateAnalysisRequest$AwsAccountId": "The ID of the AWS account that contains the analysis that you're updating.
", "UpdateDashboardPermissionsRequest$AwsAccountId": "The ID of the AWS account that contains the dashboard whose permissions you're updating.
", "UpdateDashboardPublishedVersionRequest$AwsAccountId": "The ID of the AWS account that contains the dashboard that you're updating.
", "UpdateDashboardRequest$AwsAccountId": "The ID of the AWS account that contains the dashboard that you're updating.
", @@ -557,7 +666,7 @@ } }, "ConcurrentUpdatingException": { - "base": "A resource is already in a state that indicates an action is happening that must complete before a new update can be applied.
", + "base": "A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.
", "refs": { } }, @@ -582,6 +691,16 @@ "refs": { } }, + "CreateAnalysisRequest": { + "base": null, + "refs": { + } + }, + "CreateAnalysisResponse": { + "base": null, + "refs": { + } + }, "CreateColumnsOperation": { "base": "A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure.
", "refs": { @@ -748,7 +867,7 @@ "DashboardErrorList": { "base": null, "refs": { - "DashboardVersion$Errors": "Errors.
" + "DashboardVersion$Errors": "Errors associated with this dashboard version.
" } }, "DashboardErrorType": { @@ -775,8 +894,8 @@ "DashboardPublishOptions": { "base": "Dashboard publish options.
", "refs": { - "CreateDashboardRequest$DashboardPublishOptions": "Options for publishing the dashboard when you create it:
AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .csv format isn't enabled when this is set to DISABLED. This option is ENABLED by default.
VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
Options for publishing the dashboard when you create it:
AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .csv format isn't enabled when this is set to DISABLED. This option is ENABLED by default.
VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
Options for publishing the dashboard when you create it:
AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.
VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
Options for publishing the dashboard when you create it:
AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.
VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
The Amazon Resource Numbers (ARNs) for the datasets that are associated with a version of the dashboard.
" + "Analysis$DataSetArns": "The ARNs of the datasets of the analysis.
", + "DashboardVersion$DataSetArns": "The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.
" } }, "DataSetConfiguration": { @@ -868,7 +988,7 @@ "DataSetConfigurationList": { "base": null, "refs": { - "TemplateVersion$DataSetConfigurations": "Schema of the dataset identified by the placeholder. The idea is that any dashboard created from the template should be bound to new datasets matching the same schema described through this API. .
" + "TemplateVersion$DataSetConfigurations": "Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.
" } }, "DataSetImportMode": { @@ -895,6 +1015,7 @@ "DataSetReferenceList": { "base": null, "refs": { + "AnalysisSourceTemplate$DataSetReferences": "The dataset references of the source template of an analysis.
", "DashboardSourceTemplate$DataSetReferences": "Dataset references.
", "TemplateSourceAnalysis$DataSetReferences": "A structure containing information about the dataset references used as placeholders in the template.
" } @@ -961,8 +1082,8 @@ "DataSourceParametersList": { "base": null, "refs": { - "CredentialPair$AlternateDataSourceParameters": "A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allowlist. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.
A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allowlist. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.
A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allowlist. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.
A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allowlist. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.
Date time parameter.
", + "base": "A date-time parameter.
", "refs": { "DateTimeParameterList$member": null } @@ -996,11 +1117,11 @@ "DateTimeParameterList": { "base": null, "refs": { - "Parameters$DateTimeParameters": "DateTime parameters.
" + "Parameters$DateTimeParameters": "Date-time parameters.
" } }, "DecimalParameter": { - "base": "Decimal parameter.
", + "base": "A decimal parameter.
", "refs": { "DecimalParameterList$member": null } @@ -1021,6 +1142,16 @@ "refs": { } }, + "DeleteAnalysisRequest": { + "base": null, + "refs": { + } + }, + "DeleteAnalysisResponse": { + "base": null, + "refs": { + } + }, "DeleteDashboardRequest": { "base": null, "refs": { @@ -1177,6 +1308,26 @@ "refs": { } }, + "DescribeAnalysisPermissionsRequest": { + "base": null, + "refs": { + } + }, + "DescribeAnalysisPermissionsResponse": { + "base": null, + "refs": { + } + }, + "DescribeAnalysisRequest": { + "base": null, + "refs": { + } + }, + "DescribeAnalysisResponse": { + "base": null, + "refs": { + } + }, "DescribeDashboardPermissionsRequest": { "base": null, "refs": { @@ -1367,26 +1518,26 @@ "DoubleList": { "base": null, "refs": { - "DecimalParameter$Values": "Values.
" + "DecimalParameter$Values": "The values for the decimal parameter.
" } }, "Edition": { "base": null, "refs": { - "AccountSettings$Edition": "The edition of QuickSight that you're currently subscribed to.
" + "AccountSettings$Edition": "The edition of QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
" } }, "EmbeddingUrl": { "base": null, "refs": { - "GetDashboardEmbedUrlResponse$EmbedUrl": "A single-use URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes. The API provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.
A single-use URL that you can put into your server-side web page to embed your QuickSight session. This URL is valid for 5 minutes. The API provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.
A single-use URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.
A single-use URL that you can put into your server-side web page to embed your QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.
The entry point for the embedded session.
" + "GetSessionEmbedUrlRequest$EntryPoint": "The URL you use to access the embedded session. The entry point URL is constrained to the following paths:
/start
/start/analyses
/start/dashboards
/start/favorites
/dashboards/DashboardId - where DashboardId is the actual ID key from the QuickSight console URL of the dashboard
/analyses/AnalysisId - where AnalysisId is the actual ID key from the QuickSight console URL of the analysis
The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\".
The comparison operator that you want to use as a filter, for example, \"Operator\": \"StringEquals\".
A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. Currently, an Amazon QuickSight subscription can't contain more than 500 Amazon QuickSight groups.
", + "base": "A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security.
", "refs": { "CreateGroupResponse$Group": "The name of the group.
", "DescribeGroupResponse$Group": "The name of the group.
", @@ -1734,7 +1886,7 @@ } }, "IntegerParameter": { - "base": "Integer parameter.
", + "base": "An integer parameter.
", "refs": { "IntegerParameterList$member": null } @@ -1783,6 +1935,16 @@ "refs": { } }, + "ListAnalysesRequest": { + "base": null, + "refs": { + } + }, + "ListAnalysesResponse": { + "base": null, + "refs": { + } + }, "ListDashboardVersionsRequest": { "base": null, "refs": { @@ -2017,7 +2179,7 @@ "LongList": { "base": null, "refs": { - "IntegerParameter$Values": "Values.
" + "IntegerParameter$Values": "The values for the integer parameter.
" } }, "ManifestFileLocation": { @@ -2041,6 +2203,7 @@ "MaxResults": { "base": null, "refs": { + "ListAnalysesRequest$MaxResults": "The maximum number of results to return.
", "ListDashboardVersionsRequest$MaxResults": "The maximum number of results to be returned per request.
", "ListDashboardsRequest$MaxResults": "The maximum number of results to be returned per request.
", "ListDataSetsRequest$MaxResults": "The maximum number of results to be returned per request.
", @@ -2058,6 +2221,7 @@ "ListThemesRequest$MaxResults": "The maximum number of results to be returned per request.
", "ListUserGroupsRequest$MaxResults": "The maximum number of results to return from this request.
", "ListUsersRequest$MaxResults": "The maximum number of results to return from this request.
", + "SearchAnalysesRequest$MaxResults": "The maximum number of results to return.
", "SearchDashboardsRequest$MaxResults": "The maximum number of results to be returned per request.
" } }, @@ -2070,23 +2234,23 @@ "Namespace": { "base": null, "refs": { - "AccountSettings$DefaultNamespace": "The default QuickSight namespace for your AWS account.
", - "CreateAccountCustomizationRequest$Namespace": "The namespace associated with the customization that you're creating.
", + "AccountSettings$DefaultNamespace": "The default QuickSight namespace for your AWS account.
", + "CreateAccountCustomizationRequest$Namespace": "The QuickSight namespace that you want to add customizations to.
", "CreateAccountCustomizationResponse$Namespace": "The namespace associated with the customization you're creating.
", "CreateGroupMembershipRequest$Namespace": "The namespace. Currently, you should set this to default.
The namespace. Currently, you should set this to default.
The namespace that contains the assignment.
", "CreateNamespaceRequest$Namespace": "The name that you want to use to describe the new namespace.
", "CreateNamespaceResponse$Name": "The name of the new namespace that you created.
", - "DeleteAccountCustomizationRequest$Namespace": "The namespace associated with the customization that you're deleting.
", + "DeleteAccountCustomizationRequest$Namespace": "The QuickSight namespace that you're deleting the customizations from.
", "DeleteGroupMembershipRequest$Namespace": "The namespace. Currently, you should set this to default.
The namespace. Currently, you should set this to default.
The namespace that contains the assignment.
", "DeleteNamespaceRequest$Namespace": "The namespace that you want to delete.
", "DeleteUserByPrincipalIdRequest$Namespace": "The namespace. Currently, you should set this to default.
The namespace. Currently, you should set this to default.
The namespace associated with the customization that you're describing.
", - "DescribeAccountCustomizationResponse$Namespace": "The namespace associated with the customization that you're describing.
", + "DescribeAccountCustomizationRequest$Namespace": "The QuickSight namespace that you want to describe QuickSight customizations for.
", + "DescribeAccountCustomizationResponse$Namespace": "The QuickSight namespace that you're describing.
", "DescribeGroupRequest$Namespace": "The namespace. Currently, you should set this to default.
The namespace that contains the assignment.
", "DescribeNamespaceRequest$Namespace": "The namespace that you want to describe.
", @@ -2100,7 +2264,7 @@ "NamespaceInfoV2$Name": "The name of the error.
", "RegisterUserRequest$Namespace": "The namespace. Currently, you should set this to default.
The namespace associated with the row-level permissions dataset.
", - "UpdateAccountCustomizationRequest$Namespace": "The namespace associated with the customization that you're updating.
", + "UpdateAccountCustomizationRequest$Namespace": "The namespace that you want to update QuickSight customizations for.
", "UpdateAccountCustomizationResponse$Namespace": "The namespace associated with the customization that you're updating.
", "UpdateAccountSettingsRequest$DefaultNamespace": "The default namespace for this AWS Account. Currently, the default is default. IAM users who register for the first time with QuickSight provide an email that becomes associated with the default namespace.
The namespace. Currently, you should set this to default.
Errors that occur during namespace creation.
", "refs": { - "NamespaceInfoV2$NamespaceError": "An error that occured when the namespace was created.
" + "NamespaceInfoV2$NamespaceError": "An error that occurred when the namespace was created.
" } }, "NamespaceErrorType": { @@ -2123,14 +2287,14 @@ "NamespaceInfoV2": { "base": "The error type.
", "refs": { - "DescribeNamespaceResponse$Namespace": "The information about the namespace that you're describing. The response includes the namespace ARN, name, AWS Region, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API lists the namespace error types and messages associated with the creation process.
The information about the namespace that you're describing. The response includes the namespace ARN, name, AWS Region, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.
The status of the creation of the namespace. This is an asynchronous process. A status of CREATED means that your namespace is ready to use. If an error occurs, it indicates if the process is retryable or non-retryable. In the case of a non-retryable error, refer to the error message for follow-up actions.
The status of the creation of the namespace. This is an asynchronous process. A status of CREATED means that your namespace is ready to use. If an error occurs, it indicates if the process is retryable or non-retryable. In the case of a non-retryable error, refer to the error message for follow-up tasks.
The creation status of a namespace that is not yet completely created.
" } }, @@ -2143,12 +2307,13 @@ "NonEmptyString": { "base": null, "refs": { + "AnalysisError$Message": "The message associated with the analysis error.
", "DashboardError$Message": "Message.
", "DataSetReference$DataSetPlaceholder": "Dataset placeholder.
", - "DateTimeParameter$Name": "A display name for the dataset.
", - "DecimalParameter$Name": "A display name for the dataset.
", - "IntegerParameter$Name": "A display name for the dataset.
", - "StringParameter$Name": "A display name for the dataset.
", + "DateTimeParameter$Name": "A display name for the date-time parameter.
", + "DecimalParameter$Name": "A display name for the decimal parameter.
", + "IntegerParameter$Name": "The name of the integer parameter.
", + "StringParameter$Name": "A display name for a string parameter.
", "TemplateError$Message": "Description of the error type.
", "ThemeError$Message": "The error message.
" } @@ -2178,9 +2343,11 @@ } }, "Parameters": { - "base": "Parameters.
", + "base": "A list of QuickSight parameters and the list's override values.
", "refs": { + "CreateAnalysisRequest$Parameters": "The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
", "CreateDashboardRequest$Parameters": "The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
", + "UpdateAnalysisRequest$Parameters": "The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
", "UpdateDashboardRequest$Parameters": "A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.
" } }, @@ -2290,6 +2457,12 @@ "DataSourceParameters$RdsParameters": "Amazon RDS parameters.
" } }, + "RecoveryWindowInDays": { + "base": null, + "refs": { + "DeleteAnalysisRequest$RecoveryWindowInDays": "A value that specifies the number of days that QuickSight waits before it deletes the analysis. You can't use this parameter with the ForceDeleteWithoutRecovery option in the same API call. The default value is 30.
Amazon Redshift parameters. The ClusterId field can be blank if Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.
A structure that contains the permissions of the dashboard. You can use this structure for granting permissions with principal and action information.
", + "CreateAnalysisRequest$Permissions": "A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).
To specify no permissions, omit Permissions.
A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
", "CreateDataSetRequest$Permissions": "A list of resource permissions on the dataset.
", "CreateDataSourceRequest$Permissions": "A list of resource permissions on the data source.
", "CreateTemplateRequest$Permissions": "A list of resource permissions to be set on the template.
", "CreateThemeRequest$Permissions": "A valid grouping of resource permissions to apply to the new theme.
", + "DescribeAnalysisPermissionsResponse$Permissions": "A structure that describes the principals and the resource-level permissions on an analysis.
", "DescribeDashboardPermissionsResponse$Permissions": "A structure that contains the permissions for the dashboard.
", "DescribeDataSetPermissionsResponse$Permissions": "A list of resource permissions on the dataset.
", "DescribeDataSourcePermissionsResponse$Permissions": "A list of resource permissions on the data source.
", "DescribeTemplatePermissionsResponse$Permissions": "A list of resource permissions to be set on the template.
", "DescribeThemePermissionsResponse$Permissions": "A list of resource permissions set on the theme.
", + "UpdateAnalysisPermissionsResponse$Permissions": "A structure that describes the principals and the resource-level permissions on an analysis.
", "UpdateDashboardPermissionsResponse$Permissions": "Information about the permissions on the dashboard.
", "UpdateDataSetPermissionsRequest$GrantPermissions": "The resource permissions that you want to grant to the dataset.
", "UpdateDataSetPermissionsRequest$RevokePermissions": "The resource permissions that you want to revoke from the dataset.
", @@ -2416,6 +2592,9 @@ "ResourceStatus": { "base": null, "refs": { + "Analysis$Status": "Status associated with the analysis.
", + "AnalysisSummary$Status": "The last known status for the analysis.
", + "CreateAnalysisResponse$CreationStatus": "The status of the creation of the analysis.
", "CreateDashboardResponse$CreationStatus": "The status of the dashboard creation request.
", "CreateDataSourceResponse$CreationStatus": "The status of creating the data source.
", "CreateTemplateResponse$CreationStatus": "The template creation status.
", @@ -2427,6 +2606,7 @@ "TemplateVersionSummary$Status": "The status of the template version.
", "ThemeVersion$Status": "The status of the theme version.
", "ThemeVersionSummary$Status": "The status of the theme version.
", + "UpdateAnalysisResponse$UpdateStatus": "The update status of the last update that was made to the analysis.
", "UpdateDashboardResponse$CreationStatus": "The creation status of the request.
", "UpdateDataSourceResponse$UpdateStatus": "The update status of the data source's last update.
", "UpdateTemplateResponse$CreationStatus": "The creation status of the template.
", @@ -2438,9 +2618,23 @@ "refs": { } }, + "RestoreAnalysisRequest": { + "base": null, + "refs": { + } + }, + "RestoreAnalysisResponse": { + "base": null, + "refs": { + } + }, "RestrictiveResourceId": { "base": null, "refs": { + "Analysis$AnalysisId": "The ID of the analysis.
", + "AnalysisSummary$AnalysisId": "The ID of the analysis. This ID displays in the URL.
", + "CreateAnalysisRequest$AnalysisId": "The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
", + "CreateAnalysisResponse$AnalysisId": "The ID of the analysis.
", "CreateDashboardRequest$DashboardId": "The ID for the dashboard, also added to the IAM policy.
", "CreateDashboardResponse$DashboardId": "The ID for the dashboard.
", "CreateTemplateAliasRequest$TemplateId": "An ID for the template.
", @@ -2452,6 +2646,8 @@ "CreateThemeResponse$ThemeId": "The ID of the theme.
", "Dashboard$DashboardId": "Dashboard ID.
", "DashboardSummary$DashboardId": "Dashboard ID.
", + "DeleteAnalysisRequest$AnalysisId": "The ID of the analysis that you're deleting.
", + "DeleteAnalysisResponse$AnalysisId": "The ID of the deleted analysis.
", "DeleteDashboardRequest$DashboardId": "The ID for the dashboard.
", "DeleteDashboardResponse$DashboardId": "The ID of the dashboard.
", "DeleteTemplateAliasRequest$TemplateId": "The ID for the template that the specified alias is for.
", @@ -2462,6 +2658,9 @@ "DeleteThemeAliasResponse$ThemeId": "An ID for the theme associated with the deletion.
", "DeleteThemeRequest$ThemeId": "An ID for the theme that you want to delete.
", "DeleteThemeResponse$ThemeId": "An ID for the theme.
", + "DescribeAnalysisPermissionsRequest$AnalysisId": "The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.
", + "DescribeAnalysisPermissionsResponse$AnalysisId": "The ID of the analysis whose permissions you're describing.
", + "DescribeAnalysisRequest$AnalysisId": "The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
", "DescribeDashboardPermissionsRequest$DashboardId": "The ID for the dashboard, also added to the IAM policy.
", "DescribeDashboardPermissionsResponse$DashboardId": "The ID for the dashboard.
", "DescribeDashboardRequest$DashboardId": "The ID for the dashboard.
", @@ -2479,11 +2678,17 @@ "ListTemplateVersionsRequest$TemplateId": "The ID for the template.
", "ListThemeAliasesRequest$ThemeId": "The ID for the theme.
", "ListThemeVersionsRequest$ThemeId": "The ID for the theme.
", + "RestoreAnalysisRequest$AnalysisId": "The ID of the analysis that you're restoring.
", + "RestoreAnalysisResponse$AnalysisId": "The ID of the analysis that you're restoring.
", "Template$TemplateId": "The ID for the template. This is unique per AWS Region for each AWS account.
", "TemplateSummary$TemplateId": "The ID of the template. This ID is unique per AWS Region for each AWS account.
", "Theme$ThemeId": "The identifier that the user gives to the theme.
", "ThemeSummary$ThemeId": "The ID of the theme. This ID is unique per AWS Region for each AWS account.
", "ThemeVersion$BaseThemeId": "The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.
", + "UpdateAnalysisPermissionsRequest$AnalysisId": "The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.
", + "UpdateAnalysisPermissionsResponse$AnalysisId": "The ID of the analysis that you updated permissions for.
", + "UpdateAnalysisRequest$AnalysisId": "The ID for the analysis that you're updating. This ID displays in the URL of the analysis.
", + "UpdateAnalysisResponse$AnalysisId": "The ID of the analysis.
", "UpdateDashboardPermissionsRequest$DashboardId": "The ID for the dashboard.
", "UpdateDashboardPermissionsResponse$DashboardId": "The ID for the dashboard.
", "UpdateDashboardPublishedVersionRequest$DashboardId": "The ID for the dashboard.
", @@ -2506,8 +2711,8 @@ "RoleName": { "base": null, "refs": { - "RegisterUserRequest$CustomPermissionsName": "(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Currently, custom permissions profile names are assigned to permissions profiles in the QuickSight console. You use this API to assign the named set of permissions to a QuickSight user.
Customizing permissions in the QuickSight UI allows you to control a user's access to the following operations:
QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts (admin, author, reader) in QuickSight.
This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).
", - "UpdateUserRequest$CustomPermissionsName": "The name of the custom permissions profile that you want to assign to this user. Currently, custom permissions profile names are assigned to permissions profiles in the QuickSight console. You use this API to assign the named set of permissions to a QuickSight user.
", + "RegisterUserRequest$CustomPermissionsName": "(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports
To add custom permissions to an existing user, use UpdateUser instead.
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).
This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).
", + "UpdateUserRequest$CustomPermissionsName": "(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
Create and update data sources
Create and update datasets
Create and update email reports
Subscribe to email reports
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).
This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).
", "User$CustomPermissionsName": "The custom permissions profile associated with this user.
" } }, @@ -2562,6 +2767,16 @@ "PhysicalTable$S3Source": "A physical table type for as S3 data source.
" } }, + "SearchAnalysesRequest": { + "base": null, + "refs": { + } + }, + "SearchAnalysesResponse": { + "base": null, + "refs": { + } + }, "SearchDashboardsRequest": { "base": null, "refs": { @@ -2646,6 +2861,7 @@ "refs": { "CancelIngestionResponse$Status": "The HTTP status of the request.
", "CreateAccountCustomizationResponse$Status": "The HTTP status of the request.
", + "CreateAnalysisResponse$Status": "The HTTP status of the request.
", "CreateDashboardResponse$Status": "The HTTP status of the request.
", "CreateDataSetResponse$Status": "The HTTP status of the request.
", "CreateDataSourceResponse$Status": "The HTTP status of the request.
", @@ -2659,6 +2875,7 @@ "CreateThemeAliasResponse$Status": "The HTTP status of the request.
", "CreateThemeResponse$Status": "The HTTP status of the request.
", "DeleteAccountCustomizationResponse$Status": "The HTTP status of the request.
", + "DeleteAnalysisResponse$Status": "The HTTP status of the request.
", "DeleteDashboardResponse$Status": "The HTTP status of the request.
", "DeleteDataSetResponse$Status": "The HTTP status of the request.
", "DeleteDataSourceResponse$Status": "The HTTP status of the request.
", @@ -2674,6 +2891,8 @@ "DeleteUserResponse$Status": "The HTTP status of the request.
", "DescribeAccountCustomizationResponse$Status": "The HTTP status of the request.
", "DescribeAccountSettingsResponse$Status": "The HTTP status of the request.
", + "DescribeAnalysisPermissionsResponse$Status": "The HTTP status of the request.
", + "DescribeAnalysisResponse$Status": "The HTTP status of the request.
", "DescribeDashboardPermissionsResponse$Status": "The HTTP status of the request.
", "DescribeDashboardResponse$Status": "The HTTP status of this request.
", "DescribeDataSetPermissionsResponse$Status": "The HTTP status of the request.
", @@ -2693,6 +2912,7 @@ "DescribeUserResponse$Status": "The HTTP status of the request.
", "GetDashboardEmbedUrlResponse$Status": "The HTTP status of the request.
", "GetSessionEmbedUrlResponse$Status": "The HTTP status of the request.
", + "ListAnalysesResponse$Status": "The HTTP status of the request.
", "ListDashboardVersionsResponse$Status": "The HTTP status of the request.
", "ListDashboardsResponse$Status": "The HTTP status of the request.
", "ListDataSetsResponse$Status": "The HTTP status of the request.
", @@ -2713,11 +2933,15 @@ "ListUserGroupsResponse$Status": "The HTTP status of the request.
", "ListUsersResponse$Status": "The HTTP status of the request.
", "RegisterUserResponse$Status": "The HTTP status of the request.
", + "RestoreAnalysisResponse$Status": "The HTTP status of the request.
", + "SearchAnalysesResponse$Status": "The HTTP status of the request.
", "SearchDashboardsResponse$Status": "The HTTP status of the request.
", "TagResourceResponse$Status": "The HTTP status of the request.
", "UntagResourceResponse$Status": "The HTTP status of the request.
", "UpdateAccountCustomizationResponse$Status": "The HTTP status of the request.
", "UpdateAccountSettingsResponse$Status": "The HTTP status of the request.
", + "UpdateAnalysisPermissionsResponse$Status": "The HTTP status of the request.
", + "UpdateAnalysisResponse$Status": "The HTTP status of the request.
", "UpdateDashboardPermissionsResponse$Status": "The HTTP status of the request.
", "UpdateDashboardPublishedVersionResponse$Status": "The HTTP status of the request.
", "UpdateDashboardResponse$Status": "The HTTP status of the request.
", @@ -2741,9 +2965,10 @@ "refs": { "AccessDeniedException$Message": null, "AccessDeniedException$RequestId": "The AWS request ID for this request.
", - "AccountSettings$AccountName": "The name associated with the QuickSight subscription in your AWS account.
", + "AccountSettings$AccountName": "The \"account name\" you provided for the QuickSight subscription in your AWS account. You create this name when you sign up for QuickSight. It is unique in all of AWS and it appears only in the console when users sign in.
", "AccountSettings$NotificationEmail": "The main notification email for your QuickSight subscription.
", "ActionList$member": null, + "AnalysisSearchFilter$Value": "The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example \"Value\". An example is \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".
The name of the column group's column schema.
", "ColumnGroupSchema$Name": "The name of the column group schema.
", "ColumnSchema$Name": "The name of the column schema.
", @@ -2754,6 +2979,7 @@ "ConflictException$Message": null, "ConflictException$RequestId": "The AWS request ID for this request.
", "CreateAccountCustomizationResponse$RequestId": "The AWS request ID for this operation.
", + "CreateAnalysisResponse$RequestId": "The AWS request ID for this operation.
", "CreateDashboardResponse$RequestId": "The AWS request ID for this operation.
", "CreateDataSetResponse$RequestId": "The AWS request ID for this operation.
", "CreateDataSourceResponse$RequestId": "The AWS request ID for this operation.
", @@ -2771,6 +2997,7 @@ "DataSetConfiguration$Placeholder": "Placeholder.
", "DataSourceErrorInfo$Message": "Error message.
", "DeleteAccountCustomizationResponse$RequestId": "The AWS request ID for this operation.
", + "DeleteAnalysisResponse$RequestId": "The AWS request ID for this operation.
", "DeleteDashboardResponse$RequestId": "The AWS request ID for this operation.
", "DeleteDataSetResponse$RequestId": "The AWS request ID for this operation.
", "DeleteDataSourceResponse$RequestId": "The AWS request ID for this operation.
", @@ -2787,6 +3014,8 @@ "DeleteUserResponse$RequestId": "The AWS request ID for this operation.
", "DescribeAccountCustomizationResponse$RequestId": "The AWS request ID for this operation.
", "DescribeAccountSettingsResponse$RequestId": "The AWS request ID for this operation.
", + "DescribeAnalysisPermissionsResponse$RequestId": "The AWS request ID for this operation.
", + "DescribeAnalysisResponse$RequestId": "The AWS request ID for this operation.
", "DescribeDashboardPermissionsResponse$RequestId": "The AWS request ID for this operation.
", "DescribeDashboardResponse$RequestId": "The AWS request ID for this operation.
", "DescribeDataSetPermissionsResponse$RequestId": "The AWS request ID for this operation.
", @@ -2820,6 +3049,9 @@ "InvalidParameterValueException$RequestId": "The AWS request ID for this request.
", "LimitExceededException$Message": null, "LimitExceededException$RequestId": "The AWS request ID for this request.
", + "ListAnalysesRequest$NextToken": "A pagination token that can be used in a subsequent request.
", + "ListAnalysesResponse$NextToken": "A pagination token that can be used in a subsequent request.
", + "ListAnalysesResponse$RequestId": "The AWS request ID for this operation.
", "ListDashboardVersionsRequest$NextToken": "The token for the next set of results, or null if there are no more results.
", "ListDashboardVersionsResponse$NextToken": "The token for the next set of results, or null if there are no more results.
", "ListDashboardVersionsResponse$RequestId": "The AWS request ID for this operation.
", @@ -2889,6 +3121,10 @@ "ResourceNotFoundException$RequestId": "The AWS request ID for this request.
", "ResourceUnavailableException$Message": null, "ResourceUnavailableException$RequestId": "The AWS request ID for this request.
", + "RestoreAnalysisResponse$RequestId": "The AWS request ID for this operation.
", + "SearchAnalysesRequest$NextToken": "A pagination token that can be used in a subsequent request.
", + "SearchAnalysesResponse$NextToken": "A pagination token that can be used in a subsequent request.
", + "SearchAnalysesResponse$RequestId": "The AWS request ID for this operation.
", "SearchDashboardsRequest$NextToken": "The token for the next set of results, or null if there are no more results.
", "SearchDashboardsResponse$NextToken": "The token for the next set of results, or null if there are no more results.
", "SearchDashboardsResponse$RequestId": "The AWS request ID for this operation.
", @@ -2902,8 +3138,10 @@ "UnsupportedUserEditionException$RequestId": "The AWS request ID for this request.
", "UntagResourceResponse$RequestId": "The AWS request ID for this operation.
", "UpdateAccountCustomizationResponse$RequestId": "The AWS request ID for this operation.
", - "UpdateAccountSettingsRequest$NotificationEmail": "Email address used to send notifications regarding administration of QuickSight.
", + "UpdateAccountSettingsRequest$NotificationEmail": "The email address that you want QuickSight to send notifications to regarding your AWS account or QuickSight subscription.
", "UpdateAccountSettingsResponse$RequestId": "The AWS request ID for this operation.
", + "UpdateAnalysisPermissionsResponse$RequestId": "The AWS request ID for this operation.
", + "UpdateAnalysisResponse$RequestId": "The AWS request ID for this operation.
", "UpdateDashboardPermissionsResponse$RequestId": "The AWS request ID for this operation.
", "UpdateDashboardPublishedVersionResponse$RequestId": "The AWS request ID for this operation.
", "UpdateDashboardResponse$RequestId": "The AWS request ID for this operation.
", @@ -2929,11 +3167,11 @@ "StringList": { "base": null, "refs": { - "StringParameter$Values": "Values.
" + "StringParameter$Values": "The values of a string parameter.
" } }, "StringParameter": { - "base": "String parameter.
", + "base": "A string parameter.
", "refs": { "StringParameterList$member": null } @@ -2972,6 +3210,7 @@ "TagList": { "base": null, "refs": { + "CreateAnalysisRequest$Tags": "Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
", "CreateDashboardRequest$Tags": "Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
", "CreateDataSetRequest$Tags": "Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
", "CreateDataSourceRequest$Tags": "Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
", @@ -2999,7 +3238,7 @@ } }, "Template": { - "base": "A template object. A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create a dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
You can share templates across AWS accounts by allowing users in other AWS accounts to create a template or a dashboard from an existing template.
", + "base": "A template object. A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create a dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with an analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
You can share templates across AWS accounts by allowing users in other AWS accounts to create a template or a dashboard from an existing template.
", "refs": { "DescribeTemplateResponse$Template": "The template structure for the object you want to describe.
" } @@ -3028,7 +3267,7 @@ "TemplateErrorList": { "base": null, "refs": { - "TemplateVersion$Errors": "Errors associated with the template.
" + "TemplateVersion$Errors": "Errors associated with this template version.
" } }, "TemplateErrorType": { @@ -3108,7 +3347,7 @@ } }, "Theme": { - "base": "", + "base": "Summary information about a theme.
", "refs": { "DescribeThemeResponse$Theme": "The information about the theme that you are describing.
" } @@ -3220,6 +3459,10 @@ "Timestamp": { "base": null, "refs": { + "Analysis$CreatedTime": "The time that the analysis was created.
", + "Analysis$LastUpdatedTime": "The time that the analysis was last updated.
", + "AnalysisSummary$CreatedTime": "The time that the analysis was created.
", + "AnalysisSummary$LastUpdatedTime": "The time that the analysis was last updated.
", "Dashboard$CreatedTime": "The time that this dataset was created.
", "Dashboard$LastPublishedTime": "The last time that this dataset was published.
", "Dashboard$LastUpdatedTime": "The last time that this dataset was updated.
", @@ -3234,6 +3477,7 @@ "DataSetSummary$LastUpdatedTime": "The last time that this dataset was updated.
", "DataSource$CreatedTime": "The time that this data source was created.
", "DataSource$LastUpdatedTime": "The last time that this data source was updated.
", + "DeleteAnalysisResponse$DeletionTime": "The date and time that the analysis is scheduled to be deleted.
", "Template$LastUpdatedTime": "Time when this was last updated.
", "Template$CreatedTime": "Time when this was created.
", "TemplateSummary$CreatedTime": "The last time that this template was created.
", @@ -3252,7 +3496,7 @@ "TimestampList": { "base": null, "refs": { - "DateTimeParameter$Values": "Values.
" + "DateTimeParameter$Values": "The values for the date-time parameter.
" } }, "TransformOperation": { @@ -3320,6 +3564,26 @@ "refs": { } }, + "UpdateAnalysisPermissionsRequest": { + "base": null, + "refs": { + } + }, + "UpdateAnalysisPermissionsResponse": { + "base": null, + "refs": { + } + }, + "UpdateAnalysisRequest": { + "base": null, + "refs": { + } + }, + "UpdateAnalysisResponse": { + "base": null, + "refs": { + } + }, "UpdateDashboardPermissionsRequest": { "base": null, "refs": { @@ -3413,6 +3677,8 @@ "UpdateResourcePermissionList": { "base": null, "refs": { + "UpdateAnalysisPermissionsRequest$GrantPermissions": "A structure that describes the permissions to add and the principal to add them to.
", + "UpdateAnalysisPermissionsRequest$RevokePermissions": "A structure that describes the permissions to remove and the principal to remove them from.
", "UpdateDashboardPermissionsRequest$GrantPermissions": "The permissions that you want to grant on this resource.
", "UpdateDashboardPermissionsRequest$RevokePermissions": "The permissions that you want to revoke from this resource.
", "UpdateTemplatePermissionsRequest$GrantPermissions": "A list of resource permissions to be granted on the template.
", @@ -3498,10 +3764,10 @@ } }, "User": { - "base": "A registered user of Amazon QuickSight. Currently, an Amazon QuickSight subscription can't contain more than 20 million users.
", + "base": "A registered user of Amazon QuickSight.
", "refs": { "DescribeUserResponse$User": "The user name.
", - "RegisterUserResponse$User": "The user name.
", + "RegisterUserResponse$User": "The user's user name.
", "UpdateUserResponse$User": "The Amazon QuickSight user.
", "UserList$member": null } @@ -3528,7 +3794,7 @@ "base": null, "refs": { "RegisterUserRequest$UserRole": "The Amazon QuickSight role for the user. The user role can be one of the following:
READER: A user who has read-only access to dashboards.
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
RESTRICTED_READER: This role isn't currently available for use.
RESTRICTED_AUTHOR: This role isn't currently available for use.
The Amazon QuickSight role of the user. The user role can be one of the following:
READER: A user who has read-only access to dashboards.
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:
READER: A user who has read-only access to dashboards.
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
The name of the QuickSight role is invisible to the user except for the console screens dealing with permissions.
", "User$Role": "The Amazon QuickSight role for the user. The user role can be one of the following:.
READER: A user who has read-only access to dashboards.
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
RESTRICTED_READER: This role isn't currently available for use.
RESTRICTED_AUTHOR: This role isn't currently available for use.
The version number of the template.
", "CreateThemeAliasRequest$ThemeVersionNumber": "The version number of the theme.
", "DashboardSummary$PublishedVersionNumber": "Published version number.
", - "DashboardVersion$VersionNumber": "Version number.
", + "DashboardVersion$VersionNumber": "Version number for this version of the dashboard.
", "DashboardVersionSummary$VersionNumber": "Version number.
", "DeleteDashboardRequest$VersionNumber": "The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.
", "DeleteTemplateRequest$VersionNumber": "Specifies the version of the template that you want to delete. If you don't provide a version number, DeleteTemplate deletes all versions of the template.
The version number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the theme is described.
The version number of the template alias.
", "TemplateSummary$LatestVersionNumber": "A structure containing a list of version numbers for the template summary.
", - "TemplateVersion$VersionNumber": "The version number of the template.
", + "TemplateVersion$VersionNumber": "The version number of the template version.
", "TemplateVersionSummary$VersionNumber": "The version number of the template version.
", "ThemeAlias$ThemeVersionNumber": "The version number of the theme alias.
", "ThemeSummary$LatestVersionNumber": "The latest version number for the theme.
", @@ -3606,7 +3872,8 @@ "base": null, "refs": { "BorderStyle$Show": "The option to enable display of borders for visuals.
", - "DescribeAccountCustomizationRequest$Resolved": "The status of the creation of the customization. This is an asynchronous process. A status of CREATED means that your customization is ready to use.
This option defaults to the value NoForceDeleteWithoutRecovery. To immediately delete the analysis, add the ForceDeleteWithoutRecovery option. You can't restore an analysis after it's deleted.
The Resolved flag works with the other parameters to determine which view of QuickSight customizations is returned. You can add this flag to your command to use the same view that QuickSight uses to identify which customizations to apply to the console. Omit this flag, or set it to no-resolved, to reveal customizations that are configured at different levels.
Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
", "GetDashboardEmbedUrlRequest$ResetDisabled": "Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
", "GutterStyle$Show": "This Boolean value controls whether to display a gutter space between sheet tiles.
", diff --git a/models/apis/quicksight/2018-04-01/paginators-1.json b/models/apis/quicksight/2018-04-01/paginators-1.json index 8992eaa7ba..4ac6a05252 100644 --- a/models/apis/quicksight/2018-04-01/paginators-1.json +++ b/models/apis/quicksight/2018-04-01/paginators-1.json @@ -1,5 +1,10 @@ { "pagination": { + "ListAnalyses": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, "ListDashboardVersions": { "input_token": "NextToken", "output_token": "NextToken", @@ -45,6 +50,11 @@ "output_token": "NextToken", "limit_key": "MaxResults" }, + "SearchAnalyses": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, "SearchDashboards": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/models/apis/robomaker/2018-06-29/api-2.json b/models/apis/robomaker/2018-06-29/api-2.json index 4eba176c6a..907614eac1 100644 --- a/models/apis/robomaker/2018-06-29/api-2.json +++ b/models/apis/robomaker/2018-06-29/api-2.json @@ -13,6 +13,20 @@ "uid":"robomaker-2018-06-29" }, "operations":{ + "BatchDeleteWorlds":{ + "name":"BatchDeleteWorlds", + "http":{ + "method":"POST", + "requestUri":"/batchDeleteWorlds" + }, + "input":{"shape":"BatchDeleteWorldsRequest"}, + "output":{"shape":"BatchDeleteWorldsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "BatchDescribeSimulationJob":{ "name":"BatchDescribeSimulationJob", "http":{ @@ -73,6 +87,36 @@ {"shape":"ThrottlingException"} ] }, + "CancelWorldExportJob":{ + "name":"CancelWorldExportJob", + "http":{ + "method":"POST", + "requestUri":"/cancelWorldExportJob" + }, + "input":{"shape":"CancelWorldExportJobRequest"}, + "output":{"shape":"CancelWorldExportJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ] + }, + "CancelWorldGenerationJob":{ + "name":"CancelWorldGenerationJob", + "http":{ + "method":"POST", + "requestUri":"/cancelWorldGenerationJob" + }, + "input":{"shape":"CancelWorldGenerationJobRequest"}, + "output":{"shape":"CancelWorldGenerationJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ] + }, "CreateDeploymentJob":{ "name":"CreateDeploymentJob", "http":{ @@ -206,6 +250,58 @@ {"shape":"ServiceUnavailableException"} ] }, + "CreateWorldExportJob":{ + "name":"CreateWorldExportJob", + "http":{ + "method":"POST", + "requestUri":"/createWorldExportJob" + }, + "input":{"shape":"CreateWorldExportJobRequest"}, + "output":{"shape":"CreateWorldExportJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "CreateWorldGenerationJob":{ + "name":"CreateWorldGenerationJob", + "http":{ + "method":"POST", + "requestUri":"/createWorldGenerationJob" + }, + "input":{"shape":"CreateWorldGenerationJobRequest"}, + "output":{"shape":"CreateWorldGenerationJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"ServiceUnavailableException"} + ] + }, + "CreateWorldTemplate":{ + "name":"CreateWorldTemplate", + "http":{ + "method":"POST", + "requestUri":"/createWorldTemplate" + }, + "input":{"shape":"CreateWorldTemplateRequest"}, + "output":{"shape":"CreateWorldTemplateResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "DeleteFleet":{ "name":"DeleteFleet", "http":{ @@ -262,6 +358,21 @@ {"shape":"InternalServerException"} ] }, + "DeleteWorldTemplate":{ + "name":"DeleteWorldTemplate", + "http":{ + "method":"POST", + "requestUri":"/deleteWorldTemplate" + }, + "input":{"shape":"DeleteWorldTemplateRequest"}, + "output":{"shape":"DeleteWorldTemplateResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "DeregisterRobot":{ "name":"DeregisterRobot", "http":{ @@ -381,6 +492,81 @@ {"shape":"InternalServerException"} ] }, + "DescribeWorld":{ + "name":"DescribeWorld", + "http":{ + "method":"POST", + "requestUri":"/describeWorld" + }, + "input":{"shape":"DescribeWorldRequest"}, + "output":{"shape":"DescribeWorldResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, + "DescribeWorldExportJob":{ + "name":"DescribeWorldExportJob", + "http":{ + "method":"POST", + "requestUri":"/describeWorldExportJob" + }, + "input":{"shape":"DescribeWorldExportJobRequest"}, + "output":{"shape":"DescribeWorldExportJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ] + }, + "DescribeWorldGenerationJob":{ + "name":"DescribeWorldGenerationJob", + "http":{ + "method":"POST", + "requestUri":"/describeWorldGenerationJob" + }, + "input":{"shape":"DescribeWorldGenerationJobRequest"}, + "output":{"shape":"DescribeWorldGenerationJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ] + }, + "DescribeWorldTemplate":{ + "name":"DescribeWorldTemplate", + "http":{ + "method":"POST", + "requestUri":"/describeWorldTemplate" + }, + "input":{"shape":"DescribeWorldTemplateRequest"}, + "output":{"shape":"DescribeWorldTemplateResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, + "GetWorldTemplateBody":{ + "name":"GetWorldTemplateBody", + "http":{ + "method":"POST", + "requestUri":"/getWorldTemplateBody" + }, + "input":{"shape":"GetWorldTemplateBodyRequest"}, + "output":{"shape":"GetWorldTemplateBodyResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "ListDeploymentJobs":{ "name":"ListDeploymentJobs", "http":{ @@ -496,6 +682,62 @@ {"shape":"ThrottlingException"} ] }, + "ListWorldExportJobs":{ + "name":"ListWorldExportJobs", + "http":{ + "method":"POST", + "requestUri":"/listWorldExportJobs" + }, + "input":{"shape":"ListWorldExportJobsRequest"}, + "output":{"shape":"ListWorldExportJobsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ] + }, + "ListWorldGenerationJobs":{ + "name":"ListWorldGenerationJobs", + "http":{ + "method":"POST", + "requestUri":"/listWorldGenerationJobs" + }, + "input":{"shape":"ListWorldGenerationJobsRequest"}, + "output":{"shape":"ListWorldGenerationJobsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ] + }, + "ListWorldTemplates":{ + "name":"ListWorldTemplates", + "http":{ + "method":"POST", + "requestUri":"/listWorldTemplates" + }, + "input":{"shape":"ListWorldTemplatesRequest"}, + "output":{"shape":"ListWorldTemplatesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, + "ListWorlds":{ + "name":"ListWorlds", + "http":{ + "method":"POST", + "requestUri":"/listWorlds" + }, + "input":{"shape":"ListWorldsRequest"}, + "output":{"shape":"ListWorldsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "RegisterRobot":{ "name":"RegisterRobot", "http":{ @@ -623,6 +865,21 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ] + }, + "UpdateWorldTemplate":{ + "name":"UpdateWorldTemplate", + "http":{ + "method":"POST", + "requestUri":"/updateWorldTemplate" + }, + "input":{"shape":"UpdateWorldTemplateRequest"}, + "output":{"shape":"UpdateWorldTemplateResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] } }, "shapes":{ @@ -646,6 +903,19 @@ "max":100, "min":1 }, + "BatchDeleteWorldsRequest":{ + "type":"structure", + "required":["worlds"], + "members":{ + "worlds":{"shape":"Arns"} + } + }, + "BatchDeleteWorldsResponse":{ + "type":"structure", + "members":{ + "unprocessedWorlds":{"shape":"Arns"} + } + }, "BatchDescribeSimulationJobRequest":{ "type":"structure", "required":["jobs"], @@ -706,6 +976,30 @@ "members":{ } }, + "CancelWorldExportJobRequest":{ + "type":"structure", + "required":["job"], + "members":{ + "job":{"shape":"Arn"} + } + }, + "CancelWorldExportJobResponse":{ + "type":"structure", + "members":{ + } + }, + "CancelWorldGenerationJobRequest":{ + "type":"structure", + "required":["job"], + "members":{ + "job":{"shape":"Arn"} + } + }, + "CancelWorldGenerationJobResponse":{ + "type":"structure", + "members":{ + } + }, "ClientRequestToken":{ "type":"string", "max":64, @@ -940,6 +1234,7 @@ "CreateSimulationJobRequests":{ "type":"list", "member":{"shape":"SimulationJobRequest"}, + "max":1000, "min":1 }, "CreateSimulationJobResponse":{ @@ -965,6 +1260,86 @@ "compute":{"shape":"ComputeResponse"} } }, + "CreateWorldExportJobRequest":{ + "type":"structure", + "required":[ + "worlds", + "outputLocation", + "iamRole" + ], + "members":{ + "clientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + }, + "worlds":{"shape":"Arns"}, + "outputLocation":{"shape":"OutputLocation"}, + "iamRole":{"shape":"IamRole"}, + "tags":{"shape":"TagMap"} + } + }, + "CreateWorldExportJobResponse":{ + "type":"structure", + "members":{ + "arn":{"shape":"Arn"}, + "status":{"shape":"WorldExportJobStatus"}, + "createdAt":{"shape":"CreatedAt"}, + "failureCode":{"shape":"WorldExportJobErrorCode"}, + "clientRequestToken":{"shape":"ClientRequestToken"}, + "outputLocation":{"shape":"OutputLocation"}, + "iamRole":{"shape":"IamRole"}, + "tags":{"shape":"TagMap"} + } + }, + "CreateWorldGenerationJobRequest":{ + "type":"structure", + "required":[ + "template", + "worldCount" + ], + "members":{ + "clientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + }, + "template":{"shape":"Arn"}, + "worldCount":{"shape":"WorldCount"}, + "tags":{"shape":"TagMap"} + } + }, + "CreateWorldGenerationJobResponse":{ + "type":"structure", + "members":{ + "arn":{"shape":"Arn"}, + "status":{"shape":"WorldGenerationJobStatus"}, + "createdAt":{"shape":"CreatedAt"}, + "failureCode":{"shape":"WorldGenerationJobErrorCode"}, + "clientRequestToken":{"shape":"ClientRequestToken"}, + "template":{"shape":"Arn"}, + "worldCount":{"shape":"WorldCount"}, + "tags":{"shape":"TagMap"} + } + }, + "CreateWorldTemplateRequest":{ + "type":"structure", + "members":{ + "clientRequestToken":{"shape":"ClientRequestToken"}, + "name":{"shape":"TemplateName"}, + "templateBody":{"shape":"Json"}, + "templateLocation":{"shape":"TemplateLocation"}, + "tags":{"shape":"TagMap"} + } + }, + "CreateWorldTemplateResponse":{ + "type":"structure", + "members":{ + "arn":{"shape":"Arn"}, + "clientRequestToken":{"shape":"ClientRequestToken"}, + "createdAt":{"shape":"CreatedAt"}, + "name":{"shape":"TemplateName"}, + "tags":{"shape":"TagMap"} + } + }, "CreatedAt":{"type":"timestamp"}, "DataSource":{ "type":"structure", @@ -1051,6 +1426,18 @@ "members":{ } }, + "DeleteWorldTemplateRequest":{ + "type":"structure", + "required":["template"], + "members":{ + "template":{"shape":"Arn"} + } + }, + "DeleteWorldTemplateResponse":{ + "type":"structure", + "members":{ + } + }, "DeploymentApplicationConfig":{ "type":"structure", "required":[ @@ -1338,6 +1725,85 @@ "compute":{"shape":"ComputeResponse"} } }, + "DescribeWorldExportJobRequest":{ + "type":"structure", + "required":["job"], + "members":{ + "job":{"shape":"Arn"} + } + }, + "DescribeWorldExportJobResponse":{ + "type":"structure", + "members":{ + "arn":{"shape":"Arn"}, + "status":{"shape":"WorldExportJobStatus"}, + "createdAt":{"shape":"CreatedAt"}, + "failureCode":{"shape":"WorldExportJobErrorCode"}, + "failureReason":{"shape":"GenericString"}, + "clientRequestToken":{"shape":"ClientRequestToken"}, + "worlds":{"shape":"Arns"}, + "outputLocation":{"shape":"OutputLocation"}, + "iamRole":{"shape":"IamRole"}, + "tags":{"shape":"TagMap"} + } + }, + "DescribeWorldGenerationJobRequest":{ + "type":"structure", + "required":["job"], + "members":{ + "job":{"shape":"Arn"} + } + }, + "DescribeWorldGenerationJobResponse":{ + "type":"structure", + "members":{ + "arn":{"shape":"Arn"}, + "status":{"shape":"WorldGenerationJobStatus"}, + "createdAt":{"shape":"CreatedAt"}, + "failureCode":{"shape":"WorldGenerationJobErrorCode"}, + "failureReason":{"shape":"GenericString"}, + "clientRequestToken":{"shape":"ClientRequestToken"}, + "template":{"shape":"Arn"}, + "worldCount":{"shape":"WorldCount"}, + "finishedWorldsSummary":{"shape":"FinishedWorldsSummary"}, + "tags":{"shape":"TagMap"} + } + }, + "DescribeWorldRequest":{ + "type":"structure", + "required":["world"], + "members":{ + "world":{"shape":"Arn"} + } + }, + "DescribeWorldResponse":{ + "type":"structure", + "members":{ + "arn":{"shape":"Arn"}, + "generationJob":{"shape":"Arn"}, + "template":{"shape":"Arn"}, + "createdAt":{"shape":"CreatedAt"}, + "tags":{"shape":"TagMap"} + } + }, + "DescribeWorldTemplateRequest":{ + "type":"structure", + "required":["template"], + "members":{ + "template":{"shape":"Arn"} + } + }, + "DescribeWorldTemplateResponse":{ + "type":"structure", + "members":{ + "arn":{"shape":"Arn"}, + "clientRequestToken":{"shape":"ClientRequestToken"}, + "name":{"shape":"TemplateName"}, + "createdAt":{"shape":"CreatedAt"}, + "lastUpdatedAt":{"shape":"LastUpdatedAt"}, + "tags":{"shape":"TagMap"} + } + }, "EnvironmentVariableKey":{ "type":"string", "max":1024, @@ -1378,6 +1844,13 @@ "Continue" ] }, + "FailureSummary":{ + "type":"structure", + "members":{ + "totalFailureCount":{"shape":"Integer"}, + "failures":{"shape":"WorldFailures"} + } + }, "Filter":{ "type":"structure", "members":{ @@ -1397,6 +1870,14 @@ "max":1, "min":1 }, + "FinishedWorldsSummary":{ + "type":"structure", + "members":{ + "finishedCount":{"shape":"Integer"}, + "succeededWorlds":{"shape":"Arns"}, + "failureSummary":{"shape":"FailureSummary"} + } + }, "Fleet":{ "type":"structure", "members":{ @@ -1414,6 +1895,7 @@ "max":200, "min":0 }, + "FloorplanCount":{"type":"integer"}, "GenericInteger":{"type":"integer"}, "GenericString":{ "type":"string", @@ -1421,6 +1903,19 @@ "min":0, "pattern":".*" }, + "GetWorldTemplateBodyRequest":{ + "type":"structure", + "members":{ + "template":{"shape":"Arn"}, + "generationJob":{"shape":"Arn"} + } + }, + "GetWorldTemplateBodyResponse":{ + "type":"structure", + "members":{ + "templateBody":{"shape":"Json"} + } + }, "IamRole":{ "type":"string", "max":255, @@ -1442,6 +1937,7 @@ "exception":true }, "Integer":{"type":"integer"}, + "InteriorCountPerFloorplan":{"type":"integer"}, "InternalServerException":{ "type":"structure", "members":{ @@ -1459,6 +1955,12 @@ "exception":true }, "JobDuration":{"type":"long"}, + "Json":{ + "type":"string", + "max":262144, + "min":1, + "pattern":"[\\S\\s]+" + }, "LastStartedAt":{"type":"timestamp"}, "LastUpdatedAt":{"type":"timestamp"}, "LaunchConfig":{ @@ -1608,6 +2110,67 @@ "tags":{"shape":"TagMap"} } }, + "ListWorldExportJobsRequest":{ + "type":"structure", + "members":{ + "nextToken":{"shape":"PaginationToken"}, + "maxResults":{"shape":"MaxResults"}, + "filters":{"shape":"Filters"} + } + }, + "ListWorldExportJobsResponse":{ + "type":"structure", + "required":["worldExportJobSummaries"], + "members":{ + "worldExportJobSummaries":{"shape":"WorldExportJobSummaries"}, + "nextToken":{"shape":"PaginationToken"} + } + }, + "ListWorldGenerationJobsRequest":{ + "type":"structure", + "members":{ + "nextToken":{"shape":"PaginationToken"}, + "maxResults":{"shape":"MaxResults"}, + "filters":{"shape":"Filters"} + } + }, + "ListWorldGenerationJobsResponse":{ + "type":"structure", + "required":["worldGenerationJobSummaries"], + "members":{ + "worldGenerationJobSummaries":{"shape":"WorldGenerationJobSummaries"}, + "nextToken":{"shape":"PaginationToken"} + } + }, + "ListWorldTemplatesRequest":{ + "type":"structure", + "members":{ + "nextToken":{"shape":"PaginationToken"}, + "maxResults":{"shape":"MaxResults"} + } + }, + "ListWorldTemplatesResponse":{ + "type":"structure", + "members":{ + "templateSummaries":{"shape":"TemplateSummaries"}, + "nextToken":{"shape":"PaginationToken"} + } + }, + "ListWorldsRequest":{ + "type":"structure", + "members":{ + "nextToken":{"shape":"PaginationToken"}, + "maxResults":{"shape":"MaxResults"}, + "filters":{"shape":"Filters"} + } + }, + "ListWorldsResponse":{ + "type":"structure", + "members":{ + "worldSummaries":{"shape":"WorldSummaries"}, + "nextToken":{"shape":"PaginationToken"} + } + }, "LoggingConfig":{ "type":"structure", "required":["recordAllRosTopics"], @@ -1963,7 +2526,8 @@ "members":{ "application":{"shape":"Arn"}, "applicationVersion":{"shape":"Version"}, - "launchConfig":{"shape":"LaunchConfig"} + "launchConfig":{"shape":"LaunchConfig"}, + "worldConfigs":{"shape":"WorldConfigs"} } }, "SimulationApplicationConfigs":{ @@ -2296,6 +2860,36 @@ "min":0, "pattern":"[a-zA-Z0-9 _.\\-\\/+=:]*" }, + "TemplateLocation":{ + "type":"structure", + "required":[ + "s3Bucket", + "s3Key" + ], + "members":{ + "s3Bucket":{"shape":"S3Bucket"}, + "s3Key":{"shape":"S3Key"} + } + }, + "TemplateName":{ + "type":"string", + "max":255, + "min":0, + "pattern":".*" + }, + "TemplateSummaries":{ + "type":"list", + "member":{"shape":"TemplateSummary"} + }, + "TemplateSummary":{ + "type":"structure", + "members":{ + "arn":{"shape":"Arn"}, + "createdAt":{"shape":"CreatedAt"}, + "lastUpdatedAt":{"shape":"LastUpdatedAt"}, + "name":{"shape":"TemplateName"} + } + }, "ThrottlingException":{ "type":"structure", "members":{ @@ -2385,6 +2979,25 @@ "revisionId":{"shape":"RevisionId"} } }, + "UpdateWorldTemplateRequest":{ + "type":"structure", + "required":["template"], + "members":{ + "template":{"shape":"Arn"}, + "name":{"shape":"TemplateName"}, + "templateBody":{"shape":"Json"}, + "templateLocation":{"shape":"TemplateLocation"} + } + }, + "UpdateWorldTemplateResponse":{ + "type":"structure", + "members":{ + "arn":{"shape":"Arn"}, + "name":{"shape":"TemplateName"}, + "createdAt":{"shape":"CreatedAt"}, + "lastUpdatedAt":{"shape":"LastUpdatedAt"} + } + }, "VPCConfig":{ "type":"structure", "required":["subnets"], @@ -2415,6 +3028,130 @@ "min":1, "pattern":"ALL" }, + "WorldConfig":{ + "type":"structure", + "members":{ + "world":{"shape":"Arn"} + } + }, + "WorldConfigs":{ + "type":"list", + "member":{"shape":"WorldConfig"}, + "max":1, + "min":0 + }, + "WorldCount":{ + "type":"structure", + "members":{ + "floorplanCount":{"shape":"FloorplanCount"}, + "interiorCountPerFloorplan":{"shape":"InteriorCountPerFloorplan"} + } + }, + "WorldExportJobErrorCode":{ + "type":"string", + "enum":[ + "InternalServiceError", + "LimitExceeded", + "ResourceNotFound", + "RequestThrottled", + "InvalidInput", + "AccessDenied" + ] + }, + "WorldExportJobStatus":{ + "type":"string", + "enum":[ + "Pending", + "Running", + "Completed", + "Failed", + "Canceling", + "Canceled" + ] + }, + "WorldExportJobSummaries":{ + "type":"list", + "member":{"shape":"WorldExportJobSummary"}, + "max":100, + "min":0 + }, + "WorldExportJobSummary":{ + "type":"structure", + "members":{ + "arn":{"shape":"Arn"}, + "status":{"shape":"WorldExportJobStatus"}, + "createdAt":{"shape":"CreatedAt"}, + "worlds":{"shape":"Arns"} + } + }, + "WorldFailure":{ + "type":"structure", + "members":{ + "failureCode":{"shape":"WorldGenerationJobErrorCode"}, + "sampleFailureReason":{"shape":"GenericString"}, + "failureCount":{"shape":"Integer"} + } + }, + "WorldFailures":{ + "type":"list", + "member":{"shape":"WorldFailure"}, + "max":100, + "min":0 + }, + "WorldGenerationJobErrorCode":{ + "type":"string", + "enum":[ + "InternalServiceError", + "LimitExceeded", + "ResourceNotFound", + "RequestThrottled", + "InvalidInput", + "AllWorldGenerationFailed" + ] + }, + "WorldGenerationJobStatus":{ + "type":"string", + "enum":[ + "Pending", + "Running", + "Completed", + "Failed", + "PartialFailed", + "Canceling", + "Canceled" + ] + }, + "WorldGenerationJobSummaries":{ + "type":"list", + "member":{"shape":"WorldGenerationJobSummary"}, + "max":100, + "min":0 + }, + "WorldGenerationJobSummary":{ + "type":"structure", + "members":{ + "arn":{"shape":"Arn"}, + "template":{"shape":"Arn"}, + "createdAt":{"shape":"CreatedAt"}, + "status":{"shape":"WorldGenerationJobStatus"}, + "worldCount":{"shape":"WorldCount"}, + "succeededWorldCount":{"shape":"Integer"}, + "failedWorldCount":{"shape":"Integer"} + } + }, + "WorldSummaries":{ + "type":"list", + "member":{"shape":"WorldSummary"} + }, + "WorldSummary":{ + "type":"structure", + "members":{ + "arn":{"shape":"Arn"}, + "createdAt":{"shape":"CreatedAt"}, + "generationJob":{"shape":"Arn"}, + "template":{"shape":"Arn"} + } + }, "errorMessage":{"type":"string"} } } diff --git a/models/apis/robomaker/2018-06-29/docs-2.json b/models/apis/robomaker/2018-06-29/docs-2.json index 41c0f56195..9fa6c124dd 100644 --- a/models/apis/robomaker/2018-06-29/docs-2.json +++ b/models/apis/robomaker/2018-06-29/docs-2.json @@ -2,10 +2,13 @@ "version": "2.0", "service": "This section provides documentation for the AWS RoboMaker API operations.
", "operations": { + "BatchDeleteWorlds": "Deletes one or more worlds in a batch operation.
", "BatchDescribeSimulationJob": "Describes one or more simulation jobs.
", "CancelDeploymentJob": "Cancels the specified deployment job.
", "CancelSimulationJob": "Cancels the specified simulation job.
", "CancelSimulationJobBatch": "Cancels a simulation job batch. When you cancel a simulation job batch, you are also cancelling all of the active simulation jobs created as part of the batch.
", + "CancelWorldExportJob": "Cancels the specified export job.
", + "CancelWorldGenerationJob": "Cancels the specified world generator job.
", "CreateDeploymentJob": "Deploys a specific version of a robot application to robots in a fleet.
The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version.
After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.
Creates a fleet, a logical group of robots running the same robot application.
", "CreateRobot": "Creates a robot.
", @@ -14,10 +17,14 @@ "CreateSimulationApplication": "Creates a simulation application.
", "CreateSimulationApplicationVersion": "Creates a simulation application with a specific revision id.
", "CreateSimulationJob": "Creates a simulation job.
After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.
Creates a world export job.
", + "CreateWorldGenerationJob": "Creates worlds using the specified template.
", + "CreateWorldTemplate": "Creates a world template.
", "DeleteFleet": "Deletes a fleet.
", "DeleteRobot": "Deletes a robot.
", "DeleteRobotApplication": "Deletes a robot application.
", "DeleteSimulationApplication": "Deletes a simulation application.
", + "DeleteWorldTemplate": "Deletes a world template.
", "DeregisterRobot": "Deregisters a robot.
", "DescribeDeploymentJob": "Describes a deployment job.
", "DescribeFleet": "Describes a fleet.
", @@ -26,6 +33,11 @@ "DescribeSimulationApplication": "Describes a simulation application.
", "DescribeSimulationJob": "Describes a simulation job.
", "DescribeSimulationJobBatch": "Describes a simulation job batch.
", + "DescribeWorld": "Describes a world.
", + "DescribeWorldExportJob": "Describes a world export job.
", + "DescribeWorldGenerationJob": "Describes a world generation job.
", + "DescribeWorldTemplate": "Describes a world template.
", + "GetWorldTemplateBody": "Gets the world template body.
", "ListDeploymentJobs": "Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
", "ListFleets": "Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
", "ListRobotApplications": "Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
", @@ -34,6 +46,10 @@ "ListSimulationJobBatches": "Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.
", "ListSimulationJobs": "Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
", "ListTagsForResource": "Lists all tags on a AWS RoboMaker resource.
", + "ListWorldExportJobs": "Lists world export jobs.
", + "ListWorldGenerationJobs": "Lists world generator jobs.
", + "ListWorldTemplates": "Lists world templates.
", + "ListWorlds": "Lists worlds.
", "RegisterRobot": "Registers a robot with a fleet.
", "RestartSimulationJob": "Restarts a running simulation job.
", "StartSimulationJobBatch": "Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.
Adds or edits tags for a AWS RoboMaker resource.
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
", "UntagResource": "Removes the specified tags from the specified AWS RoboMaker resource.
To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource .
Updates a robot application.
", - "UpdateSimulationApplication": "Updates a simulation application.
" + "UpdateSimulationApplication": "Updates a simulation application.
", + "UpdateWorldTemplate": "Updates a world template.
" }, "shapes": { "Architecture": { @@ -62,6 +79,8 @@ "CancelDeploymentJobRequest$job": "The deployment job ARN to cancel.
", "CancelSimulationJobBatchRequest$batch": "The id of the batch to cancel.
", "CancelSimulationJobRequest$job": "The simulation job ARN to cancel.
", + "CancelWorldExportJobRequest$job": "The Amazon Resource Name (arn) of the world export job to cancel.
", + "CancelWorldGenerationJobRequest$job": "The Amazon Resource Name (arn) of the world generator job to cancel.
", "CreateDeploymentJobRequest$fleet": "The Amazon Resource Name (ARN) of the fleet to deploy.
", "CreateDeploymentJobResponse$arn": "The Amazon Resource Name (ARN) of the deployment job.
", "CreateDeploymentJobResponse$fleet": "The target fleet for the deployment job.
", @@ -74,10 +93,16 @@ "CreateSimulationApplicationVersionRequest$application": "The application information for the simulation application.
", "CreateSimulationApplicationVersionResponse$arn": "The Amazon Resource Name (ARN) of the simulation application.
", "CreateSimulationJobResponse$arn": "The Amazon Resource Name (ARN) of the simulation job.
", + "CreateWorldExportJobResponse$arn": "The Amazon Resource Name (ARN) of the world export job.
", + "CreateWorldGenerationJobRequest$template": "The Amazon Resource Name (arn) of the world template describing the worlds you want to create.
", + "CreateWorldGenerationJobResponse$arn": "The Amazon Resource Name (ARN) of the world generator job.
", + "CreateWorldGenerationJobResponse$template": "The Amazon Resource Name (arn) of the world template.
", + "CreateWorldTemplateResponse$arn": "The Amazon Resource Name (ARN) of the world template.
", "DeleteFleetRequest$fleet": "The Amazon Resource Name (ARN) of the fleet.
", "DeleteRobotApplicationRequest$application": "The Amazon Resource Name (ARN) of the the robot application.
", "DeleteRobotRequest$robot": "The Amazon Resource Name (ARN) of the robot.
", "DeleteSimulationApplicationRequest$application": "The application information for the simulation application to delete.
", + "DeleteWorldTemplateRequest$template": "The Amazon Resource Name (arn) of the world template you want to delete.
", "DeploymentApplicationConfig$application": "The Amazon Resource Name (ARN) of the robot application.
", "DeploymentJob$arn": "The Amazon Resource Name (ARN) of the deployment job.
", "DeploymentJob$fleet": "The Amazon Resource Name (ARN) of the fleet.
", @@ -103,8 +128,21 @@ "DescribeSimulationJobBatchResponse$arn": "The Amazon Resource Name (ARN) of the batch.
", "DescribeSimulationJobRequest$job": "The Amazon Resource Name (ARN) of the simulation job to be described.
", "DescribeSimulationJobResponse$arn": "The Amazon Resource Name (ARN) of the simulation job.
", + "DescribeWorldExportJobRequest$job": "The Amazon Resource Name (arn) of the world export job to describe.
", + "DescribeWorldExportJobResponse$arn": "The Amazon Resource Name (ARN) of the world export job.
", + "DescribeWorldGenerationJobRequest$job": "The Amazon Resource Name (arn) of the world generation job to describe.
", + "DescribeWorldGenerationJobResponse$arn": "The Amazon Resource Name (ARN) of the world generation job.
", + "DescribeWorldGenerationJobResponse$template": "The Amazon Resource Name (arn) of the world template.
", + "DescribeWorldRequest$world": "The Amazon Resource Name (arn) of the world you want to describe.
", + "DescribeWorldResponse$arn": "The Amazon Resource Name (arn) of the world.
", + "DescribeWorldResponse$generationJob": "The Amazon Resource Name (arn) of the world generation job that generated the world.
", + "DescribeWorldResponse$template": "The world template.
", + "DescribeWorldTemplateRequest$template": "The Amazon Resource Name (arn) of the world template you want to describe.
", + "DescribeWorldTemplateResponse$arn": "The Amazon Resource Name (ARN) of the world template.
", "Fleet$arn": "The Amazon Resource Name (ARN) of the fleet.
", "Fleet$lastDeploymentJob": "The Amazon Resource Name (ARN) of the last deployment job.
", + "GetWorldTemplateBodyRequest$template": "The Amazon Resource Name (arn) of the world template.
", + "GetWorldTemplateBodyRequest$generationJob": "The Amazon Resource Name (arn) of the world generator job.
", "ListTagsForResourceRequest$resourceArn": "The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.
", "RegisterRobotRequest$fleet": "The Amazon Resource Name (ARN) of the fleet.
", "RegisterRobotRequest$robot": "The Amazon Resource Name (ARN) of the robot.
", @@ -127,18 +165,44 @@ "SyncDeploymentJobResponse$arn": "The Amazon Resource Name (ARN) of the synchronization request.
", "SyncDeploymentJobResponse$fleet": "The Amazon Resource Name (ARN) of the fleet.
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.
", + "TemplateSummary$arn": "The Amazon Resource Name (ARN) of the template.
", "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.
", "UpdateRobotApplicationRequest$application": "The application information for the robot application.
", "UpdateRobotApplicationResponse$arn": "The Amazon Resource Name (ARN) of the updated robot application.
", "UpdateSimulationApplicationRequest$application": "The application information for the simulation application.
", - "UpdateSimulationApplicationResponse$arn": "The Amazon Resource Name (ARN) of the updated simulation application.
" + "UpdateSimulationApplicationResponse$arn": "The Amazon Resource Name (ARN) of the updated simulation application.
", + "UpdateWorldTemplateRequest$template": "The Amazon Resource Name (arn) of the world template to update.
", + "UpdateWorldTemplateResponse$arn": "The Amazon Resource Name (arn) of the world template.
", + "WorldConfig$world": "The world generated by Simulation WorldForge.
", + "WorldExportJobSummary$arn": "The Amazon Resource Name (ARN) of the world export job.
", + "WorldGenerationJobSummary$arn": "The Amazon Resource Name (ARN) of the world generator job.
", + "WorldGenerationJobSummary$template": "The Amazon Resource Name (arn) of the world template.
", + "WorldSummary$arn": "The Amazon Resource Name (ARN) of the world.
", + "WorldSummary$generationJob": "The Amazon Resource Name (arn) of the world generation job.
", + "WorldSummary$template": "The Amazon Resource Name (arn) of the world template.
" } }, "Arns": { "base": null, "refs": { + "BatchDeleteWorldsRequest$worlds": "A list of Amazon Resource Names (arns) that correspond to worlds to delete.
", + "BatchDeleteWorldsResponse$unprocessedWorlds": "A list of unprocessed worlds associated with the call. These worlds were not deleted.
", "BatchDescribeSimulationJobRequest$jobs": "A list of Amazon Resource Names (ARNs) of simulation jobs to describe.
", - "BatchDescribeSimulationJobResponse$unprocessedJobs": "A list of unprocessed simulation job Amazon Resource Names (ARNs).
" + "BatchDescribeSimulationJobResponse$unprocessedJobs": "A list of unprocessed simulation job Amazon Resource Names (ARNs).
", + "CreateWorldExportJobRequest$worlds": "A list of Amazon Resource Names (arns) that correspond to worlds to export.
", + "DescribeWorldExportJobResponse$worlds": "A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
", + "FinishedWorldsSummary$succeededWorlds": "A list of worlds that succeeded.
", + "WorldExportJobSummary$worlds": "A list of worlds.
" + } + }, + "BatchDeleteWorldsRequest": { + "base": null, + "refs": { + } + }, + "BatchDeleteWorldsResponse": { + "base": null, + "refs": { } }, "BatchDescribeSimulationJobRequest": { @@ -211,14 +275,43 @@ "refs": { } }, + "CancelWorldExportJobRequest": { + "base": null, + "refs": { + } + }, + "CancelWorldExportJobResponse": { + "base": null, + "refs": { + } + }, + "CancelWorldGenerationJobRequest": { + "base": null, + "refs": { + } + }, + "CancelWorldGenerationJobResponse": { + "base": null, + "refs": { + } + }, "ClientRequestToken": { "base": null, "refs": { "CreateDeploymentJobRequest$clientRequestToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "CreateSimulationJobRequest$clientRequestToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "CreateSimulationJobResponse$clientRequestToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateWorldExportJobRequest$clientRequestToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateWorldExportJobResponse$clientRequestToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateWorldGenerationJobRequest$clientRequestToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateWorldGenerationJobResponse$clientRequestToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateWorldTemplateRequest$clientRequestToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateWorldTemplateResponse$clientRequestToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "DescribeSimulationJobBatchResponse$clientRequestToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "DescribeSimulationJobResponse$clientRequestToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "DescribeWorldExportJobResponse$clientRequestToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "DescribeWorldGenerationJobResponse$clientRequestToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "DescribeWorldTemplateResponse$clientRequestToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "SimulationJob$clientRequestToken": "A unique identifier for this SimulationJob request.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "StartSimulationJobBatchResponse$clientRequestToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", @@ -342,12 +435,45 @@ "refs": { } }, + "CreateWorldExportJobRequest": { + "base": null, + "refs": { + } + }, + "CreateWorldExportJobResponse": { + "base": null, + "refs": { + } + }, + "CreateWorldGenerationJobRequest": { + "base": null, + "refs": { + } + }, + "CreateWorldGenerationJobResponse": { + "base": null, + "refs": { + } + }, + "CreateWorldTemplateRequest": { + "base": null, + "refs": { + } + }, + "CreateWorldTemplateResponse": { + "base": null, + "refs": { + } + }, "CreatedAt": { "base": null, "refs": { "CreateDeploymentJobResponse$createdAt": "The time, in milliseconds since the epoch, when the fleet was created.
", "CreateFleetResponse$createdAt": "The time, in milliseconds since the epoch, when the fleet was created.
", "CreateRobotResponse$createdAt": "The time, in milliseconds since the epoch, when the robot was created.
", + "CreateWorldExportJobResponse$createdAt": "The time, in milliseconds since the epoch, when the world export job was created.
", + "CreateWorldGenerationJobResponse$createdAt": "The time, in milliseconds since the epoch, when the world generator job was created.
", + "CreateWorldTemplateResponse$createdAt": "The time, in milliseconds since the epoch, when the world template was created.
", "DeploymentJob$createdAt": "The time, in milliseconds since the epoch, when the deployment job was created.
", "DescribeDeploymentJobResponse$createdAt": "The time, in milliseconds since the epoch, when the deployment job was created.
", "DescribeFleetResponse$createdAt": "The time, in milliseconds since the epoch, when the fleet was created.
", @@ -355,6 +481,10 @@ "DescribeRobotResponse$createdAt": "The time, in milliseconds since the epoch, when the robot was created.
", "DescribeRobotResponse$lastDeploymentTime": "The time of the last deployment job.
", "DescribeSimulationJobBatchResponse$createdAt": "The time, in milliseconds since the epoch, when the simulation job batch was created.
", + "DescribeWorldExportJobResponse$createdAt": "The time, in milliseconds since the epoch, when the world export job was created.
", + "DescribeWorldGenerationJobResponse$createdAt": "The time, in milliseconds since the epoch, when the world generation job was created.
", + "DescribeWorldResponse$createdAt": "The time, in milliseconds since the epoch, when the world was created.
", + "DescribeWorldTemplateResponse$createdAt": "The time, in milliseconds since the epoch, when the world template was created.
", "Fleet$createdAt": "The time, in milliseconds since the epoch, when the fleet was created.
", "Fleet$lastDeploymentTime": "The time of the last deployment.
", "Robot$createdAt": "The time, in milliseconds since the epoch, when the robot was created.
", @@ -363,7 +493,12 @@ "RobotDeployment$deploymentFinishTime": "The time, in milliseconds since the epoch, when the deployment finished.
", "SimulationJobBatchSummary$createdAt": "The time, in milliseconds since the epoch, when the simulation job batch was created.
", "StartSimulationJobBatchResponse$createdAt": "The time, in milliseconds since the epoch, when the simulation job batch was created.
", - "SyncDeploymentJobResponse$createdAt": "The time, in milliseconds since the epoch, when the fleet was created.
" + "SyncDeploymentJobResponse$createdAt": "The time, in milliseconds since the epoch, when the fleet was created.
", + "TemplateSummary$createdAt": "The time, in milliseconds since the epoch, when the template was created.
", + "UpdateWorldTemplateResponse$createdAt": "The time, in milliseconds since the epoch, when the world template was created.
", + "WorldExportJobSummary$createdAt": "The time, in milliseconds since the epoch, when the world export job was created.
", + "WorldGenerationJobSummary$createdAt": "The time, in milliseconds since the epoch, when the world generator job was created.
", + "WorldSummary$createdAt": "The time, in milliseconds since the epoch, when the world was created.
" } }, "DataSource": { @@ -439,6 +574,16 @@ "refs": { } }, + "DeleteWorldTemplateRequest": { + "base": null, + "refs": { + } + }, + "DeleteWorldTemplateResponse": { + "base": null, + "refs": { + } + }, "DeploymentApplicationConfig": { "base": "Information about a deployment application configuration.
", "refs": { @@ -596,6 +741,46 @@ "refs": { } }, + "DescribeWorldExportJobRequest": { + "base": null, + "refs": { + } + }, + "DescribeWorldExportJobResponse": { + "base": null, + "refs": { + } + }, + "DescribeWorldGenerationJobRequest": { + "base": null, + "refs": { + } + }, + "DescribeWorldGenerationJobResponse": { + "base": null, + "refs": { + } + }, + "DescribeWorldRequest": { + "base": null, + "refs": { + } + }, + "DescribeWorldResponse": { + "base": null, + "refs": { + } + }, + "DescribeWorldTemplateRequest": { + "base": null, + "refs": { + } + }, + "DescribeWorldTemplateResponse": { + "base": null, + "refs": { + } + }, "EnvironmentVariableKey": { "base": null, "refs": { @@ -644,6 +829,12 @@ "SimulationJobRequest$failureBehavior": "The failure behavior the simulation job.
Restart the simulation job in the same host instance.
Stop the simulation job and terminate the instance.
Information about worlds that failed.
", + "refs": { + "FinishedWorldsSummary$failureSummary": "Information about worlds that failed.
" + } + }, "Filter": { "base": "Information about a filter.
", "refs": { @@ -665,7 +856,16 @@ "ListRobotsRequest$filters": "Optional filters to limit results.
The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available.
Optional list of filters to limit results.
The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
Optional filters to limit results.
", - "ListSimulationJobsRequest$filters": "Optional filters to limit results.
The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.
Optional filters to limit results.
The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.
Optional filters to limit results. You can use generationJobId and templateId.
Optional filters to limit results. You can use status and templateId.
Optional filters to limit results. You can use status.
Information about worlds that finished.
", + "refs": { + "DescribeWorldGenerationJobResponse$finishedWorldsSummary": "Summary information about finished worlds.
" } }, "Fleet": { @@ -680,6 +880,12 @@ "ListFleetsResponse$fleetDetails": "A list of fleet details meeting the request criteria.
" } }, + "FloorplanCount": { + "base": null, + "refs": { + "WorldCount$floorplanCount": "The number of unique floorplans.
" + } + }, "GenericInteger": { "base": null, "refs": { @@ -694,6 +900,8 @@ "DescribeDeploymentJobResponse$failureReason": "A short description of the reason why the deployment job failed.
", "DescribeSimulationJobBatchResponse$failureReason": "The reason the simulation job batch failed.
", "DescribeSimulationJobResponse$failureReason": "Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting.
", + "DescribeWorldExportJobResponse$failureReason": "The reason why the world export job failed.
", + "DescribeWorldGenerationJobResponse$failureReason": "The reason why the world generation job failed.
", "FailedCreateSimulationJobRequest$failureReason": "The failure reason of the simulation job request.
", "NetworkInterface$networkInterfaceId": "The ID of the network interface.
", "NetworkInterface$privateIpAddress": "The IPv4 address of the network interface within the subnet.
", @@ -703,7 +911,18 @@ "SimulationJob$failureReason": "The reason why the simulation job failed.
", "StartSimulationJobBatchResponse$failureReason": "The reason the simulation job batch failed.
", "SyncDeploymentJobResponse$failureReason": "The failure reason if the job fails.
", - "VPCConfigResponse$vpcId": "The VPC ID associated with your simulation job.
" + "VPCConfigResponse$vpcId": "The VPC ID associated with your simulation job.
", + "WorldFailure$sampleFailureReason": "The sample reason why the world failed. World errors are aggregated. A sample is used as the sampleFailureReason.
The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.
", "CreateSimulationJobResponse$iamRole": "The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.
", + "CreateWorldExportJobRequest$iamRole": "The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
", + "CreateWorldExportJobResponse$iamRole": "The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
", "DescribeSimulationJobResponse$iamRole": "The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.
", + "DescribeWorldExportJobResponse$iamRole": "The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
", "SimulationJob$iamRole": "The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.
", "SimulationJobRequest$iamRole": "The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.
" } @@ -733,9 +955,20 @@ "Integer": { "base": null, "refs": { + "FailureSummary$totalFailureCount": "The total number of failures.
", + "FinishedWorldsSummary$finishedCount": "The total number of finished worlds.
", "SimulationJobBatchSummary$failedRequestCount": "The number of failed simulation job requests.
", "SimulationJobBatchSummary$pendingRequestCount": "The number of pending simulation job requests.
", - "SimulationJobBatchSummary$createdRequestCount": "The number of created simulation job requests.
" + "SimulationJobBatchSummary$createdRequestCount": "The number of created simulation job requests.
", + "WorldFailure$failureCount": "The number of failed worlds.
", + "WorldGenerationJobSummary$succeededWorldCount": "The number of worlds that were generated.
", + "WorldGenerationJobSummary$failedWorldCount": "The number of worlds that failed.
" + } + }, + "InteriorCountPerFloorplan": { + "base": null, + "refs": { + "WorldCount$interiorCountPerFloorplan": "The number of unique interiors per floorplan.
" } }, "InternalServerException": { @@ -758,6 +991,14 @@ "SimulationJobRequest$maxJobDurationInSeconds": "The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
" } }, + "Json": { + "base": null, + "refs": { + "CreateWorldTemplateRequest$templateBody": "The world template body.
", + "GetWorldTemplateBodyResponse$templateBody": "The world template body.
", + "UpdateWorldTemplateRequest$templateBody": "The world template body.
" + } + }, "LastStartedAt": { "base": null, "refs": { @@ -778,13 +1019,16 @@ "DescribeSimulationApplicationResponse$lastUpdatedAt": "The time, in milliseconds since the epoch, when the simulation application was last updated.
", "DescribeSimulationJobBatchResponse$lastUpdatedAt": "The time, in milliseconds since the epoch, when the simulation job batch was last updated.
", "DescribeSimulationJobResponse$lastUpdatedAt": "The time, in milliseconds since the epoch, when the simulation job was last updated.
", + "DescribeWorldTemplateResponse$lastUpdatedAt": "The time, in milliseconds since the epoch, when the world template was last updated.
", "RobotApplicationSummary$lastUpdatedAt": "The time, in milliseconds since the epoch, when the robot application was last updated.
", "SimulationApplicationSummary$lastUpdatedAt": "The time, in milliseconds since the epoch, when the simulation application was last updated.
", "SimulationJob$lastUpdatedAt": "The time, in milliseconds since the epoch, when the simulation job was last updated.
", "SimulationJobBatchSummary$lastUpdatedAt": "The time, in milliseconds since the epoch, when the simulation job batch was last updated.
", "SimulationJobSummary$lastUpdatedAt": "The time, in milliseconds since the epoch, when the simulation job was last updated.
", + "TemplateSummary$lastUpdatedAt": "The time, in milliseconds since the epoch, when the template was last updated.
", "UpdateRobotApplicationResponse$lastUpdatedAt": "The time, in milliseconds since the epoch, when the robot application was last updated.
", - "UpdateSimulationApplicationResponse$lastUpdatedAt": "The time, in milliseconds since the epoch, when the simulation application was last updated.
" + "UpdateSimulationApplicationResponse$lastUpdatedAt": "The time, in milliseconds since the epoch, when the simulation application was last updated.
", + "UpdateWorldTemplateResponse$lastUpdatedAt": "The time, in milliseconds since the epoch, when the world template was last updated.
" } }, "LaunchConfig": { @@ -879,6 +1123,46 @@ "refs": { } }, + "ListWorldExportJobsRequest": { + "base": null, + "refs": { + } + }, + "ListWorldExportJobsResponse": { + "base": null, + "refs": { + } + }, + "ListWorldGenerationJobsRequest": { + "base": null, + "refs": { + } + }, + "ListWorldGenerationJobsResponse": { + "base": null, + "refs": { + } + }, + "ListWorldTemplatesRequest": { + "base": null, + "refs": { + } + }, + "ListWorldTemplatesResponse": { + "base": null, + "refs": { + } + }, + "ListWorldsRequest": { + "base": null, + "refs": { + } + }, + "ListWorldsResponse": { + "base": null, + "refs": { + } + }, "LoggingConfig": { "base": "The logging configuration.
", "refs": { @@ -904,7 +1188,11 @@ "ListRobotsRequest$maxResults": "When this parameter is used, ListRobots only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobots request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListRobots returns up to 200 results and a nextToken value if applicable.
When this parameter is used, ListSimulationApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications returns up to 100 results and a nextToken value if applicable.
When this parameter is used, ListSimulationJobBatches only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationJobBatches request with the returned nextToken value.
When this parameter is used, ListSimulationJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationJobs request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListSimulationJobs returns up to 1000 results and a nextToken value if applicable.
When this parameter is used, ListSimulationJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationJobs request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListSimulationJobs returns up to 1000 results and a nextToken value if applicable.
When this parameter is used, ListWorldExportJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldExportJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldExportJobs returns up to 100 results and a nextToken value if applicable.
When this parameter is used, ListWorldGeneratorJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldGeneratorJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldGeneratorJobs returns up to 100 results and a nextToken value if applicable.
When this parameter is used, ListWorldTemplates only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorldTemplates request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorldTemplates returns up to 100 results and a nextToken value if applicable.
When this parameter is used, ListWorlds only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListWorlds request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds returns up to 100 results and a nextToken value if applicable.
Location for output files generated by the simulation job.
", "CreateSimulationJobResponse$outputLocation": "Simulation job output files location.
", + "CreateWorldExportJobRequest$outputLocation": null, + "CreateWorldExportJobResponse$outputLocation": null, "DescribeSimulationJobResponse$outputLocation": "Location for output files generated by the simulation job.
", + "DescribeWorldExportJobResponse$outputLocation": null, "SimulationJob$outputLocation": "Location for output files generated by the simulation job.
", "SimulationJobRequest$outputLocation": null } @@ -975,20 +1266,28 @@ "PaginationToken": { "base": null, "refs": { - "ListDeploymentJobsRequest$nextToken": "The nextToken value returned from a previous paginated ListDeploymentJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
The nextToken value to include in a future ListDeploymentJobs request. When the results of a ListDeploymentJobs request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The nextToken value returned from a previous paginated ListFleets request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken value to include in a future ListDeploymentJobs request. When the results of a ListFleets request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The nextToken value returned from a previous paginated ListRobotApplications request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
The nextToken value to include in a future ListRobotApplications request. When the results of a ListRobotApplications request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The nextToken value returned from a previous paginated ListRobots request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
The nextToken value to include in a future ListRobots request. When the results of a ListRobot request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The nextToken value returned from a previous paginated ListSimulationApplications request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
The nextToken value to include in a future ListSimulationApplications request. When the results of a ListRobot request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The nextToken value returned from a previous paginated ListSimulationJobBatches request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
The nextToken value to include in a future ListSimulationJobBatches request. When the results of a ListSimulationJobBatches request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The nextToken value returned from a previous paginated ListSimulationJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken value to include in a future ListSimulationJobs request. When the results of a ListRobot request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListDeploymentJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListDeploymentJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListFleets again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListFleets again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobotApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobotApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobots again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobots again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobBatches again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobBatches again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldExportJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldExportJobsRequest again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldGenerationJobsRequest again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldGeneratorJobsRequest again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldTemplates again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldTemplates again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
The S3 bucket for output.
", "S3Object$bucket": "The bucket containing the object.
", "Source$s3Bucket": "The s3 bucket name.
", - "SourceConfig$s3Bucket": "The Amazon S3 bucket name.
" + "SourceConfig$s3Bucket": "The Amazon S3 bucket name.
", + "TemplateLocation$s3Bucket": "The Amazon S3 bucket name.
" } }, "S3Etag": { @@ -1242,7 +1542,8 @@ "S3Keys$member": null, "S3Object$key": "The key of the object.
", "Source$s3Key": "The s3 object key.
", - "SourceConfig$s3Key": "The s3 object key.
" + "SourceConfig$s3Key": "The s3 object key.
", + "TemplateLocation$s3Key": "The list of S3 keys identifying the data source files.
" } }, "S3KeyOutput": { @@ -1428,8 +1729,8 @@ "SimulationUnit": { "base": null, "refs": { - "Compute$simulationUnitLimit": "The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximim value provided.
", - "ComputeResponse$simulationUnitLimit": "The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximim value provided.
" + "Compute$simulationUnitLimit": "The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximim value provided. The default is 15.
", + "ComputeResponse$simulationUnitLimit": "The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximim value provided. The default is 15.
" } }, "Source": { @@ -1521,6 +1822,12 @@ "CreateSimulationApplicationResponse$tags": "The list of all tags added to the simulation application.
", "CreateSimulationJobRequest$tags": "A map that contains tag keys and tag values that are attached to the simulation job.
", "CreateSimulationJobResponse$tags": "The list of all tags added to the simulation job.
", + "CreateWorldExportJobRequest$tags": "A map that contains tag keys and tag values that are attached to the world export job.
", + "CreateWorldExportJobResponse$tags": "A map that contains tag keys and tag values that are attached to the world export job.
", + "CreateWorldGenerationJobRequest$tags": "A map that contains tag keys and tag values that are attached to the world generator job.
", + "CreateWorldGenerationJobResponse$tags": "A map that contains tag keys and tag values that are attached to the world generator job.
", + "CreateWorldTemplateRequest$tags": "A map that contains tag keys and tag values that are attached to the world template.
", + "CreateWorldTemplateResponse$tags": "A map that contains tag keys and tag values that are attached to the world template.
", "DescribeDeploymentJobResponse$tags": "The list of all tags added to the specified deployment job.
", "DescribeFleetResponse$tags": "The list of all tags added to the specified fleet.
", "DescribeRobotApplicationResponse$tags": "The list of all tags added to the specified robot application.
", @@ -1528,6 +1835,10 @@ "DescribeSimulationApplicationResponse$tags": "The list of all tags added to the specified simulation application.
", "DescribeSimulationJobBatchResponse$tags": "A map that contains tag keys and tag values that are attached to the simulation job batch.
", "DescribeSimulationJobResponse$tags": "The list of all tags added to the specified simulation job.
", + "DescribeWorldExportJobResponse$tags": "A map that contains tag keys and tag values that are attached to the world export job.
", + "DescribeWorldGenerationJobResponse$tags": "A map that contains tag keys and tag values that are attached to the world generation job.
", + "DescribeWorldResponse$tags": "A map that contains tag keys and tag values that are attached to the world.
", + "DescribeWorldTemplateResponse$tags": "A map that contains tag keys and tag values that are attached to the world template.
", "ListTagsForResourceResponse$tags": "The list of all tags added to the specified resource.
", "SimulationJob$tags": "A map that contains tag keys and tag values that are attached to the simulation job.
", "SimulationJobRequest$tags": "A map that contains tag keys and tag values that are attached to the simulation job request.
", @@ -1552,6 +1863,36 @@ "TagMap$value": null } }, + "TemplateLocation": { + "base": "Information about a template location.
", + "refs": { + "CreateWorldTemplateRequest$templateLocation": "The location of the world template.
", + "UpdateWorldTemplateRequest$templateLocation": "The location of the world template.
" + } + }, + "TemplateName": { + "base": null, + "refs": { + "CreateWorldTemplateRequest$name": "The name of the world template.
", + "CreateWorldTemplateResponse$name": "The name of the world template.
", + "DescribeWorldTemplateResponse$name": "The name of the world template.
", + "TemplateSummary$name": "The name of the template.
", + "UpdateWorldTemplateRequest$name": "The name of the template.
", + "UpdateWorldTemplateResponse$name": "The name of the world template.
" + } + }, + "TemplateSummaries": { + "base": null, + "refs": { + "ListWorldTemplatesResponse$templateSummaries": "Summary information for templates.
" + } + }, + "TemplateSummary": { + "base": "Summary information for a template.
", + "refs": { + "TemplateSummaries$member": null + } + }, "ThrottlingException": { "base": "AWS RoboMaker is temporarily unable to process the request. Try your call again.
", "refs": { @@ -1587,6 +1928,16 @@ "refs": { } }, + "UpdateWorldTemplateRequest": { + "base": null, + "refs": { + } + }, + "UpdateWorldTemplateResponse": { + "base": null, + "refs": { + } + }, "VPCConfig": { "base": "If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and two subnet IDs.
", "refs": { @@ -1630,6 +1981,106 @@ "ListSimulationApplicationsRequest$versionQualifier": "The version qualifier of the simulation application.
" } }, + "WorldConfig": { + "base": "Configuration information for a world.
", + "refs": { + "WorldConfigs$member": null + } + }, + "WorldConfigs": { + "base": null, + "refs": { + "SimulationApplicationConfig$worldConfigs": "A list of world configurations.
" + } + }, + "WorldCount": { + "base": "The number of worlds that will be created. You can configure the number of unique floorplans and the number of unique interiors for each floor plan. For example, if you want 1 world with 20 unique interiors, you set floorplanCount = 1 and interiorCountPerFloorplan = 20. This will result in 20 worlds (floorplanCount * interiorCountPerFloorplan).
If you set floorplanCount = 4 and interiorCountPerFloorplan = 5, there will be 20 worlds with 5 unique floor plans.
Information about the world count.
", + "CreateWorldGenerationJobResponse$worldCount": "Information about the world count.
", + "DescribeWorldGenerationJobResponse$worldCount": "Information about the world count.
", + "WorldGenerationJobSummary$worldCount": "Information about the world count.
" + } + }, + "WorldExportJobErrorCode": { + "base": null, + "refs": { + "CreateWorldExportJobResponse$failureCode": "The failure code of the world export job if it failed:
Internal service error.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
The specified resource could not be found.
The request was throttled.
An input parameter in the request is not valid.
The failure code of the world export job if it failed:
Internal service error.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
The specified resource could not be found.
The request was throttled.
An input parameter in the request is not valid.
The status of the world export job.
The world export job request is pending.
The world export job is running.
The world export job completed.
The world export job failed. See failureCode for more information.
The world export job was cancelled.
The world export job is being cancelled.
The status of the world export job.
The world export job request is pending.
The world export job is running.
The world export job completed.
The world export job failed. See failureCode and failureReason for more information.
The world export job was cancelled.
The world export job is being cancelled.
The status of the world export job.
The world export job request is pending.
The world export job is running.
The world export job completed.
The world export job failed. See failureCode for more information.
The world export job was cancelled.
The world export job is being cancelled.
Summary information for world export jobs.
" + } + }, + "WorldExportJobSummary": { + "base": "Information about a world export job.
", + "refs": { + "WorldExportJobSummaries$member": null + } + }, + "WorldFailure": { + "base": "Information about a failed world.
", + "refs": { + "WorldFailures$member": null + } + }, + "WorldFailures": { + "base": null, + "refs": { + "FailureSummary$failures": "The worlds that failed.
" + } + }, + "WorldGenerationJobErrorCode": { + "base": null, + "refs": { + "CreateWorldGenerationJobResponse$failureCode": "The failure code of the world generator job if it failed:
Internal service error.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
The specified resource could not be found.
The request was throttled.
An input parameter in the request is not valid.
The failure code of the world generation job if it failed:
Internal service error.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
The specified resource could not be found.
The request was throttled.
An input parameter in the request is not valid.
The failure code of the world export job if it failed:
Internal service error.
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
The specified resource could not be found.
The request was throttled.
An input parameter in the request is not valid.
The status of the world generator job.
The world generator job request is pending.
The world generator job is running.
The world generator job completed.
The world generator job failed. See failureCode for more information.
Some worlds did not generate.
The world generator job was cancelled.
The world generator job is being cancelled.
The status of the world generation job:
The world generation job request is pending.
The world generation job is running.
The world generation job completed.
The world generation job failed. See failureCode for more information.
Some worlds did not generate.
The world generation job was cancelled.
The world generation job is being cancelled.
The status of the world generator job:
The world generator job request is pending.
The world generator job is running.
The world generator job completed.
The world generator job failed. See failureCode for more information.
Some worlds did not generate.
The world generator job was cancelled.
The world generator job is being cancelled.
Summary information for world generator jobs.
" + } + }, + "WorldGenerationJobSummary": { + "base": "Information about a world generator job.
", + "refs": { + "WorldGenerationJobSummaries$member": null + } + }, + "WorldSummaries": { + "base": null, + "refs": { + "ListWorldsResponse$worldSummaries": "Summary information for worlds.
" + } + }, + "WorldSummary": { + "base": "Information about a world.
", + "refs": { + "WorldSummaries$member": null + } + }, "errorMessage": { "base": null, "refs": { diff --git a/models/apis/robomaker/2018-06-29/paginators-1.json b/models/apis/robomaker/2018-06-29/paginators-1.json index 164e150194..b06e3ea1c5 100644 --- a/models/apis/robomaker/2018-06-29/paginators-1.json +++ b/models/apis/robomaker/2018-06-29/paginators-1.json @@ -41,6 +41,30 @@ "output_token": "nextToken", "limit_key": "maxResults", "result_key": "simulationJobSummaries" + }, + "ListWorldExportJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "worldExportJobSummaries" + }, + "ListWorldGenerationJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "worldGenerationJobSummaries" + }, + "ListWorldTemplates": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "templateSummaries" + }, + "ListWorlds": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "worldSummaries" } } } diff --git a/service/acm/api.go b/service/acm/api.go index 51c26a35f1..621308de68 100644 --- a/service/acm/api.go +++ b/service/acm/api.go @@ -4313,6 +4313,9 @@ const ( // FailureReasonPcaAccessDenied is a FailureReason enum value FailureReasonPcaAccessDenied = "PCA_ACCESS_DENIED" + // FailureReasonSlrNotFound is a FailureReason enum value + FailureReasonSlrNotFound = "SLR_NOT_FOUND" + // FailureReasonOther is a FailureReason enum value FailureReasonOther = "OTHER" ) @@ -4335,6 +4338,7 @@ func FailureReason_Values() []string { FailureReasonPcaInvalidArgs, FailureReasonPcaInvalidDuration, FailureReasonPcaAccessDenied, + FailureReasonSlrNotFound, FailureReasonOther, } } diff --git a/service/acmpca/acmpcaiface/interface.go b/service/acmpca/acmpcaiface/interface.go index 8cc920f2ce..e9898c3b39 100644 --- a/service/acmpca/acmpcaiface/interface.go +++ b/service/acmpca/acmpcaiface/interface.go @@ -80,6 +80,10 @@ type ACMPCAAPI interface { DeletePermissionWithContext(aws.Context, *acmpca.DeletePermissionInput, ...request.Option) (*acmpca.DeletePermissionOutput, error) DeletePermissionRequest(*acmpca.DeletePermissionInput) (*request.Request, *acmpca.DeletePermissionOutput) + DeletePolicy(*acmpca.DeletePolicyInput) (*acmpca.DeletePolicyOutput, error) + DeletePolicyWithContext(aws.Context, *acmpca.DeletePolicyInput, ...request.Option) (*acmpca.DeletePolicyOutput, error) + DeletePolicyRequest(*acmpca.DeletePolicyInput) (*request.Request, *acmpca.DeletePolicyOutput) + DescribeCertificateAuthority(*acmpca.DescribeCertificateAuthorityInput) (*acmpca.DescribeCertificateAuthorityOutput, error) DescribeCertificateAuthorityWithContext(aws.Context, *acmpca.DescribeCertificateAuthorityInput, ...request.Option) (*acmpca.DescribeCertificateAuthorityOutput, error) DescribeCertificateAuthorityRequest(*acmpca.DescribeCertificateAuthorityInput) (*request.Request, *acmpca.DescribeCertificateAuthorityOutput) @@ -100,6 +104,10 @@ type ACMPCAAPI interface { GetCertificateAuthorityCsrWithContext(aws.Context, *acmpca.GetCertificateAuthorityCsrInput, ...request.Option) (*acmpca.GetCertificateAuthorityCsrOutput, error) GetCertificateAuthorityCsrRequest(*acmpca.GetCertificateAuthorityCsrInput) (*request.Request, *acmpca.GetCertificateAuthorityCsrOutput) + GetPolicy(*acmpca.GetPolicyInput) (*acmpca.GetPolicyOutput, error) + GetPolicyWithContext(aws.Context, *acmpca.GetPolicyInput, ...request.Option) (*acmpca.GetPolicyOutput, error) + GetPolicyRequest(*acmpca.GetPolicyInput) (*request.Request, *acmpca.GetPolicyOutput) + ImportCertificateAuthorityCertificate(*acmpca.ImportCertificateAuthorityCertificateInput) (*acmpca.ImportCertificateAuthorityCertificateOutput, error) ImportCertificateAuthorityCertificateWithContext(aws.Context, *acmpca.ImportCertificateAuthorityCertificateInput, ...request.Option) (*acmpca.ImportCertificateAuthorityCertificateOutput, error) ImportCertificateAuthorityCertificateRequest(*acmpca.ImportCertificateAuthorityCertificateInput) (*request.Request, *acmpca.ImportCertificateAuthorityCertificateOutput) @@ -129,6 +137,10 @@ type ACMPCAAPI interface { ListTagsPages(*acmpca.ListTagsInput, func(*acmpca.ListTagsOutput, bool) bool) error ListTagsPagesWithContext(aws.Context, *acmpca.ListTagsInput, func(*acmpca.ListTagsOutput, bool) bool, ...request.Option) error + PutPolicy(*acmpca.PutPolicyInput) (*acmpca.PutPolicyOutput, error) + PutPolicyWithContext(aws.Context, *acmpca.PutPolicyInput, ...request.Option) (*acmpca.PutPolicyOutput, error) + PutPolicyRequest(*acmpca.PutPolicyInput) (*request.Request, *acmpca.PutPolicyOutput) + RestoreCertificateAuthority(*acmpca.RestoreCertificateAuthorityInput) (*acmpca.RestoreCertificateAuthorityOutput, error) RestoreCertificateAuthorityWithContext(aws.Context, *acmpca.RestoreCertificateAuthorityInput, ...request.Option) (*acmpca.RestoreCertificateAuthorityOutput, error) RestoreCertificateAuthorityRequest(*acmpca.RestoreCertificateAuthorityInput) (*request.Request, *acmpca.RestoreCertificateAuthorityOutput) diff --git a/service/acmpca/api.go b/service/acmpca/api.go index dc6eabe52f..2f07f7f1e3 100644 --- a/service/acmpca/api.go +++ b/service/acmpca/api.go @@ -68,6 +68,14 @@ 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 +// 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 +// 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 (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html). +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -80,16 +88,17 @@ func (c *ACMPCA) CreateCertificateAuthorityRequest(input *CreateCertificateAutho // One or more of the specified arguments was not valid. // // * InvalidPolicyException -// The S3 bucket policy is not valid. The policy must give ACM Private CA rights -// to read from and write to the bucket and find the bucket location. +// The resource policy is invalid or is missing a required statement. For general +// information about IAM policy and statement structure, see Overview of JSON +// Policies (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json). // // * InvalidTagException // The tag associated with the CA is not valid. The invalid argument is contained // in the message field. // // * LimitExceededException -// An ACM Private CA limit has been exceeded. See the exception message returned -// to determine the limit that was exceeded. +// An ACM Private CA quota has been exceeded. See the exception message returned +// to determine the quota that was exceeded. // // See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthority func (c *ACMPCA) CreateCertificateAuthority(input *CreateCertificateAuthorityInput) (*CreateCertificateAuthorityOutput, error) { @@ -159,7 +168,17 @@ func (c *ACMPCA) CreateCertificateAuthorityAuditReportRequest(input *CreateCerti // // 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. +// The IssueCertificate (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html) +// and RevokeCertificate (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html) +// 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 (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 +// 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 // with awserr.Error's Code and Message methods to get detailed information about @@ -176,8 +195,8 @@ func (c *ACMPCA) CreateCertificateAuthorityAuditReportRequest(input *CreateCerti // The request has failed for an unspecified reason. // // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidArnException // The requested Amazon Resource Name (ARN) does not refer to an existing resource. @@ -186,8 +205,7 @@ func (c *ACMPCA) CreateCertificateAuthorityAuditReportRequest(input *CreateCerti // One or more of the specified arguments was not valid. // // * InvalidStateException -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. // // See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityAuditReport func (c *ACMPCA) CreateCertificateAuthorityAuditReport(input *CreateCertificateAuthorityAuditReportInput) (*CreateCertificateAuthorityAuditReportOutput, error) { @@ -256,16 +274,29 @@ func (c *ACMPCA) CreatePermissionRequest(input *CreatePermissionInput) (req *req // CreatePermission API operation for AWS Certificate Manager Private Certificate Authority. // -// Assigns permissions from a private CA to a designated AWS service. Services -// are specified by their service principals and can be given permission to -// create and retrieve certificates on a private CA. Services can also be given -// permission to list the active permissions that the private CA has granted. -// For ACM to automatically renew your private CA's certificates, you must assign -// all possible permissions from the CA to the ACM service principal. +// 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 (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html) +// action and revoke them with the DeletePermission (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePermission.html) +// 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. // -// At this time, you can only assign permissions to ACM (acm.amazonaws.com). -// Permissions can be revoked with the DeletePermission action and listed with -// the ListPermissions action. +// * 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 (acm-pca/latest/userguide/pca-rbp.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -276,8 +307,8 @@ func (c *ACMPCA) CreatePermissionRequest(input *CreatePermissionInput) (req *req // // Returned Error Types: // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidArnException // The requested Amazon Resource Name (ARN) does not refer to an existing resource. @@ -286,12 +317,11 @@ func (c *ACMPCA) CreatePermissionRequest(input *CreatePermissionInput) (req *req // The designated permission has already been given to the user. // // * LimitExceededException -// An ACM Private CA limit has been exceeded. See the exception message returned -// to determine the limit that was exceeded. +// An ACM Private CA quota has been exceeded. See the exception message returned +// to determine the quota that was exceeded. // // * InvalidStateException -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. // // * RequestFailedException // The request has failed for an unspecified reason. @@ -365,27 +395,31 @@ func (c *ACMPCA) DeleteCertificateAuthorityRequest(input *DeleteCertificateAutho // // 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. +// the ARN by calling the ListCertificateAuthorities (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html) +// 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. +// disable it. To do this, call the UpdateCertificateAuthority (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html) +// 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. +// When you successfully call DeleteCertificateAuthority (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeleteCertificateAuthority.html), +// 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 +// (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DescribeCertificateAuthority.html) +// 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 +// (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RestoreCertificateAuthority.html) +// action. // // 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 @@ -399,15 +433,14 @@ func (c *ACMPCA) DeleteCertificateAuthorityRequest(input *DeleteCertificateAutho // A previous update to your private CA is still ongoing. // // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidArnException // The requested Amazon Resource Name (ARN) does not refer to an existing resource. // // * InvalidStateException -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. // // See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority func (c *ACMPCA) DeleteCertificateAuthority(input *DeleteCertificateAuthorityInput) (*DeleteCertificateAuthorityOutput, error) { @@ -476,9 +509,31 @@ func (c *ACMPCA) DeletePermissionRequest(input *DeletePermissionInput) (req *req // DeletePermission API operation for AWS Certificate Manager Private Certificate Authority. // -// Revokes permissions that a private CA assigned to a designated AWS service. -// Permissions can be created with the CreatePermission action and listed with -// the ListPermissions 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 (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreatePermission.html) +// action and listed with the ListPermissions (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html) +// 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 (acm-pca/latest/userguide/pca-rbp.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -489,15 +544,14 @@ func (c *ACMPCA) DeletePermissionRequest(input *DeletePermissionInput) (req *req // // Returned Error Types: // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidArnException // The requested Amazon Resource Name (ARN) does not refer to an existing resource. // // * InvalidStateException -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. // // * RequestFailedException // The request has failed for an unspecified reason. @@ -524,6 +578,135 @@ func (c *ACMPCA) DeletePermissionWithContext(ctx aws.Context, input *DeletePermi return out, req.Send() } +const opDeletePolicy = "DeletePolicy" + +// DeletePolicyRequest generates a "aws/request.Request" representing the +// client's request for the DeletePolicy 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 DeletePolicy for more information on using the DeletePolicy +// 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 DeletePolicyRequest method. +// req, resp := client.DeletePolicyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePolicy +func (c *ACMPCA) DeletePolicyRequest(input *DeletePolicyInput) (req *request.Request, output *DeletePolicyOutput) { + op := &request.Operation{ + Name: opDeletePolicy, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeletePolicyInput{} + } + + output = &DeletePolicyOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeletePolicy API operation for AWS Certificate Manager Private Certificate Authority. +// +// Deletes the resource-based policy attached to a private CA. Deletion will +// remove any access that the policy has granted. If there is no policy attached +// to the private CA, this action will return successful. +// +// If you delete a policy that was applied through AWS Resource Access Manager +// (RAM), the CA will be removed from all shares in which it was included. +// +// The AWS Certificate Manager Service Linked Role that the policy supports +// is not affected when you delete the policy. +// +// The current policy can be shown with GetPolicy (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetPolicy.html) +// and updated with PutPolicy (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_PutPolicy.html). +// +// About Policies +// +// * A policy grants access on a private CA to an AWS customer account, to +// AWS Organizations, or to an AWS Organizations unit. Policies are under +// the control of a CA administrator. For more information, see Using a Resource +// Based Policy with ACM Private CA (acm-pca/latest/userguide/pca-rbp.html). +// +// * A policy permits a user of AWS Certificate Manager (ACM) to issue ACM +// certificates signed by a CA in another account. +// +// * For ACM to manage automatic renewal of these certificates, the ACM user +// must configure a Service Linked Role (SLR). The SLR allows the ACM service +// to assume the identity of the user, subject to confirmation against the +// ACM Private CA policy. For more information, see Using a Service Linked +// Role with ACM (https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html). +// +// * Updates made in AWS Resource Manager (RAM) are reflected in policies. +// For more information, see Using AWS Resource Access Manager (RAM) with +// ACM Private CA (acm-pca/latest/userguide/pca-ram.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's +// API operation DeletePolicy for usage and error information. +// +// Returned Error Types: +// * ConcurrentModificationException +// A previous update to your private CA is still ongoing. +// +// * InvalidArnException +// The requested Amazon Resource Name (ARN) does not refer to an existing resource. +// +// * InvalidStateException +// The state of the private CA does not allow this action to occur. +// +// * LockoutPreventedException +// The current action was prevented because it would lock the caller out from +// performing subsequent actions. Verify that the specified parameters would +// not result in the caller being denied access to the resource. +// +// * RequestFailedException +// The request has failed for an unspecified reason. +// +// * ResourceNotFoundException +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePolicy +func (c *ACMPCA) DeletePolicy(input *DeletePolicyInput) (*DeletePolicyOutput, error) { + req, out := c.DeletePolicyRequest(input) + return out, req.Send() +} + +// DeletePolicyWithContext is the same as DeletePolicy with the addition of +// the ability to pass a context and additional request options. +// +// See DeletePolicy 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 *ACMPCA) DeletePolicyWithContext(ctx aws.Context, input *DeletePolicyInput, opts ...request.Option) (*DeletePolicyOutput, error) { + req, out := c.DeletePolicyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeCertificateAuthority = "DescribeCertificateAuthority" // DescribeCertificateAuthorityRequest generates a "aws/request.Request" representing the @@ -568,9 +751,10 @@ func (c *ACMPCA) DescribeCertificateAuthorityRequest(input *DescribeCertificateA // DescribeCertificateAuthority API operation for AWS Certificate Manager Private Certificate Authority. // -// Lists information about your private certificate authority (CA). You specify -// the private CA on input by its ARN (Amazon Resource Name). The output contains -// the status of your CA. This can be any of the following: +// Lists information about your private certificate authority (CA) or one that +// has been shared with you. You specify the private CA on input by its ARN +// (Amazon Resource Name). The output contains the status of your CA. This can +// be any of the following: // // * CREATING - ACM Private CA is creating your private certificate authority. // @@ -601,8 +785,8 @@ func (c *ACMPCA) DescribeCertificateAuthorityRequest(input *DescribeCertificateA // // Returned Error Types: // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidArnException // The requested Amazon Resource Name (ARN) does not refer to an existing resource. @@ -674,9 +858,12 @@ func (c *ACMPCA) DescribeCertificateAuthorityAuditReportRequest(input *DescribeC // DescribeCertificateAuthorityAuditReport API operation for AWS Certificate Manager Private Certificate Authority. // // Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport +// (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html) // action. Audit information is created every time the certificate authority // (CA) private key is used. The private key is used when you call the IssueCertificate -// action or the RevokeCertificate action. +// (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html) +// action or the RevokeCertificate (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html) +// action. // // 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 @@ -687,8 +874,8 @@ func (c *ACMPCA) DescribeCertificateAuthorityAuditReportRequest(input *DescribeC // // Returned Error Types: // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidArnException // The requested Amazon Resource Name (ARN) does not refer to an existing resource. @@ -762,12 +949,14 @@ func (c *ACMPCA) GetCertificateRequest(input *GetCertificateInput) (req *request // GetCertificate API operation for AWS Certificate Manager Private Certificate Authority. // -// Retrieves a certificate from your private CA. The ARN of the certificate -// is returned when you call the IssueCertificate action. You must specify both -// the ARN of your private CA and the ARN of the issued certificate when calling -// the GetCertificate action. You can retrieve the certificate if it is in the -// ISSUED state. You can call the CreateCertificateAuthorityAuditReport action -// to create a report that contains information about all of the certificates +// Retrieves a certificate from your private CA or one that has been shared +// with you. The ARN of the certificate is returned when you call the IssueCertificate +// (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html) +// action. You must specify both the ARN of your private CA and the ARN of the +// issued certificate when calling the GetCertificate action. You can retrieve +// the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport +// (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html) +// action to create a report that contains information about all of the certificates // issued and revoked by your private CA. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -785,15 +974,14 @@ func (c *ACMPCA) GetCertificateRequest(input *GetCertificateInput) (req *request // The request has failed for an unspecified reason. // // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidArnException // The requested Amazon Resource Name (ARN) does not refer to an existing resource. // // * InvalidStateException -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. // // See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate func (c *ACMPCA) GetCertificate(input *GetCertificateInput) (*GetCertificateOutput, error) { @@ -862,9 +1050,9 @@ func (c *ACMPCA) GetCertificateAuthorityCertificateRequest(input *GetCertificate // GetCertificateAuthorityCertificate API operation for AWS Certificate Manager Private Certificate Authority. // // Retrieves the certificate and certificate chain for your private certificate -// authority (CA). Both the certificate and the chain are base64 PEM-encoded. -// The chain does not include the CA certificate. Each certificate in the chain -// signs the one before it. +// authority (CA) or one that has been shared with you. Both the certificate +// and the chain are base64 PEM-encoded. The chain does not include the CA certificate. +// Each certificate in the chain signs the one before it. // // 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 @@ -875,12 +1063,11 @@ func (c *ACMPCA) GetCertificateAuthorityCertificateRequest(input *GetCertificate // // Returned Error Types: // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidStateException -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. // // * InvalidArnException // The requested Amazon Resource Name (ARN) does not refer to an existing resource. @@ -953,10 +1140,11 @@ func (c *ACMPCA) GetCertificateAuthorityCsrRequest(input *GetCertificateAuthorit // // Retrieves the certificate signing request (CSR) for your private certificate // authority (CA). The CSR is created when you call the CreateCertificateAuthority +// (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html) // action. Sign the CSR with your ACM Private CA-hosted or on-premises root // or subordinate CA. Then import the signed certificate back into ACM Private -// CA by calling the ImportCertificateAuthorityCertificate action. The CSR is -// returned as a base64 PEM-encoded string. +// CA by calling the ImportCertificateAuthorityCertificate (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html) +// action. The CSR is returned as a base64 PEM-encoded string. // // 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 @@ -973,15 +1161,14 @@ func (c *ACMPCA) GetCertificateAuthorityCsrRequest(input *GetCertificateAuthorit // The request has failed for an unspecified reason. // // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidArnException // The requested Amazon Resource Name (ARN) does not refer to an existing resource. // // * InvalidStateException -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. // // See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr func (c *ACMPCA) GetCertificateAuthorityCsr(input *GetCertificateAuthorityCsrInput) (*GetCertificateAuthorityCsrOutput, error) { @@ -1005,6 +1192,120 @@ func (c *ACMPCA) GetCertificateAuthorityCsrWithContext(ctx aws.Context, input *G return out, req.Send() } +const opGetPolicy = "GetPolicy" + +// GetPolicyRequest generates a "aws/request.Request" representing the +// client's request for the GetPolicy 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 GetPolicy for more information on using the GetPolicy +// 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 GetPolicyRequest method. +// req, resp := client.GetPolicyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetPolicy +func (c *ACMPCA) GetPolicyRequest(input *GetPolicyInput) (req *request.Request, output *GetPolicyOutput) { + op := &request.Operation{ + Name: opGetPolicy, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &GetPolicyInput{} + } + + output = &GetPolicyOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetPolicy API operation for AWS Certificate Manager Private Certificate Authority. +// +// Retrieves the resource-based policy attached to a private CA. If either the +// private CA resource or the policy cannot be found, this action returns a +// ResourceNotFoundException. +// +// The policy can be attached or updated with PutPolicy (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_PutPolicy.html) +// and removed with DeletePolicy (acm-pca/latest/APIReference/API_DeletePolicy.html). +// +// About Policies +// +// * A policy grants access on a private CA to an AWS customer account, to +// AWS Organizations, or to an AWS Organizations unit. Policies are under +// the control of a CA administrator. For more information, see Using a Resource +// Based Policy with ACM Private CA (acm-pca/latest/userguide/pca-rbp.html). +// +// * A policy permits a user of AWS Certificate Manager (ACM) to issue ACM +// certificates signed by a CA in another account. +// +// * For ACM to manage automatic renewal of these certificates, the ACM user +// must configure a Service Linked Role (SLR). The SLR allows the ACM service +// to assume the identity of the user, subject to confirmation against the +// ACM Private CA policy. For more information, see Using a Service Linked +// Role with ACM (https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html). +// +// * Updates made in AWS Resource Manager (RAM) are reflected in policies. +// For more information, see Using AWS Resource Access Manager (RAM) with +// ACM Private CA (acm-pca/latest/userguide/pca-ram.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's +// API operation GetPolicy for usage and error information. +// +// Returned Error Types: +// * InvalidArnException +// The requested Amazon Resource Name (ARN) does not refer to an existing resource. +// +// * InvalidStateException +// The state of the private CA does not allow this action to occur. +// +// * RequestFailedException +// The request has failed for an unspecified reason. +// +// * ResourceNotFoundException +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetPolicy +func (c *ACMPCA) GetPolicy(input *GetPolicyInput) (*GetPolicyOutput, error) { + req, out := c.GetPolicyRequest(input) + return out, req.Send() +} + +// GetPolicyWithContext is the same as GetPolicy with the addition of +// the ability to pass a context and additional request options. +// +// See GetPolicy 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 *ACMPCA) GetPolicyWithContext(ctx aws.Context, input *GetPolicyInput, opts ...request.Option) (*GetPolicyOutput, error) { + req, out := c.GetPolicyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opImportCertificateAuthorityCertificate = "ImportCertificateAuthorityCertificate" // ImportCertificateAuthorityCertificateRequest generates a "aws/request.Request" representing the @@ -1055,14 +1356,15 @@ func (c *ACMPCA) ImportCertificateAuthorityCertificateRequest(input *ImportCerti // ACM Private CA. Before you can call this action, the following preparations // must in place: // -// In ACM Private CA, call the CreateCertificateAuthority action to create the -// private CA that that you plan to back with the imported certificate. +// In ACM Private CA, call the CreateCertificateAuthority (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html) +// action to create the private CA that that you plan to back with the imported +// certificate. // -// Call the GetCertificateAuthorityCsr action to generate a certificate signing -// request (CSR). +// Call the GetCertificateAuthorityCsr (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetCertificateAuthorityCsr.html) +// action to generate a certificate signing request (CSR). // -// Sign the CSR using a root or intermediate CA hosted either by an on-premises -// PKI hierarchy or a commercial CA.. +// Sign the CSR using a root or intermediate CA hosted by either an on-premises +// PKI hierarchy or by a commercial CA. // // Create a certificate chain and copy the signed certificate and the certificate // chain to your working directory. @@ -1085,6 +1387,54 @@ func (c *ACMPCA) ImportCertificateAuthorityCertificateRequest(input *ImportCerti // // * The chain must be PEM-encoded. // +// * The maximum allowed size of a certificate is 32 KB. +// +// * The maximum allowed size of a certificate chain is 2 MB. +// +// Enforcement of Critical Constraints +// +// ACM Private CA allows the following extensions to be marked critical in the +// imported CA certificate or chain. +// +// * Basic constraints (must be marked critical) +// +// * Subject alternative names +// +// * Key usage +// +// * Extended key usage +// +// * Authority key identifier +// +// * Subject key identifier +// +// * Issuer alternative name +// +// * Subject directory attributes +// +// * Subject information access +// +// * Certificate policies +// +// * Policy mappings +// +// * Inhibit anyPolicy +// +// ACM Private CA rejects the following extensions when they are marked critical +// in an imported CA certificate or chain. +// +// * Name constraints +// +// * Policy constraints +// +// * CRL distribution points +// +// * Authority information access +// +// * Freshest CRL +// +// * Any other extension +// // 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. @@ -1103,8 +1453,8 @@ func (c *ACMPCA) ImportCertificateAuthorityCertificateRequest(input *ImportCerti // The request has failed for an unspecified reason. // // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidArnException // The requested Amazon Resource Name (ARN) does not refer to an existing resource. @@ -1113,8 +1463,7 @@ func (c *ACMPCA) ImportCertificateAuthorityCertificateRequest(input *ImportCerti // The request action cannot be performed or is prohibited. // // * InvalidStateException -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. // // * MalformedCertificateException // One or more fields in the certificate are invalid. @@ -1189,10 +1538,11 @@ func (c *ACMPCA) IssueCertificateRequest(input *IssueCertificateInput) (req *req // IssueCertificate API operation for AWS Certificate Manager Private Certificate Authority. // -// Uses your private certificate authority (CA) to issue a client certificate. -// This action returns the Amazon Resource Name (ARN) of the certificate. You -// can retrieve the certificate by calling the GetCertificate action and specifying -// the ARN. +// Uses your private certificate authority (CA), or one that has been shared +// with you, to issue a client certificate. This action returns the Amazon Resource +// Name (ARN) of the certificate. You can retrieve the certificate by calling +// the GetCertificate (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetCertificate.html) +// action and specifying the ARN. // // You cannot use the ACM ListCertificateAuthorities action to retrieve the // ARNs of the certificates that you issue by using ACM Private CA. @@ -1206,16 +1556,15 @@ func (c *ACMPCA) IssueCertificateRequest(input *IssueCertificateInput) (req *req // // Returned Error Types: // * LimitExceededException -// An ACM Private CA limit has been exceeded. See the exception message returned -// to determine the limit that was exceeded. +// An ACM Private CA quota has been exceeded. See the exception message returned +// to determine the quota that was exceeded. // // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidStateException -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. // // * InvalidArnException // The requested Amazon Resource Name (ARN) does not refer to an existing resource. @@ -1299,6 +1648,7 @@ func (c *ACMPCA) ListCertificateAuthoritiesRequest(input *ListCertificateAuthori // ListCertificateAuthorities API operation for AWS Certificate Manager Private Certificate Authority. // // Lists the private certificate authorities that you created by using the CreateCertificateAuthority +// (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html) // action. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -1311,7 +1661,7 @@ func (c *ACMPCA) ListCertificateAuthoritiesRequest(input *ListCertificateAuthori // Returned Error Types: // * InvalidNextTokenException // The token specified in the NextToken argument is not valid. Use the token -// returned from your previous call to ListCertificateAuthorities. +// returned from your previous call to ListCertificateAuthorities (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html). // // See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities func (c *ACMPCA) ListCertificateAuthorities(input *ListCertificateAuthoritiesInput) (*ListCertificateAuthoritiesOutput, error) { @@ -1437,9 +1787,30 @@ func (c *ACMPCA) ListPermissionsRequest(input *ListPermissionsInput) (req *reque // ListPermissions API operation for AWS Certificate Manager Private Certificate Authority. // -// Lists all the permissions, if any, that have been assigned by a private CA. -// Permissions can be granted with the CreatePermission action and revoked with -// the DeletePermission action. +// List all permissions on a private CA, if any, 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. +// +// Permissions can be granted with the CreatePermission (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreatePermission.html) +// action and revoked with the DeletePermission (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePermission.html) +// 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 (acm-pca/latest/userguide/pca-rbp.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1450,19 +1821,18 @@ func (c *ACMPCA) ListPermissionsRequest(input *ListPermissionsInput) (req *reque // // Returned Error Types: // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidArnException // The requested Amazon Resource Name (ARN) does not refer to an existing resource. // // * InvalidNextTokenException // The token specified in the NextToken argument is not valid. Use the token -// returned from your previous call to ListCertificateAuthorities. +// returned from your previous call to ListCertificateAuthorities (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html). // // * InvalidStateException -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. // // * RequestFailedException // The request has failed for an unspecified reason. @@ -1591,11 +1961,13 @@ func (c *ACMPCA) ListTagsRequest(input *ListTagsInput) (req *request.Request, ou // ListTags API operation for AWS Certificate Manager Private Certificate Authority. // -// Lists the tags, if any, that are associated with your private CA. Tags are -// labels that you can use to identify and organize your CAs. Each tag consists -// of a key and an optional value. Call the TagCertificateAuthority action to -// add one or more tags to your CA. Call the UntagCertificateAuthority action -// to remove tags. +// Lists the tags, if any, that are associated with your private CA or one that +// has been shared with you. Tags are labels that you can use to identify and +// organize your CAs. Each tag consists of a key and an optional value. Call +// the TagCertificateAuthority (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_TagCertificateAuthority.html) +// action to add one or more tags to your CA. Call the UntagCertificateAuthority +// (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UntagCertificateAuthority.html) +// action to remove tags. // // 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 @@ -1606,15 +1978,14 @@ func (c *ACMPCA) ListTagsRequest(input *ListTagsInput) (req *request.Request, ou // // Returned Error Types: // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidArnException // The requested Amazon Resource Name (ARN) does not refer to an existing resource. // // * InvalidStateException -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. // // See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListTags func (c *ACMPCA) ListTags(input *ListTagsInput) (*ListTagsOutput, error) { @@ -1687,7 +2058,136 @@ func (c *ACMPCA) ListTagsPagesWithContext(ctx aws.Context, input *ListTagsInput, } } - return p.Err() + return p.Err() +} + +const opPutPolicy = "PutPolicy" + +// PutPolicyRequest generates a "aws/request.Request" representing the +// client's request for the PutPolicy 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 PutPolicy for more information on using the PutPolicy +// 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 PutPolicyRequest method. +// req, resp := client.PutPolicyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/PutPolicy +func (c *ACMPCA) PutPolicyRequest(input *PutPolicyInput) (req *request.Request, output *PutPolicyOutput) { + op := &request.Operation{ + Name: opPutPolicy, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &PutPolicyInput{} + } + + output = &PutPolicyOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// PutPolicy API operation for AWS Certificate Manager Private Certificate Authority. +// +// Attaches a resource-based policy to a private CA. +// +// A policy can also be applied by sharing (https://docs.aws.amazon.com/acm-pca/latest/userguide/pca-ram.html) +// a private CA through AWS Resource Access Manager (RAM). +// +// The policy can be displayed with GetPolicy (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetPolicy.html) +// and removed with DeletePolicy (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePolicy.html). +// +// About Policies +// +// * A policy grants access on a private CA to an AWS customer account, to +// AWS Organizations, or to an AWS Organizations unit. Policies are under +// the control of a CA administrator. For more information, see Using a Resource +// Based Policy with ACM Private CA (acm-pca/latest/userguide/pca-rbp.html). +// +// * A policy permits a user of AWS Certificate Manager (ACM) to issue ACM +// certificates signed by a CA in another account. +// +// * For ACM to manage automatic renewal of these certificates, the ACM user +// must configure a Service Linked Role (SLR). The SLR allows the ACM service +// to assume the identity of the user, subject to confirmation against the +// ACM Private CA policy. For more information, see Using a Service Linked +// Role with ACM (https://docs.aws.amazon.com/acm/latest/userguide/acm-slr.html). +// +// * Updates made in AWS Resource Manager (RAM) are reflected in policies. +// For more information, see Using AWS Resource Access Manager (RAM) with +// ACM Private CA (acm-pca/latest/userguide/pca-ram.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Certificate Manager Private Certificate Authority's +// API operation PutPolicy for usage and error information. +// +// Returned Error Types: +// * ConcurrentModificationException +// A previous update to your private CA is still ongoing. +// +// * InvalidArnException +// The requested Amazon Resource Name (ARN) does not refer to an existing resource. +// +// * InvalidStateException +// The state of the private CA does not allow this action to occur. +// +// * InvalidPolicyException +// The resource policy is invalid or is missing a required statement. For general +// information about IAM policy and statement structure, see Overview of JSON +// Policies (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json). +// +// * LockoutPreventedException +// The current action was prevented because it would lock the caller out from +// performing subsequent actions. Verify that the specified parameters would +// not result in the caller being denied access to the resource. +// +// * RequestFailedException +// The request has failed for an unspecified reason. +// +// * ResourceNotFoundException +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/PutPolicy +func (c *ACMPCA) PutPolicy(input *PutPolicyInput) (*PutPolicyOutput, error) { + req, out := c.PutPolicyRequest(input) + return out, req.Send() +} + +// PutPolicyWithContext is the same as PutPolicy with the addition of +// the ability to pass a context and additional request options. +// +// See PutPolicy 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 *ACMPCA) PutPolicyWithContext(ctx aws.Context, input *PutPolicyInput, opts ...request.Option) (*PutPolicyOutput, error) { + req, out := c.PutPolicyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() } const opRestoreCertificateAuthority = "RestoreCertificateAuthority" @@ -1737,15 +2237,18 @@ func (c *ACMPCA) RestoreCertificateAuthorityRequest(input *RestoreCertificateAut // // Restores a certificate authority (CA) that is in the DELETED state. You can // restore a CA during the period that you defined in the PermanentDeletionTimeInDays -// parameter of the DeleteCertificateAuthority action. Currently, you can specify -// 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, -// by default you can restore the CA at any time in a 30 day period. You can -// check the time remaining in the restoration period of a private CA in the -// DELETED state by calling the DescribeCertificateAuthority or ListCertificateAuthorities +// parameter of the DeleteCertificateAuthority (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeleteCertificateAuthority.html) +// action. Currently, you can specify 7 to 30 days. If you did not specify a +// PermanentDeletionTimeInDays value, by default you can restore the CA at any +// time in a 30 day period. You can check the time remaining in the restoration +// period of a private CA in the DELETED state by calling the DescribeCertificateAuthority +// (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DescribeCertificateAuthority.html) +// or ListCertificateAuthorities (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html) // actions. The status of a restored CA is set to its pre-deletion status when // the RestoreCertificateAuthority action returns. To change its status to ACTIVE, -// call the UpdateCertificateAuthority action. If the private CA was in the -// PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate +// call the UpdateCertificateAuthority (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html) +// action. If the private CA was in the PENDING_CERTIFICATE state at deletion, +// you must use the ImportCertificateAuthorityCertificate (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html) // action to import a certificate authority into the private CA before it can // be activated. You cannot restore a CA after the restoration period has ended. // @@ -1758,12 +2261,11 @@ func (c *ACMPCA) RestoreCertificateAuthorityRequest(input *RestoreCertificateAut // // Returned Error Types: // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidStateException -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. // // * InvalidArnException // The requested Amazon Resource Name (ARN) does not refer to an existing resource. @@ -1838,10 +2340,20 @@ func (c *ACMPCA) RevokeCertificateRequest(input *RevokeCertificateInput) (req *r // Revokes a certificate that was issued inside ACM Private CA. If you enable // a certificate revocation list (CRL) when you create or update your private // CA, information about the revoked certificates will be included in the CRL. -// ACM Private CA writes the CRL to an S3 bucket that you specify. For more -// information about revocation, see the CrlConfiguration structure. ACM Private -// CA also writes revocation information to the audit report. For more information, -// see CreateCertificateAuthorityAuditReport. +// ACM Private CA writes the CRL to an S3 bucket that you specify. A CRL is +// typically updated approximately 30 minutes after a certificate is revoked. +// If for any reason the CRL update fails, ACM Private CA attempts makes further +// attempts every 15 minutes. With Amazon CloudWatch, you can create alarms +// for the metrics CRLGenerated and MisconfiguredCRLBucket. For more information, +// see Supported CloudWatch Metrics (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCloudWatch.html). +// +// 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 (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html). +// +// ACM Private CA also writes revocation information to the audit report. For +// more information, see CreateCertificateAuthorityAuditReport (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html). // // You cannot revoke a root CA self-signed certificate. // @@ -1863,16 +2375,15 @@ func (c *ACMPCA) RevokeCertificateRequest(input *RevokeCertificateInput) (req *r // The request action cannot be performed or is prohibited. // // * InvalidStateException -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. // // * LimitExceededException -// An ACM Private CA limit has been exceeded. See the exception message returned -// to determine the limit that was exceeded. +// An ACM Private CA quota has been exceeded. See the exception message returned +// to determine the quota that was exceeded. // // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * RequestAlreadyProcessedException // Your request has already been completed. @@ -1957,8 +2468,9 @@ func (c *ACMPCA) TagCertificateAuthorityRequest(input *TagCertificateAuthorityIn // a tag to just one private CA if you want to identify a specific characteristic // of that CA, or you can apply the same tag to multiple private CAs if you // want to filter for a common relationship among those CAs. To remove one or -// more tags, use the UntagCertificateAuthority action. Call the ListTags action -// to see what tags are associated with your CA. +// more tags, use the UntagCertificateAuthority (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UntagCertificateAuthority.html) +// action. Call the ListTags (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListTags.html) +// action to see what tags are associated with your CA. // // 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 @@ -1969,15 +2481,14 @@ func (c *ACMPCA) TagCertificateAuthorityRequest(input *TagCertificateAuthorityIn // // Returned Error Types: // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidArnException // The requested Amazon Resource Name (ARN) does not refer to an existing resource. // // * InvalidStateException -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. // // * InvalidTagException // The tag associated with the CA is not valid. The invalid argument is contained @@ -2058,7 +2569,8 @@ func (c *ACMPCA) UntagCertificateAuthorityRequest(input *UntagCertificateAuthori // pair. If you do not specify the value portion of the tag when calling this // action, the tag will be removed regardless of value. If you specify a value, // the tag is removed only if it is associated with the specified value. To -// add tags to a private CA, use the TagCertificateAuthority. Call the ListTags +// add tags to a private CA, use the TagCertificateAuthority (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_TagCertificateAuthority.html). +// Call the ListTags (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListTags.html) // action to see what tags are associated with your CA. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2070,15 +2582,14 @@ func (c *ACMPCA) UntagCertificateAuthorityRequest(input *UntagCertificateAuthori // // Returned Error Types: // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidArnException // The requested Amazon Resource Name (ARN) does not refer to an existing resource. // // * InvalidStateException -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. // // * InvalidTagException // The tag associated with the CA is not valid. The invalid argument is contained @@ -2156,6 +2667,11 @@ func (c *ACMPCA) UpdateCertificateAuthorityRequest(input *UpdateCertificateAutho // it. You can disable a private CA that is in the ACTIVE state or make a CA // that is in the DISABLED state active again. // +// 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 (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaAuthAccess.html). +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2168,8 +2684,8 @@ func (c *ACMPCA) UpdateCertificateAuthorityRequest(input *UpdateCertificateAutho // A previous update to your private CA is still ongoing. // // * ResourceNotFoundException -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. // // * InvalidArgsException // One or more of the specified arguments was not valid. @@ -2178,12 +2694,12 @@ func (c *ACMPCA) UpdateCertificateAuthorityRequest(input *UpdateCertificateAutho // The requested Amazon Resource Name (ARN) does not refer to an existing resource. // // * InvalidStateException -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. // // * InvalidPolicyException -// The S3 bucket policy is not valid. The policy must give ACM Private CA rights -// to read from and write to the bucket and find the bucket location. +// The resource policy is invalid or is missing a required statement. For general +// information about IAM policy and statement structure, see Overview of JSON +// Policies (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json). // // See also, https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority func (c *ACMPCA) UpdateCertificateAuthority(input *UpdateCertificateAuthorityInput) (*UpdateCertificateAuthorityOutput, error) { @@ -2224,7 +2740,7 @@ type ASN1Subject struct { // Two-digit code that specifies the country in which the certificate subject // located. - Country *string `type:"string"` + Country *string `min:"2" type:"string"` // Disambiguating information for the certificate subject. DistinguishedNameQualifier *string `type:"string"` @@ -2282,6 +2798,19 @@ func (s ASN1Subject) GoString() string { return s.String() } +// Validate inspects the fields of the type to determine if they are valid. +func (s *ASN1Subject) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ASN1Subject"} + if s.Country != nil && len(*s.Country) < 2 { + invalidParams.Add(request.NewErrParamMinLen("Country", 2)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetCommonName sets the CommonName field's value. func (s *ASN1Subject) SetCommonName(v string) *ASN1Subject { s.CommonName = &v @@ -2370,11 +2899,13 @@ func (s *ASN1Subject) SetTitle(v string) *ASN1Subject { // private CA can issue and revoke X.509 digital certificates. Digital certificates // verify that the entity named in the certificate Subject field owns or controls // the public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority +// (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html) // action to create your private CA. You must then call the GetCertificateAuthorityCertificate +// (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetCertificateAuthorityCertificate.html) // action to retrieve a private CA certificate signing request (CSR). Sign the // CSR with your ACM Private CA-hosted or on-premises root or subordinate CA -// certificate. Call the ImportCertificateAuthorityCertificate action to import -// the signed certificate into AWS Certificate Manager (ACM). +// certificate. Call the ImportCertificateAuthorityCertificate (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html) +// action to import the signed certificate into AWS Certificate Manager (ACM). type CertificateAuthority struct { _ struct{} `type:"structure"` @@ -2400,8 +2931,12 @@ type CertificateAuthority struct { // Date and time before which your private CA certificate is not valid. NotBefore *time.Time `type:"timestamp"` + // The AWS account ID that owns the certificate authority. + OwnerAccount *string `min:"12" type:"string"` + // The period during which a deleted CA can be restored. For more information, // see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest + // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeleteCertificateAuthorityRequest.html) // action. RestorableUntil *time.Time `type:"timestamp"` @@ -2471,6 +3006,12 @@ func (s *CertificateAuthority) SetNotBefore(v time.Time) *CertificateAuthority { return s } +// SetOwnerAccount sets the OwnerAccount field's value. +func (s *CertificateAuthority) SetOwnerAccount(v string) *CertificateAuthority { + s.OwnerAccount = &v + return s +} + // SetRestorableUntil sets the RestorableUntil field's value. func (s *CertificateAuthority) SetRestorableUntil(v time.Time) *CertificateAuthority { s.RestorableUntil = &v @@ -2506,7 +3047,8 @@ func (s *CertificateAuthority) SetType(v string) *CertificateAuthority { // the key pair that your private CA creates when it issues a certificate. It // also includes the signature algorithm that it uses when issuing certificates, // and its X.500 distinguished name. You must specify this information when -// you call the CreateCertificateAuthority action. +// you call the CreateCertificateAuthority (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html) +// action. type CertificateAuthorityConfiguration struct { _ struct{} `type:"structure"` @@ -2519,6 +3061,9 @@ type CertificateAuthorityConfiguration struct { // Name of the algorithm your private CA uses to sign certificate requests. // + // This parameter should not be confused with the SigningAlgorithm parameter + // used to sign certificates when they are issued. + // // SigningAlgorithm is a required field SigningAlgorithm *string `type:"string" required:"true" enum:"SigningAlgorithm"` @@ -2551,6 +3096,11 @@ func (s *CertificateAuthorityConfiguration) Validate() error { if s.Subject == nil { invalidParams.Add(request.NewErrParamRequired("Subject")) } + if s.Subject != nil { + if err := s.Subject.Validate(); err != nil { + invalidParams.AddNested("Subject", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -2707,7 +3257,7 @@ type CreateCertificateAuthorityAuditReportInput struct { // The name of the S3 bucket that will contain the audit report. // // S3BucketName is a required field - S3BucketName *string `type:"string" required:"true"` + S3BucketName *string `min:"3" type:"string" required:"true"` } // String returns the string representation @@ -2735,6 +3285,9 @@ func (s *CreateCertificateAuthorityAuditReportInput) Validate() error { if s.S3BucketName == nil { invalidParams.Add(request.NewErrParamRequired("S3BucketName")) } + if s.S3BucketName != nil && len(*s.S3BucketName) < 3 { + invalidParams.Add(request.NewErrParamMinLen("S3BucketName", 3)) + } if invalidParams.Len() > 0 { return invalidParams @@ -2807,25 +3360,24 @@ type CreateCertificateAuthorityInput struct { CertificateAuthorityType *string `type:"string" required:"true" enum:"CertificateAuthorityType"` // Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority. - // Idempotency tokens time out after five minutes. Therefore, if you call CreateCertificateAuthority - // multiple times with the same idempotency token within a five minute period, - // ACM Private CA recognizes that you are requesting only one certificate. As - // a result, ACM Private CA issues only one. If you change the idempotency token - // for each call, however, ACM Private CA recognizes that you are requesting - // multiple certificates. + // For a given token, ACM Private CA creates exactly one CA. If you issue a + // subsequent call using the same token, ACM Private CA returns the ARN of the + // existing CA and takes no further action. If you change the idempotency token + // across multiple calls, ACM Private CA creates a unique CA for each unique + // token. IdempotencyToken *string `min:"1" type:"string"` // 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 // the name of your bucket in the CRL Distribution Points extension of your - // CA certificate. For more information, see the CrlConfiguration structure. + // CA certificate. For more information, see the CrlConfiguration (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CrlConfiguration.html) + // structure. RevocationConfiguration *RevocationConfiguration `type:"structure"` // Key-value pairs that will be attached to the new private CA. You can associate - // up to 50 tags with a private CA. For information using tags with - // - // IAM to manage permissions, see Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). + // up to 50 tags with a private CA. For information using tags with IAM to manage + // permissions, see Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). Tags []*Tag `min:"1" type:"list"` } @@ -2947,8 +3499,8 @@ type CreatePermissionInput struct { Actions []*string `min:"1" type:"list" required:"true"` // The Amazon Resource Name (ARN) of the CA that grants the permissions. You - // can find the ARN by calling the ListCertificateAuthorities action. This must - // have the following form: + // can find the ARN by calling the ListCertificateAuthorities (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html) + // action. This must have the following form: // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 . // @@ -3051,6 +3603,9 @@ 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 +// 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 // 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 @@ -3101,8 +3656,10 @@ type CrlConfiguration struct { // Boolean value that specifies whether certificate revocation lists (CRLs) // are enabled. You can use this value to enable certificate revocation for - // a new CA when you call the CreateCertificateAuthority action or for an existing - // CA when you call the UpdateCertificateAuthority action. + // a new CA when you call the CreateCertificateAuthority (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html) + // action or for an existing CA when you call the UpdateCertificateAuthority + // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html) + // action. // // Enabled is a required field Enabled *bool `type:"boolean" required:"true"` @@ -3113,9 +3670,9 @@ type CrlConfiguration struct { // Name of the S3 bucket that contains the CRL. If you do not provide a value // for the CustomCname argument, the name of your S3 bucket is placed into the // CRL Distribution Points extension of the issued certificate. You can change - // the name of your bucket by calling the UpdateCertificateAuthority action. - // You must specify a bucket policy that allows ACM Private CA to write the - // CRL to your bucket. + // the name of your bucket by calling the UpdateCertificateAuthority (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html) + // action. You must specify a bucket policy that allows ACM Private CA to write + // the CRL to your bucket. S3BucketName *string `min:"3" type:"string"` } @@ -3175,7 +3732,8 @@ func (s *CrlConfiguration) SetS3BucketName(v string) *CrlConfiguration { type DeleteCertificateAuthorityInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. + // The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority + // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html). // This must have the following form: // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 . @@ -3247,8 +3805,8 @@ type DeletePermissionInput struct { _ struct{} `type:"structure"` // The Amazon Resource Number (ARN) of the private CA that issued the permissions. - // You can find the CA's ARN by calling the ListCertificateAuthorities action. - // This must have the following form: + // You can find the CA's ARN by calling the ListCertificateAuthorities (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html) + // action. This must have the following form: // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 . // @@ -3329,10 +3887,69 @@ func (s DeletePermissionOutput) GoString() string { return s.String() } +type DeletePolicyInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Number (ARN) of the private CA that will have its policy + // deleted. You can find the CA's ARN by calling the ListCertificateAuthorities + // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html) + // action. The ARN value must have the form arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab. + // + // ResourceArn is a required field + ResourceArn *string `min:"5" type:"string" required:"true"` +} + +// String returns the string representation +func (s DeletePolicyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeletePolicyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeletePolicyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeletePolicyInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *DeletePolicyInput) SetResourceArn(v string) *DeletePolicyInput { + s.ResourceArn = &v + return s +} + +type DeletePolicyOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s DeletePolicyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeletePolicyOutput) GoString() string { + return s.String() +} + type DescribeCertificateAuthorityAuditReportInput struct { _ struct{} `type:"structure"` // The report ID returned by calling the CreateCertificateAuthorityAuditReport + // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html) // action. // // AuditReportId is a required field @@ -3400,7 +4017,7 @@ type DescribeCertificateAuthorityAuditReportOutput struct { CreatedAt *time.Time `type:"timestamp"` // Name of the S3 bucket that contains the report. - S3BucketName *string `type:"string"` + S3BucketName *string `min:"3" type:"string"` // S3 key that uniquely identifies the report file in your S3 bucket. S3Key *string `type:"string"` @@ -3443,7 +4060,8 @@ func (s *DescribeCertificateAuthorityAuditReportOutput) SetS3Key(v string) *Desc type DescribeCertificateAuthorityInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. + // The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority + // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html). // This must be of the form: // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 . @@ -3487,8 +4105,8 @@ func (s *DescribeCertificateAuthorityInput) SetCertificateAuthorityArn(v string) type DescribeCertificateAuthorityOutput struct { _ struct{} `type:"structure"` - // A CertificateAuthority structure that contains information about your private - // CA. + // A CertificateAuthority (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CertificateAuthority.html) + // structure that contains information about your private CA. CertificateAuthority *CertificateAuthority `type:"structure"` } @@ -3590,6 +4208,7 @@ type GetCertificateAuthorityCsrInput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority + // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html) // action. This must be of the form: // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 @@ -3665,7 +4284,8 @@ type GetCertificateInput struct { // CertificateArn is a required field CertificateArn *string `min:"5" type:"string" required:"true"` - // The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. + // The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority + // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html). // This must be of the form: // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 . @@ -3751,6 +4371,72 @@ func (s *GetCertificateOutput) SetCertificateChain(v string) *GetCertificateOutp return s } +type GetPolicyInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Number (ARN) of the private CA that will have its policy + // retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities + // action. + // + // ResourceArn is a required field + ResourceArn *string `min:"5" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetPolicyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetPolicyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetPolicyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetPolicyInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *GetPolicyInput) SetResourceArn(v string) *GetPolicyInput { + s.ResourceArn = &v + return s +} + +type GetPolicyOutput struct { + _ struct{} `type:"structure"` + + // The policy attached to the private CA as a JSON document. + Policy *string `min:"1" type:"string"` +} + +// String returns the string representation +func (s GetPolicyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetPolicyOutput) GoString() string { + return s.String() +} + +// SetPolicy sets the Policy field's value. +func (s *GetPolicyOutput) SetPolicy(v string) *GetPolicyOutput { + s.Policy = &v + return s +} + type ImportCertificateAuthorityCertificateInput struct { _ struct{} `type:"structure"` @@ -3762,7 +4448,8 @@ type ImportCertificateAuthorityCertificateInput struct { // Certificate is a required field Certificate []byte `min:"1" type:"blob" required:"true"` - // The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. + // The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority + // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html). // This must be of the form: // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 @@ -3959,7 +4646,7 @@ func (s *InvalidArnException) RequestID() string { } // The token specified in the NextToken argument is not valid. Use the token -// returned from your previous call to ListCertificateAuthorities. +// returned from your previous call to ListCertificateAuthorities (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html). type InvalidNextTokenException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -4015,8 +4702,9 @@ func (s *InvalidNextTokenException) RequestID() string { return s.RespMetadata.RequestID } -// The S3 bucket policy is not valid. The policy must give ACM Private CA rights -// to read from and write to the bucket and find the bucket location. +// The resource policy is invalid or is missing a required statement. For general +// information about IAM policy and statement structure, see Overview of JSON +// Policies (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json). type InvalidPolicyException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -4128,8 +4816,7 @@ func (s *InvalidRequestException) RequestID() string { return s.RespMetadata.RequestID } -// The private CA is in a state during which a report or certificate cannot -// be generated. +// The state of the private CA does not allow this action to occur. type InvalidStateException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -4245,7 +4932,8 @@ func (s *InvalidTagException) RequestID() string { type IssueCertificateInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. + // The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority + // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html). // This must be of the form: // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 @@ -4267,6 +4955,9 @@ type IssueCertificateInput struct { // openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 // -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr // + // Note: A CSR must provide either a subject name or a subject alternative name + // or the request will be rejected. + // // Csr is automatically base64 encoded/decoded by the SDK. // // Csr is a required field @@ -4283,18 +4974,46 @@ type IssueCertificateInput struct { // The name of the algorithm that will be used to sign the certificate to be // issued. // + // This parameter should not be confused with the SigningAlgorithm parameter + // used to sign a CSR. + // // SigningAlgorithm is a required field SigningAlgorithm *string `type:"string" required:"true" enum:"SigningAlgorithm"` // Specifies a custom configuration template to use when issuing a certificate. // If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 - // template. + // template. For CA certificates, you should choose the shortest path length + // that meets your needs. The path length is indicated by the PathLenN portion + // of the ARN, where N is the CA depth (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaTerms.html#terms-cadepth). + // + // Note: The CA depth configured on a subordinate CA certificate must not exceed + // the limit set by its parents in the CA hierarchy. // // The following service-owned TemplateArn values are supported by ACM Private // CA: // + // * arn:aws:acm-pca:::template/CodeSigningCertificate/V1 + // + // * arn:aws:acm-pca:::template/CodeSigningCertificate_CSRPassthrough/V1 + // // * arn:aws:acm-pca:::template/EndEntityCertificate/V1 // + // * arn:aws:acm-pca:::template/EndEntityCertificate_CSRPassthrough/V1 + // + // * arn:aws:acm-pca:::template/EndEntityClientAuthCertificate/V1 + // + // * arn:aws:acm-pca:::template/EndEntityClientAuthCertificate_CSRPassthrough/V1 + // + // * arn:aws:acm-pca:::template/EndEntityServerAuthCertificate/V1 + // + // * arn:aws:acm-pca:::template/EndEntityServerAuthCertificate_CSRPassthrough/V1 + // + // * arn:aws:acm-pca:::template/OCSPSigningCertificate/V1 + // + // * arn:aws:acm-pca:::template/OCSPSigningCertificate_CSRPassthrough/V1 + // + // * arn:aws:acm-pca:::template/RootCACertificate/V1 + // // * arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1 // // * arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1 @@ -4303,12 +5022,17 @@ type IssueCertificateInput struct { // // * arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1 // - // * arn:aws:acm-pca:::template/RootCACertificate/V1 - // // For more information, see Using Templates (https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html). TemplateArn *string `min:"5" type:"string"` - // The type of the validity period. + // Information describing the validity period of the certificate. + // + // When issuing a certificate, ACM Private CA sets the "Not Before" date in + // the validity field to date and time minus 60 minutes. This is intended to + // compensate for time inconsistencies across systems of 60 minutes or less. + // + // The validity period configured on a certificate must not exceed the limit + // set by its parents in the CA hierarchy. // // Validity is a required field Validity *Validity `type:"structure" required:"true"` @@ -4425,8 +5149,8 @@ func (s *IssueCertificateOutput) SetCertificateArn(v string) *IssueCertificateOu return s } -// An ACM Private CA limit has been exceeded. See the exception message returned -// to determine the limit that was exceeded. +// An ACM Private CA quota has been exceeded. See the exception message returned +// to determine the quota that was exceeded. type LimitExceededException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -4495,6 +5219,10 @@ type ListCertificateAuthoritiesInput struct { // you receive a response with truncated results. Set it to the value of the // NextToken parameter from the response you just received. NextToken *string `min:"1" type:"string"` + + // Use this parameter to filter the returned set of certificate authorities + // based on their owner. The default is SELF. + ResourceOwner *string `type:"string" enum:"ResourceOwner"` } // String returns the string representation @@ -4535,6 +5263,12 @@ func (s *ListCertificateAuthoritiesInput) SetNextToken(v string) *ListCertificat return s } +// SetResourceOwner sets the ResourceOwner field's value. +func (s *ListCertificateAuthoritiesInput) SetResourceOwner(v string) *ListCertificateAuthoritiesInput { + s.ResourceOwner = &v + return s +} + type ListCertificateAuthoritiesOutput struct { _ struct{} `type:"structure"` @@ -4572,9 +5306,10 @@ type ListPermissionsInput struct { _ struct{} `type:"structure"` // The Amazon Resource Number (ARN) of the private CA to inspect. You can find - // the ARN by calling the ListCertificateAuthorities action. This must be of - // the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 + // the ARN by calling the ListCertificateAuthorities (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html) + // action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 // You can get a private CA's ARN by running the ListCertificateAuthorities + // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html) // action. // // CertificateAuthorityArn is a required field @@ -4680,6 +5415,7 @@ type ListTagsInput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority + // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html) // action. This must be of the form: // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 @@ -4782,6 +5518,64 @@ func (s *ListTagsOutput) SetTags(v []*Tag) *ListTagsOutput { return s } +// The current action was prevented because it would lock the caller out from +// performing subsequent actions. Verify that the specified parameters would +// not result in the caller being denied access to the resource. +type LockoutPreventedException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation +func (s LockoutPreventedException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s LockoutPreventedException) GoString() string { + return s.String() +} + +func newErrorLockoutPreventedException(v protocol.ResponseMetadata) error { + return &LockoutPreventedException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *LockoutPreventedException) Code() string { + return "LockoutPreventedException" +} + +// Message returns the exception's message. +func (s *LockoutPreventedException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *LockoutPreventedException) OrigErr() error { + return nil +} + +func (s *LockoutPreventedException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *LockoutPreventedException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *LockoutPreventedException) RequestID() string { + return s.RespMetadata.RequestID +} + // The certificate signing request is invalid. type MalformedCSRException struct { _ struct{} `type:"structure"` @@ -4898,8 +5692,10 @@ func (s *MalformedCertificateException) RequestID() string { // service or entity. In order for ACM to automatically renew private certificates, // you must give the ACM service principal all available permissions (IssueCertificate, // GetCertificate, and ListPermissions). Permissions can be assigned with the -// CreatePermission action, removed with the DeletePermission action, and listed -// with the ListPermissions action. +// CreatePermission (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreatePermission.html) +// action, removed with the DeletePermission (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeletePermission.html) +// action, and listed with the ListPermissions (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListPermissions.html) +// action. type Permission struct { _ struct{} `type:"structure"` @@ -4914,14 +5710,14 @@ type Permission struct { CreatedAt *time.Time `type:"timestamp"` // The name of the policy that is associated with the permission. - Policy *string `type:"string"` + Policy *string `min:"1" type:"string"` // The AWS service or entity that holds the permission. At this time, the only // valid principal is acm.amazonaws.com. Principal *string `type:"string"` // The ID of the account that assigned the permission. - SourceAccount *string `type:"string"` + SourceAccount *string `min:"12" type:"string"` } // String returns the string representation @@ -5026,6 +5822,85 @@ func (s *PermissionAlreadyExistsException) RequestID() string { return s.RespMetadata.RequestID } +type PutPolicyInput struct { + _ struct{} `type:"structure"` + + // The path and filename of a JSON-formatted IAM policy to attach to the specified + // private CA resource. If this policy does not contain all required statements + // or if it includes any statement that is not allowed, the PutPolicy action + // returns an InvalidPolicyException. For information about IAM policy and statement + // structure, see Overview of JSON Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json). + // + // Policy is a required field + Policy *string `min:"1" type:"string" required:"true"` + + // The Amazon Resource Number (ARN) of the private CA to associate with the + // policy. The ARN of the CA can be found by calling the ListCertificateAuthorities + // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html) + // action. + // + // ResourceArn is a required field + ResourceArn *string `min:"5" type:"string" required:"true"` +} + +// String returns the string representation +func (s PutPolicyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PutPolicyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PutPolicyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PutPolicyInput"} + if s.Policy == nil { + invalidParams.Add(request.NewErrParamRequired("Policy")) + } + if s.Policy != nil && len(*s.Policy) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Policy", 1)) + } + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 5)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPolicy sets the Policy field's value. +func (s *PutPolicyInput) SetPolicy(v string) *PutPolicyInput { + s.Policy = &v + return s +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *PutPolicyInput) SetResourceArn(v string) *PutPolicyInput { + s.ResourceArn = &v + return s +} + +type PutPolicyOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s PutPolicyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PutPolicyOutput) GoString() string { + return s.String() +} + // Your request has already been completed. type RequestAlreadyProcessedException struct { _ struct{} `type:"structure"` @@ -5194,8 +6069,8 @@ func (s *RequestInProgressException) RequestID() string { return s.RespMetadata.RequestID } -// A resource such as a private CA, S3 bucket, certificate, or audit report -// cannot be found. +// A resource such as a private CA, S3 bucket, certificate, audit report, or +// policy cannot be found. type ResourceNotFoundException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -5255,6 +6130,7 @@ type RestoreCertificateAuthorityInput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority + // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html) // action. This must be of the form: // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 @@ -5310,10 +6186,11 @@ func (s RestoreCertificateAuthorityOutput) GoString() string { } // Certificate revocation information used by the CreateCertificateAuthority -// and UpdateCertificateAuthority actions. Your private certificate authority -// (CA) can create and maintain a certificate revocation list (CRL). A CRL contains -// information about certificates revoked by your CA. For more information, -// see RevokeCertificate. +// (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html) +// and UpdateCertificateAuthority (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html) +// actions. Your private certificate authority (CA) can create and maintain +// a certificate revocation list (CRL). A CRL contains information about certificates +// revoked by your CA. For more information, see RevokeCertificate (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_RevokeCertificate.html). type RevocationConfiguration struct { _ struct{} `type:"structure"` @@ -5365,10 +6242,10 @@ type RevokeCertificateInput struct { CertificateAuthorityArn *string `min:"5" type:"string" required:"true"` // Serial number of the certificate to be revoked. This must be in hexadecimal - // format. You can retrieve the serial number by calling GetCertificate with - // the Amazon Resource Name (ARN) of the certificate you want and the ARN of - // your private CA. The GetCertificate action retrieves the certificate in the - // PEM format. You can use the following OpenSSL command to list the certificate + // format. You can retrieve the serial number by calling GetCertificate (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetCertificate.html) + // with the Amazon Resource Name (ARN) of the certificate you want and the ARN + // of your private CA. The GetCertificate action retrieves the certificate in + // the PEM format. You can use the following OpenSSL command to list the certificate // in text format and copy the hexadecimal serial number. // // openssl x509 -in file_path -text -noout @@ -5453,7 +6330,8 @@ func (s RevokeCertificateOutput) GoString() string { // Tags are labels that you can use to identify and organize your private CAs. // Each tag consists of a key and an optional value. You can associate up to // 50 tags with a private CA. To add one or more tags to a private CA, call -// the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority +// the TagCertificateAuthority (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_TagCertificateAuthority.html) +// action. To remove a tag, call the UntagCertificateAuthority (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UntagCertificateAuthority.html) // action. type Tag struct { _ struct{} `type:"structure"` @@ -5508,7 +6386,8 @@ func (s *Tag) SetValue(v string) *Tag { type TagCertificateAuthorityInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. + // The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority + // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html). // This must be of the form: // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 @@ -5650,7 +6529,8 @@ func (s *TooManyTagsException) RequestID() string { type UntagCertificateAuthorityInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. + // The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority + // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html). // This must be of the form: // // arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 @@ -5813,18 +6693,51 @@ func (s UpdateCertificateAuthorityOutput) GoString() string { return s.String() } -// Length of time for which the certificate issued by your private certificate -// authority (CA), or by the private CA itself, is valid in days, months, or -// years. You can issue a certificate by calling the IssueCertificate action. +// Validity specifies the period of time during which a certificate is valid. +// Validity can be expressed as an explicit date and time when the certificate +// expires, or as a span of time after issuance, stated in days, months, or +// years. For more information, see Validity (https://tools.ietf.org/html/rfc5280#section-4.1.2.5) +// in RFC 5280. +// +// You can issue a certificate by calling the IssueCertificate (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html) +// action. type Validity struct { _ struct{} `type:"structure"` - // Specifies whether the Value parameter represents days, months, or years. + // Determines how ACM Private CA interprets the Value parameter, an integer. + // Supported validity types include those listed below. Type definitions with + // values include a sample input value and the resulting output. + // + // END_DATE: The specific date and time when the certificate will expire, expressed + // using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. + // When UTCTime is used, if the year field (YY) is greater than or equal to + // 50, the year is interpreted as 19YY. If the year field is less than 50, the + // year is interpreted as 20YY. + // + // * Sample input value: 491231235959 (UTCTime format) + // + // * Output expiration date/time: 12/31/2049 23:59:59 + // + // ABSOLUTE: The specific date and time when the certificate will expire, expressed + // in seconds since the Unix Epoch. + // + // * Sample input value: 2524608000 + // + // * Output expiration date/time: 01/01/2050 00:00:00 + // + // DAYS, MONTHS, YEARS: The relative time from the moment of issuance until + // the certificate will expire, expressed in days, months, or years. + // + // Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC: + // + // * Sample input value: 90 + // + // * Output expiration date: 01/10/2020 12:34:54 UTC // // Type is a required field Type *string `type:"string" required:"true" enum:"ValidityPeriodType"` - // Time period. + // A long integer interpreted according to the value of Type, below. // // Value is a required field Value *int64 `min:"1" type:"long" required:"true"` @@ -6023,6 +6936,22 @@ func KeyAlgorithm_Values() []string { } } +const ( + // ResourceOwnerSelf is a ResourceOwner enum value + ResourceOwnerSelf = "SELF" + + // ResourceOwnerOtherAccounts is a ResourceOwner enum value + ResourceOwnerOtherAccounts = "OTHER_ACCOUNTS" +) + +// ResourceOwner_Values returns all elements of the ResourceOwner enum +func ResourceOwner_Values() []string { + return []string{ + ResourceOwnerSelf, + ResourceOwnerOtherAccounts, + } +} + const ( // RevocationReasonUnspecified is a RevocationReason enum value RevocationReasonUnspecified = "UNSPECIFIED" diff --git a/service/acmpca/doc.go b/service/acmpca/doc.go index ca360e0e47..bc8c55b61a 100644 --- a/service/acmpca/doc.go +++ b/service/acmpca/doc.go @@ -3,6 +3,7 @@ // Package acmpca provides the client and types for making API // requests to AWS Certificate Manager Private Certificate Authority. // +// // 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. @@ -12,9 +13,9 @@ // an API that's tailored to the programming language or platform that you're // using. For more information, see AWS SDKs (https://aws.amazon.com/tools/#SDKs). // -// Each ACM Private CA API action has a throttling limit which determines the -// number of times the action can be called per second. For more information, -// see API Rate Limits in ACM Private CA (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaLimits.html#PcaLimits-api) +// 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 (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaLimits.html#PcaLimits-api) // in the ACM Private CA user guide. // // See https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22 for more information on this service. diff --git a/service/acmpca/errors.go b/service/acmpca/errors.go index 62564f2a81..a95d1ccca4 100644 --- a/service/acmpca/errors.go +++ b/service/acmpca/errors.go @@ -37,14 +37,15 @@ const ( // "InvalidNextTokenException". // // The token specified in the NextToken argument is not valid. Use the token - // returned from your previous call to ListCertificateAuthorities. + // returned from your previous call to ListCertificateAuthorities (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ListCertificateAuthorities.html). ErrCodeInvalidNextTokenException = "InvalidNextTokenException" // ErrCodeInvalidPolicyException for service response error code // "InvalidPolicyException". // - // The S3 bucket policy is not valid. The policy must give ACM Private CA rights - // to read from and write to the bucket and find the bucket location. + // The resource policy is invalid or is missing a required statement. For general + // information about IAM policy and statement structure, see Overview of JSON + // Policies (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json). ErrCodeInvalidPolicyException = "InvalidPolicyException" // ErrCodeInvalidRequestException for service response error code @@ -56,8 +57,7 @@ const ( // ErrCodeInvalidStateException for service response error code // "InvalidStateException". // - // The private CA is in a state during which a report or certificate cannot - // be generated. + // The state of the private CA does not allow this action to occur. ErrCodeInvalidStateException = "InvalidStateException" // ErrCodeInvalidTagException for service response error code @@ -70,10 +70,18 @@ const ( // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // - // An ACM Private CA limit has been exceeded. See the exception message returned - // to determine the limit that was exceeded. + // An ACM Private CA quota has been exceeded. See the exception message returned + // to determine the quota that was exceeded. ErrCodeLimitExceededException = "LimitExceededException" + // ErrCodeLockoutPreventedException for service response error code + // "LockoutPreventedException". + // + // The current action was prevented because it would lock the caller out from + // performing subsequent actions. Verify that the specified parameters would + // not result in the caller being denied access to the resource. + ErrCodeLockoutPreventedException = "LockoutPreventedException" + // ErrCodeMalformedCSRException for service response error code // "MalformedCSRException". // @@ -113,8 +121,8 @@ const ( // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // - // A resource such as a private CA, S3 bucket, certificate, or audit report - // cannot be found. + // A resource such as a private CA, S3 bucket, certificate, audit report, or + // policy cannot be found. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeTooManyTagsException for service response error code @@ -136,6 +144,7 @@ var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ "InvalidStateException": newErrorInvalidStateException, "InvalidTagException": newErrorInvalidTagException, "LimitExceededException": newErrorLimitExceededException, + "LockoutPreventedException": newErrorLockoutPreventedException, "MalformedCSRException": newErrorMalformedCSRException, "MalformedCertificateException": newErrorMalformedCertificateException, "PermissionAlreadyExistsException": newErrorPermissionAlreadyExistsException, diff --git a/service/ecr/api.go b/service/ecr/api.go index 990eae4ec2..462b049cc3 100644 --- a/service/ecr/api.go +++ b/service/ecr/api.go @@ -5193,7 +5193,7 @@ type Image struct { // The image manifest associated with the image. ImageManifest *string `locationName:"imageManifest" min:"1" type:"string"` - // The media type associated with the image manifest. + // The manifest media type of the image. ImageManifestMediaType *string `locationName:"imageManifestMediaType" type:"string"` // The AWS account ID associated with the registry containing the image. @@ -5305,9 +5305,15 @@ func (s *ImageAlreadyExistsException) RequestID() string { type ImageDetail struct { _ struct{} `type:"structure"` + // The artifact media type of the image. + ArtifactMediaType *string `locationName:"artifactMediaType" type:"string"` + // The sha256 digest of the image manifest. ImageDigest *string `locationName:"imageDigest" type:"string"` + // The media type of the image manifest. + ImageManifestMediaType *string `locationName:"imageManifestMediaType" type:"string"` + // The date and time, expressed in standard JavaScript date format, at which // the current image was pushed to the repository. ImagePushedAt *time.Time `locationName:"imagePushedAt" type:"timestamp"` @@ -5349,12 +5355,24 @@ func (s ImageDetail) GoString() string { return s.String() } +// SetArtifactMediaType sets the ArtifactMediaType field's value. +func (s *ImageDetail) SetArtifactMediaType(v string) *ImageDetail { + s.ArtifactMediaType = &v + return s +} + // SetImageDigest sets the ImageDigest field's value. func (s *ImageDetail) SetImageDigest(v string) *ImageDetail { s.ImageDigest = &v return s } +// SetImageManifestMediaType sets the ImageManifestMediaType field's value. +func (s *ImageDetail) SetImageManifestMediaType(v string) *ImageDetail { + s.ImageManifestMediaType = &v + return s +} + // SetImagePushedAt sets the ImagePushedAt field's value. func (s *ImageDetail) SetImagePushedAt(v time.Time) *ImageDetail { s.ImagePushedAt = &v diff --git a/service/elb/api.go b/service/elb/api.go index c2e93fa72d..00eba43323 100644 --- a/service/elb/api.go +++ b/service/elb/api.go @@ -64,7 +64,7 @@ func (c *ELB) AddTagsRequest(input *AddTagsInput) (req *request.Request, output // Each tag consists of a key and an optional value. If a tag with the same // key is already associated with the load balancer, AddTags updates its value. // -// For more information, see Tag Your Classic Load Balancer (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html) +// For more information, see Tag Your Classic Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html) // in the Classic Load Balancers Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -155,7 +155,7 @@ func (c *ELB) ApplySecurityGroupsToLoadBalancerRequest(input *ApplySecurityGroup // private cloud (VPC). The specified security groups override the previously // associated security groups. // -// For more information, see Security Groups for Load Balancers in a VPC (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-security-groups.html#elb-vpc-security-groups) +// For more information, see Security Groups for Load Balancers in a VPC (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-security-groups.html#elb-vpc-security-groups) // in the Classic Load Balancers Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -246,7 +246,7 @@ func (c *ELB) AttachLoadBalancerToSubnetsRequest(input *AttachLoadBalancerToSubn // // The load balancer evenly distributes requests across all registered subnets. // For more information, see Add or Remove Subnets for Your Load Balancer in -// a VPC (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-manage-subnets.html) +// a VPC (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-manage-subnets.html) // in the Classic Load Balancers Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -339,7 +339,7 @@ func (c *ELB) ConfigureHealthCheckRequest(input *ConfigureHealthCheckInput) (req // of your EC2 instances. // // For more information, see Configure Health Checks for Your Load Balancer -// (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-healthchecks.html) +// (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-healthchecks.html) // in the Classic Load Balancers Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -433,7 +433,7 @@ func (c *ELB) CreateAppCookieStickinessPolicyRequest(input *CreateAppCookieStick // If the application cookie is explicitly removed or expires, the session stops // being sticky until a new application cookie is issued. // -// For more information, see Application-Controlled Session Stickiness (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application) +// For more information, see Application-Controlled Session Stickiness (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application) // in the Classic Load Balancers Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -538,7 +538,7 @@ func (c *ELB) CreateLBCookieStickinessPolicyRequest(input *CreateLBCookieStickin // the same user to that server. The validity of the cookie is based on the // cookie expiration time, which is specified in the policy configuration. // -// For more information, see Duration-Based Session Stickiness (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-duration) +// For more information, see Duration-Based Session Stickiness (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-duration) // in the Classic Load Balancers Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -638,7 +638,7 @@ func (c *ELB) CreateLoadBalancerRequest(input *CreateLoadBalancerInput) (req *re // // You can create up to 20 load balancers per region per account. You can request // an increase for the number of load balancers for your account. For more information, -// see Limits for Your Classic Load Balancer (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-limits.html) +// see Limits for Your Classic Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-limits.html) // in the Classic Load Balancers Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -762,7 +762,7 @@ func (c *ELB) CreateLoadBalancerListenersRequest(input *CreateLoadBalancerListen // the properties of the new listener must match the properties of the existing // listener. // -// For more information, see Listeners for Your Classic Load Balancer (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html) +// For more information, see Listeners for Your Classic Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html) // in the Classic Load Balancers Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -1209,7 +1209,7 @@ func (c *ELB) DeregisterInstancesFromLoadBalancerRequest(input *DeregisterInstan // You can use DescribeLoadBalancers to verify that the instance is deregistered // from the load balancer. // -// For more information, see Register or De-Register EC2 Instances (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html) +// For more information, see Register or De-Register EC2 Instances (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html) // in the Classic Load Balancers Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -1295,7 +1295,7 @@ func (c *ELB) DescribeAccountLimitsRequest(input *DescribeAccountLimitsInput) (r // Describes the current Elastic Load Balancing resource limits for your AWS // account. // -// For more information, see Limits for Your Classic Load Balancer (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-limits.html) +// For more information, see Limits for Your Classic Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-limits.html) // in the Classic Load Balancers Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2037,7 +2037,7 @@ func (c *ELB) DisableAvailabilityZonesForLoadBalancerRequest(input *DisableAvail // the OutOfService state. Then, the load balancer attempts to equally balance // the traffic among its remaining Availability Zones. // -// For more information, see Add or Remove Availability Zones (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html) +// For more information, see Add or Remove Availability Zones (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html) // in the Classic Load Balancers Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2127,7 +2127,7 @@ func (c *ELB) EnableAvailabilityZonesForLoadBalancerRequest(input *EnableAvailab // // The load balancer evenly distributes requests across all its registered Availability // Zones that contain instances. For more information, see Add or Remove Availability -// Zones (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html) +// Zones (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-az.html) // in the Classic Load Balancers Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2216,13 +2216,13 @@ func (c *ELB) ModifyLoadBalancerAttributesRequest(input *ModifyLoadBalancerAttri // // For more information, see the following in the Classic Load Balancers Guide: // -// * Cross-Zone Load Balancing (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html) +// * Cross-Zone Load Balancing (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html) // -// * Connection Draining (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html) +// * Connection Draining (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html) // -// * Access Logs (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/access-log-collection.html) +// * Access Logs (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/access-log-collection.html) // -// * Idle Connection Timeout (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html) +// * Idle Connection Timeout (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2328,7 +2328,7 @@ func (c *ELB) RegisterInstancesWithLoadBalancerRequest(input *RegisterInstancesW // // To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer. // -// For more information, see Register or De-Register EC2 Instances (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html) +// For more information, see Register or De-Register EC2 Instances (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-deregister-register-instances.html) // in the Classic Load Balancers Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2497,7 +2497,7 @@ func (c *ELB) SetLoadBalancerListenerSSLCertificateRequest(input *SetLoadBalance // the same load balancer and port. // // For more information about updating your SSL certificate, see Replace the -// SSL Certificate for Your Load Balancer (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-update-ssl-cert.html) +// SSL Certificate for Your Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-update-ssl-cert.html) // in the Classic Load Balancers Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2605,9 +2605,9 @@ func (c *ELB) SetLoadBalancerPoliciesForBackendServerRequest(input *SetLoadBalan // that the policy is associated with the EC2 instance. // // For more information about enabling back-end instance authentication, see -// Configure Back-end Instance Authentication (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-create-https-ssl-load-balancer.html#configure_backendauth_clt) +// Configure Back-end Instance Authentication (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-create-https-ssl-load-balancer.html#configure_backendauth_clt) // in the Classic Load Balancers Guide. For more information about Proxy Protocol, -// see Configure Proxy Protocol Support (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-proxy-protocol.html) +// see Configure Proxy Protocol Support (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-proxy-protocol.html) // in the Classic Load Balancers Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2700,9 +2700,9 @@ func (c *ELB) SetLoadBalancerPoliciesOfListenerRequest(input *SetLoadBalancerPol // To enable back-end server authentication, use SetLoadBalancerPoliciesForBackendServer. // // For more information about setting policies, see Update the SSL Negotiation -// Configuration (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/ssl-config-update.html), -// Duration-Based Session Stickiness (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-duration), -// and Application-Controlled Session Stickiness (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application) +// Configuration (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/ssl-config-update.html), +// Duration-Based Session Stickiness (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-duration), +// and Application-Controlled Session Stickiness (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-sticky-sessions.html#enable-sticky-sessions-application) // in the Classic Load Balancers Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2899,14 +2899,20 @@ func (s AddTagsOutput) GoString() string { return s.String() } -// This data type is reserved. +// Information about additional load balancer attributes. type AdditionalAttribute struct { _ struct{} `type:"structure"` - // This parameter is reserved. + // The name of the attribute. + // + // The following attribute is supported. + // + // * elb.http.desyncmitigationmode - Determines how the load balancer handles + // requests that might pose a security risk to your application. The possible + // values are monitor, defensive, and strictest. The default is defensive. Key *string `type:"string"` - // This parameter is reserved. + // This value of the attribute. Value *string `type:"string"` } @@ -3509,7 +3515,7 @@ type CreateLoadBalancerInput struct { // The listeners. // - // For more information, see Listeners for Your Classic Load Balancer (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html) + // For more information, see Listeners for Your Classic Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html) // in the Classic Load Balancers Guide. // // Listeners is a required field @@ -3529,7 +3535,7 @@ type CreateLoadBalancerInput struct { // By default, Elastic Load Balancing creates an Internet-facing load balancer // with a DNS name that resolves to public IP addresses. For more information // about Internet-facing and Internal load balancers, see Load Balancer Scheme - // (http://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/how-elastic-load-balancing-works.html#load-balancer-scheme) + // (https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/how-elastic-load-balancing-works.html#load-balancer-scheme) // in the Elastic Load Balancing User Guide. // // Specify internal to create a load balancer with a DNS name that resolves @@ -3546,7 +3552,7 @@ type CreateLoadBalancerInput struct { // A list of tags to assign to the load balancer. // // For more information about tagging your load balancer, see Tag Your Classic - // Load Balancer (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html) + // Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html) // in the Classic Load Balancers Guide. Tags []*Tag `min:"1" type:"list"` } @@ -5166,7 +5172,7 @@ func (s *Limit) SetName(v string) *Limit { // Information about a listener. // // For information about the protocols and the ports supported by Elastic Load -// Balancing, see Listeners for Your Classic Load Balancer (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html) +// Balancing, see Listeners for Your Classic Load Balancer (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/elb-listener-config.html) // in the Classic Load Balancers Guide. type Listener struct { _ struct{} `type:"structure"` @@ -5179,8 +5185,9 @@ type Listener struct { // The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or // SSL. // - // If the front-end protocol is HTTP, HTTPS, TCP, or SSL, InstanceProtocol must - // be at the same protocol. + // If the front-end protocol is TCP or SSL, the back-end protocol must be TCP + // or SSL. If the front-end protocol is HTTP or HTTPS, the back-end protocol + // must be HTTP or HTTPS. // // If there is another listener with the same InstancePort whose InstanceProtocol // is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure. @@ -5308,17 +5315,17 @@ type LoadBalancerAttributes struct { // If enabled, the load balancer captures detailed information of all requests // and delivers the information to the Amazon S3 bucket that you specify. // - // For more information, see Enable Access Logs (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-access-logs.html) + // For more information, see Enable Access Logs (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-access-logs.html) // in the Classic Load Balancers Guide. AccessLog *AccessLog `type:"structure"` - // This parameter is reserved. + // Any additional attributes. AdditionalAttributes []*AdditionalAttribute `type:"list"` // If enabled, the load balancer allows existing requests to complete before // the load balancer shifts traffic away from a deregistered or unhealthy instance. // - // For more information, see Configure Connection Draining (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html) + // For more information, see Configure Connection Draining (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-conn-drain.html) // in the Classic Load Balancers Guide. ConnectionDraining *ConnectionDraining `type:"structure"` @@ -5327,14 +5334,14 @@ type LoadBalancerAttributes struct { // // By default, Elastic Load Balancing maintains a 60-second idle connection // timeout for both front-end and back-end connections of your load balancer. - // For more information, see Configure Idle Connection Timeout (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html) + // For more information, see Configure Idle Connection Timeout (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html) // in the Classic Load Balancers Guide. ConnectionSettings *ConnectionSettings `type:"structure"` // If enabled, the load balancer routes the request traffic evenly across all // instances regardless of the Availability Zones. // - // For more information, see Configure Cross-Zone Load Balancing (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html) + // For more information, see Configure Cross-Zone Load Balancing (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-disable-crosszone-lb.html) // in the Classic Load Balancers Guide. CrossZoneLoadBalancing *CrossZoneLoadBalancing `type:"structure"` } @@ -5421,7 +5428,7 @@ type LoadBalancerDescription struct { // The DNS name of the load balancer. // - // For more information, see Configure a Custom Domain Name (http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/using-domain-names-with-elb.html) + // For more information, see Configure a Custom Domain Name (https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/using-domain-names-with-elb.html) // in the Classic Load Balancers Guide. CanonicalHostedZoneName *string `type:"string"` diff --git a/service/elb/doc.go b/service/elb/doc.go index 0b93ed4740..5fa8e5154e 100644 --- a/service/elb/doc.go +++ b/service/elb/doc.go @@ -15,7 +15,7 @@ // Elastic Load Balancing supports three types of load balancers: Application // Load Balancers, Network Load Balancers, and Classic Load Balancers. You can // select a load balancer based on your application needs. For more information, -// see the Elastic Load Balancing User Guide (http://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/). +// see the Elastic Load Balancing User Guide (https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/). // // This reference covers the 2012-06-01 API, which supports Classic Load Balancers. // The 2015-12-01 API supports Application Load Balancers and Network Load Balancers. diff --git a/service/elbv2/api.go b/service/elbv2/api.go index de56e7e95a..2777c63628 100644 --- a/service/elbv2/api.go +++ b/service/elbv2/api.go @@ -533,6 +533,7 @@ func (c *ELBV2) CreateRuleRequest(input *CreateRuleInput) (req *request.Request, // Creates a rule for the specified listener. The listener must be associated // with an Application Load Balancer. // +// Each rule consists of a priority, one or more actions, and one or more conditions. // Rules are evaluated in priority order, from the lowest value to the highest // value. When the conditions for a rule are met, its actions are performed. // If the conditions for no rules are met, the actions for the default rule @@ -947,6 +948,8 @@ func (c *ELBV2) DeleteRuleRequest(input *DeleteRuleInput) (req *request.Request, // // Deletes the specified rule. // +// You can't delete the default rule. +// // 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. @@ -3432,6 +3435,9 @@ func (c *ELBV2) SetSubnetsWithContext(ctx aws.Context, input *SetSubnetsInput, o } // Information about an action. +// +// Each rule must include exactly one of the following types of actions: forward, +// fixed-response, or redirect, and it must be the last action to be performed. type Action struct { _ struct{} `type:"structure"` @@ -3455,9 +3461,7 @@ type Action struct { ForwardConfig *ForwardActionConfig `type:"structure"` // The order for the action. This value is required for rules with multiple - // actions. The action with the lowest value for order is performed first. The - // last action to be performed must be one of the following types of actions: - // a forward, fixed-response, or redirect. + // actions. The action with the lowest value for order is performed first. Order *int64 `min:"1" type:"integer"` // [Application Load Balancer] Information for creating a redirect action. Specify @@ -4549,9 +4553,10 @@ type CreateRuleInput struct { // Actions is a required field Actions []*Action `type:"list" required:"true"` - // The conditions. Each rule can include zero or one of the following conditions: - // http-request-method, host-header, path-pattern, and source-ip, and zero or - // more of the following conditions: http-header and query-string. + // The conditions. Each rule can optionally include up to one of each of the + // following conditions: http-request-method, host-header, path-pattern, and + // source-ip. Each rule can also optionally include one or more of each of the + // following conditions: http-header and query-string. // // Conditions is a required field Conditions []*RuleCondition `type:"list" required:"true"` @@ -4734,8 +4739,7 @@ type CreateTargetGroupInput struct { // one target type. // // * instance - Targets are specified by instance ID. This is the default - // value. If the target group protocol is UDP or TCP_UDP, the target type - // must be instance. + // value. // // * ip - Targets are specified by IP address. You can specify IP addresses // from the subnets of the virtual private cloud (VPC) for the target group, @@ -6678,6 +6682,11 @@ type LoadBalancerAttribute struct { // * idle_timeout.timeout_seconds - The idle timeout value, in seconds. The // valid range is 1-4000 seconds. The default is 60 seconds. // + // * routing.http.desync_mitigation_mode - Determines how the load balancer + // handles requests that might pose a security risk to your application. + // The possible values are monitor, defensive, and strictest. The default + // is defensive. + // // * routing.http.drop_invalid_header_fields.enabled - Indicates whether // HTTP headers with invalid header fields are removed by the load balancer // (true) or routed to targets (false). The default is false. @@ -7286,7 +7295,9 @@ type ModifyTargetGroupInput struct { HealthyThresholdCount *int64 `min:"2" type:"integer"` // [HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful - // response from a target. + // response from a target. The possible values are from 200 to 499. You can + // specify multiple values (for example, "200,202") or a range of values (for + // example, "200-299"). The default is 200. // // With Network Load Balancers, you can't modify this setting. Matcher *Matcher `type:"structure"` @@ -7925,6 +7936,11 @@ func (s *Rule) SetRuleArn(v string) *Rule { } // Information about a condition for a rule. +// +// Each rule can optionally include up to one of each of the following conditions: +// http-request-method, host-header, path-pattern, and source-ip. Each rule +// can also optionally include one or more of each of the following conditions: +// http-header and query-string. type RuleCondition struct { _ struct{} `type:"structure"` @@ -7961,13 +7977,14 @@ type RuleCondition struct { // Information for a source IP condition. Specify only when Field is source-ip. SourceIpConfig *SourceIpConditionConfig `type:"structure"` - // The condition value. You can use Values if the rule contains only host-header - // and path-pattern conditions. Otherwise, you can use HostHeaderConfig for - // host-header conditions and PathPatternConfig for path-pattern conditions. + // The condition value. Specify only when Field is host-header or path-pattern. + // Alternatively, to specify multiple host names or multiple path patterns, + // use HostHeaderConfig or PathPatternConfig. // - // If Field is host-header, you can specify a single host name (for example, - // my.example.com). A host name is case insensitive, can be up to 128 characters - // in length, and can contain any of the following characters. + // If Field is host-header and you are not using HostHeaderConfig, you can specify + // a single host name (for example, my.example.com) in Values. A host name is + // case insensitive, can be up to 128 characters in length, and can contain + // any of the following characters. // // * A-Z, a-z, 0-9 // @@ -7977,9 +7994,10 @@ type RuleCondition struct { // // * ? (matches exactly 1 character) // - // If Field is path-pattern, you can specify a single path pattern (for example, - // /img/*). A path pattern is case-sensitive, can be up to 128 characters in - // length, and can contain any of the following characters. + // If Field is path-pattern and you are not using PathPatternConfig, you can + // specify a single path pattern (for example, /img/*) in Values. A path pattern + // is case-sensitive, can be up to 128 characters in length, and can contain + // any of the following characters. // // * A-Z, a-z, 0-9 // @@ -8892,8 +8910,8 @@ type TargetGroupAttribute struct { // * slow_start.duration_seconds - The time period, in seconds, during which // a newly registered target receives an increasing share of the traffic // to the target group. After this time period ends, the target receives - // its full share of traffic. The range is 30-900 seconds (15 minutes). Slow - // start mode is disabled by default. + // its full share of traffic. The range is 30-900 seconds (15 minutes). The + // default is 0 seconds (disabled). // // * stickiness.lb_cookie.duration_seconds - The time period, in seconds, // during which requests from a client should be routed to the same target. diff --git a/service/kinesis/api.go b/service/kinesis/api.go index c954dd1116..4a24daca99 100644 --- a/service/kinesis/api.go +++ b/service/kinesis/api.go @@ -174,8 +174,8 @@ func (c *Kinesis) CreateStreamRequest(input *CreateStreamInput) (req *request.Re // // You specify and control the number of shards that a stream is composed of. // Each shard can support reads up to five transactions per second, up to a -// maximum data read total of 2 MB per second. Each shard can support writes -// up to 1,000 records per second, up to a maximum data write total of 1 MB +// maximum data read total of 2 MiB per second. Each shard can support writes +// up to 1,000 records per second, up to a maximum data write total of 1 MiB // per second. If the amount of data input increases or decreases, you can add // or remove shards. // @@ -198,9 +198,9 @@ func (c *Kinesis) CreateStreamRequest(input *CreateStreamInput) (req *request.Re // * Create more shards than are authorized for your account. // // For the default shard limit for an AWS account, see Amazon Kinesis Data Streams -// Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) +// Limits (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, -// contact AWS Support (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html). +// contact AWS Support (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html). // // You can use DescribeStream to check the stream status, which is returned // in StreamStatus. @@ -510,7 +510,7 @@ func (c *Kinesis) DeregisterStreamConsumerRequest(input *DeregisterStreamConsume // with a given data stream. The description of a consumer contains its name // and ARN. // -// This operation has a limit of five transactions per second per account. +// This operation has a limit of five transactions per second per stream. // // 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 @@ -700,7 +700,7 @@ func (c *Kinesis) DescribeStreamRequest(input *DescribeStreamInput) (req *reques // the record is put into the stream. // // You can limit the number of shards returned by each call. For more information, -// see Retrieving Shards from a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html) +// see Retrieving Shards from a Stream (https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html) // in the Amazon Kinesis Data Streams Developer Guide. // // There are no guarantees about the chronological order shards returned. To @@ -851,7 +851,7 @@ func (c *Kinesis) DescribeStreamConsumerRequest(input *DescribeStreamConsumerInp // the ListStreamConsumers operation to get a list of the descriptions of all // the consumers that are currently registered with a given data stream. // -// This operation has a limit of 20 transactions per second per account. +// This operation has a limit of 20 transactions per second per stream. // // 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 @@ -946,6 +946,8 @@ func (c *Kinesis) DescribeStreamSummaryRequest(input *DescribeStreamSummaryInput // status, record retention period, approximate creation time, monitoring, encryption // details, and open shard count. // +// DescribeStreamSummary has a limit of 20 transactions per second per account. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1223,7 +1225,7 @@ func (c *Kinesis) GetRecordsRequest(input *GetRecordsInput) (req *request.Reques // // You can scale by provisioning multiple shards per stream while considering // service limits (for more information, see Amazon Kinesis Data Streams Limits -// (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) +// (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide). Your application should // have one thread per shard, each reading continuously from its stream. To // read from a stream continually, call GetRecords in a loop. Use GetShardIterator @@ -1254,7 +1256,7 @@ func (c *Kinesis) GetRecordsRequest(input *GetRecordsInput) (req *request.Reques // // To detect whether the application is falling behind in processing, you can // use the MillisBehindLatest response attribute. You can also monitor the stream -// using CloudWatch metrics and other mechanisms (see Monitoring (http://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html) +// using CloudWatch metrics and other mechanisms (see Monitoring (https://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html) // in the Amazon Kinesis Data Streams Developer Guide). // // Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, @@ -1267,7 +1269,7 @@ func (c *Kinesis) GetRecordsRequest(input *GetRecordsInput) (req *request.Reques // always increasing. For example, records in a shard or across a stream might // have time stamps that are out of order. // -// This operation has a limit of five transactions per second per account. +// This operation has a limit of five transactions per second per shard. // // 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 @@ -1288,9 +1290,9 @@ func (c *Kinesis) GetRecordsRequest(input *GetRecordsInput) (req *request.Reques // * ProvisionedThroughputExceededException // The request rate for the stream is too high, or the requested data is too // large for the available throughput. Reduce the frequency or size of your -// requests. For more information, see Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) +// requests. For more information, see Streams Limits (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and -// Exponential Backoff in AWS (http://docs.aws.amazon.com/general/latest/gr/api-retries.html) +// Exponential Backoff in AWS (https://docs.aws.amazon.com/general/latest/gr/api-retries.html) // in the AWS General Reference. // // * ExpiredIteratorException @@ -1303,7 +1305,7 @@ func (c *Kinesis) GetRecordsRequest(input *GetRecordsInput) (req *request.Reques // * KMSInvalidStateException // The request was rejected because the state of the specified resource isn't // valid for this request. For more information, see How Key State Affects Use -// of a Customer Master Key (http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) // in the AWS Key Management Service Developer Guide. // // * KMSAccessDeniedException @@ -1319,7 +1321,7 @@ func (c *Kinesis) GetRecordsRequest(input *GetRecordsInput) (req *request.Reques // // * KMSThrottlingException // The request was denied due to request throttling. For more information about -// throttling, see Limits (http://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) +// throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) // in the AWS Key Management Service Developer Guide. // // See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetRecords @@ -1418,7 +1420,7 @@ func (c *Kinesis) GetShardIteratorRequest(input *GetShardIteratorInput) (req *re // // If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException. // For more information about throughput limits, see GetRecords, and Streams -// Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) +// Limits (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide. // // If the shard is closed, GetShardIterator returns a valid iterator for the @@ -1447,9 +1449,9 @@ func (c *Kinesis) GetShardIteratorRequest(input *GetShardIteratorInput) (req *re // * ProvisionedThroughputExceededException // The request rate for the stream is too high, or the requested data is too // large for the available throughput. Reduce the frequency or size of your -// requests. For more information, see Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) +// requests. For more information, see Streams Limits (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and -// Exponential Backoff in AWS (http://docs.aws.amazon.com/general/latest/gr/api-retries.html) +// Exponential Backoff in AWS (https://docs.aws.amazon.com/general/latest/gr/api-retries.html) // in the AWS General Reference. // // See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/GetShardIterator @@ -1732,7 +1734,7 @@ func (c *Kinesis) ListStreamConsumersRequest(input *ListStreamConsumersInput) (r // Lists the consumers registered to receive data from a stream using enhanced // fan-out, and provides information about each consumer. // -// This operation has a limit of 10 transactions per second per account. +// This operation has a limit of 5 transactions per second per stream. // // 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 @@ -2135,7 +2137,7 @@ func (c *Kinesis) MergeShardsRequest(input *MergeShardsInput) (req *request.Requ // MergeShards is called when there is a need to reduce the overall capacity // of a stream because of excess capacity that is not being used. You must specify // the shard to be merged and the adjacent shard for a stream. For more information -// about merging shards, see Merge Two Shards (http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html) +// about merging shards, see Merge Two Shards (https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html) // in the Amazon Kinesis Data Streams Developer Guide. // // If the stream is in the ACTIVE state, you can call MergeShards. If a stream @@ -2252,7 +2254,7 @@ func (c *Kinesis) PutRecordRequest(input *PutRecordInput) (req *request.Request, // Writes a single data record into an Amazon Kinesis data stream. Call PutRecord // to send data into the stream for real-time ingestion and subsequent processing, // one record at a time. Each shard can support writes up to 1,000 records per -// second, up to a maximum data write total of 1 MB per second. +// second, up to a maximum data write total of 1 MiB per second. // // You must specify the name of the stream that captures, stores, and transports // the data; a partition key; and the data blob itself. @@ -2270,7 +2272,7 @@ func (c *Kinesis) PutRecordRequest(input *PutRecordInput) (req *request.Request, // integer values and to map associated data records to shards using the hash // key ranges of the shards. You can override hashing the partition key to determine // the shard by explicitly specifying a hash value using the ExplicitHashKey -// parameter. For more information, see Adding Data to a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream) +// parameter. For more information, see Adding Data to a Stream (https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream) // in the Amazon Kinesis Data Streams Developer Guide. // // PutRecord returns the shard ID of where the data record was placed and the @@ -2279,9 +2281,12 @@ func (c *Kinesis) PutRecordRequest(input *PutRecordInput) (req *request.Request, // Sequence numbers increase over time and are specific to a shard within a // stream, not across all shards within a stream. To guarantee strictly increasing // ordering, write serially to a shard and use the SequenceNumberForOrdering -// parameter. For more information, see Adding Data to a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream) +// parameter. For more information, see Adding Data to a Stream (https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream) // in the Amazon Kinesis Data Streams Developer Guide. // +// After you write a record to a stream, you cannot modify that record or its +// order within the stream. +// // If a PutRecord request cannot be processed because of insufficient provisioned // throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException. // @@ -2308,9 +2313,9 @@ func (c *Kinesis) PutRecordRequest(input *PutRecordInput) (req *request.Request, // * ProvisionedThroughputExceededException // The request rate for the stream is too high, or the requested data is too // large for the available throughput. Reduce the frequency or size of your -// requests. For more information, see Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) +// requests. For more information, see Streams Limits (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and -// Exponential Backoff in AWS (http://docs.aws.amazon.com/general/latest/gr/api-retries.html) +// Exponential Backoff in AWS (https://docs.aws.amazon.com/general/latest/gr/api-retries.html) // in the AWS General Reference. // // * KMSDisabledException @@ -2320,7 +2325,7 @@ func (c *Kinesis) PutRecordRequest(input *PutRecordInput) (req *request.Request, // * KMSInvalidStateException // The request was rejected because the state of the specified resource isn't // valid for this request. For more information, see How Key State Affects Use -// of a Customer Master Key (http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) // in the AWS Key Management Service Developer Guide. // // * KMSAccessDeniedException @@ -2336,7 +2341,7 @@ func (c *Kinesis) PutRecordRequest(input *PutRecordInput) (req *request.Request, // // * KMSThrottlingException // The request was denied due to request throttling. For more information about -// throttling, see Limits (http://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) +// throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) // in the AWS Key Management Service Developer Guide. // // See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/PutRecord @@ -2410,9 +2415,9 @@ func (c *Kinesis) PutRecordsRequest(input *PutRecordsInput) (req *request.Reques // into the stream for data ingestion and processing. // // Each PutRecords request can support up to 500 records. Each record in the -// request can be as large as 1 MB, up to a limit of 5 MB for the entire request, +// request can be as large as 1 MiB, up to a limit of 5 MiB for the entire request, // including partition keys. Each shard can support writes up to 1,000 records -// per second, up to a maximum data write total of 1 MB per second. +// per second, up to a maximum data write total of 1 MiB per second. // // You must specify the name of the stream that captures, stores, and transports // the data; and an array of request Records, with each record in the array @@ -2427,13 +2432,13 @@ func (c *Kinesis) PutRecordsRequest(input *PutRecordsInput) (req *request.Reques // hash function is used to map partition keys to 128-bit integer values and // to map associated data records to shards. As a result of this hashing mechanism, // all data records with the same partition key map to the same shard within -// the stream. For more information, see Adding Data to a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream) +// the stream. For more information, see Adding Data to a Stream (https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream) // in the Amazon Kinesis Data Streams Developer Guide. // // Each record in the Records array may include an optional parameter, ExplicitHashKey, // which overrides the partition key to shard mapping. This parameter allows // a data producer to determine explicitly the shard where the record is stored. -// For more information, see Adding Multiple Records with PutRecords (http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords) +// For more information, see Adding Multiple Records with PutRecords (https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords) // in the Amazon Kinesis Data Streams Developer Guide. // // The PutRecords response includes an array of response Records. Each record @@ -2445,7 +2450,10 @@ func (c *Kinesis) PutRecordsRequest(input *PutRecordsInput) (req *request.Reques // The response Records array includes both successfully and unsuccessfully // processed records. Kinesis Data Streams attempts to process all records in // each PutRecords request. A single record failure does not stop the processing -// of subsequent records. +// of subsequent records. As a result, PutRecords doesn't guarantee the ordering +// of records. If you need to read records in the same order they are written +// to the stream, use PutRecord instead of PutRecords, and write to the same +// shard. // // A successfully processed record includes ShardId and SequenceNumber values. // The ShardId parameter identifies the shard in the stream where the record @@ -2458,9 +2466,12 @@ func (c *Kinesis) PutRecordsRequest(input *PutRecordsInput) (req *request.Reques // more detailed information about the ProvisionedThroughputExceededException // exception including the account ID, stream name, and shard ID of the record // that was throttled. For more information about partially successful responses, -// see Adding Multiple Records with PutRecords (http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords) +// see Adding Multiple Records with PutRecords (https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords) // in the Amazon Kinesis Data Streams Developer Guide. // +// After you write a record to a stream, you cannot modify that record or its +// order within the stream. +// // By default, data records are accessible for 24 hours from the time that they // are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod // to modify this retention period. @@ -2484,9 +2495,9 @@ func (c *Kinesis) PutRecordsRequest(input *PutRecordsInput) (req *request.Reques // * ProvisionedThroughputExceededException // The request rate for the stream is too high, or the requested data is too // large for the available throughput. Reduce the frequency or size of your -// requests. For more information, see Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) +// requests. For more information, see Streams Limits (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and -// Exponential Backoff in AWS (http://docs.aws.amazon.com/general/latest/gr/api-retries.html) +// Exponential Backoff in AWS (https://docs.aws.amazon.com/general/latest/gr/api-retries.html) // in the AWS General Reference. // // * KMSDisabledException @@ -2496,7 +2507,7 @@ func (c *Kinesis) PutRecordsRequest(input *PutRecordsInput) (req *request.Reques // * KMSInvalidStateException // The request was rejected because the state of the specified resource isn't // valid for this request. For more information, see How Key State Affects Use -// of a Customer Master Key (http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) // in the AWS Key Management Service Developer Guide. // // * KMSAccessDeniedException @@ -2512,7 +2523,7 @@ func (c *Kinesis) PutRecordsRequest(input *PutRecordsInput) (req *request.Reques // // * KMSThrottlingException // The request was denied due to request throttling. For more information about -// throttling, see Limits (http://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) +// throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) // in the AWS Key Management Service Developer Guide. // // See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/PutRecords @@ -2582,14 +2593,22 @@ func (c *Kinesis) RegisterStreamConsumerRequest(input *RegisterStreamConsumerInp // RegisterStreamConsumer API operation for Amazon Kinesis. // // Registers a consumer with a Kinesis data stream. When you use this operation, -// the consumer you register can read data from the stream at a rate of up to -// 2 MiB per second. This rate is unaffected by the total number of consumers -// that read from the same stream. +// the consumer you register can then call SubscribeToShard to receive data +// from the stream using enhanced fan-out, at a rate of up to 2 MiB per second +// for every shard you subscribe to. This rate is unaffected by the total number +// of consumers that read from the same stream. +// +// You can register up to 20 consumers per stream. A given consumer can only +// be registered with one stream at a time. // -// You can register up to 5 consumers per stream. A given consumer can only -// be registered with one stream. +// For an example of how to use this operations, see Enhanced Fan-Out Using +// the Kinesis Data Streams API (/streams/latest/dev/building-enhanced-consumers-api.html). // -// This operation has a limit of five transactions per second per account. +// The use of this operation has a limit of five transactions per second per +// account. Also, only 5 consumers can be created simultaneously. In other words, +// you cannot have more than 5 consumers in a CREATING status at the same time. +// Registering a 6th consumer while there are 5 in a CREATING status results +// in a LimitExceededException. // // 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 @@ -2795,7 +2814,7 @@ func (c *Kinesis) SplitShardRequest(input *SplitShardInput) (req *request.Reques // position in the shard where the shard gets split in two. In many cases, the // new hash key might be the average of the beginning and ending hash key, but // it can be any hash key value in the range being mapped into the shard. For -// more information, see Split a Shard (http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html) +// more information, see Split a Shard (https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html) // in the Amazon Kinesis Data Streams Developer Guide. // // You can use DescribeStream to determine the shard ID and hash key values @@ -2818,9 +2837,9 @@ func (c *Kinesis) SplitShardRequest(input *SplitShardInput) (req *request.Reques // receive a LimitExceededException. // // For the default shard limit for an AWS account, see Kinesis Data Streams -// Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) +// Limits (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, -// contact AWS Support (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html). +// contact AWS Support (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html). // // If you try to operate on too many streams simultaneously using CreateStream, // DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException. @@ -2969,7 +2988,7 @@ func (c *Kinesis) StartStreamEncryptionRequest(input *StartStreamEncryptionInput // * KMSInvalidStateException // The request was rejected because the state of the specified resource isn't // valid for this request. For more information, see How Key State Affects Use -// of a Customer Master Key (http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) // in the AWS Key Management Service Developer Guide. // // * KMSAccessDeniedException @@ -2985,7 +3004,7 @@ func (c *Kinesis) StartStreamEncryptionRequest(input *StartStreamEncryptionInput // // * KMSThrottlingException // The request was denied due to request throttling. For more information about -// throttling, see Limits (http://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) +// throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) // in the AWS Key Management Service Developer Guide. // // See also, https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/StartStreamEncryption @@ -3175,17 +3194,31 @@ func (c *Kinesis) SubscribeToShardRequest(input *SubscribeToShardInput) (req *re // SubscribeToShard API operation for Amazon Kinesis. // -// Call this operation from your consumer after you call RegisterStreamConsumer -// to register the consumer with Kinesis Data Streams. If the call succeeds, -// your consumer starts receiving events of type SubscribeToShardEvent for up -// to 5 minutes, after which time you need to call SubscribeToShard again to -// renew the subscription if you want to continue to receive records. +// This operation establishes an HTTP/2 connection between the consumer you +// specify in the ConsumerARN parameter and the shard you specify in the ShardId +// parameter. After the connection is successfully established, Kinesis Data +// Streams pushes records from the shard to the consumer over this connection. +// Before you call this operation, call RegisterStreamConsumer to register the +// consumer with Kinesis Data Streams. // -// You can make one call to SubscribeToShard per second per ConsumerARN. If -// your call succeeds, and then you call the operation again less than 5 seconds -// later, the second call generates a ResourceInUseException. If you call the -// operation a second time more than 5 seconds after the first call succeeds, -// the second call succeeds and the first connection gets shut down. +// When the SubscribeToShard call succeeds, your consumer starts receiving events +// of type SubscribeToShardEvent over the HTTP/2 connection for up to 5 minutes, +// after which time you need to call SubscribeToShard again to renew the subscription +// if you want to continue to receive records. +// +// You can make one call to SubscribeToShard per second per registered consumer +// per shard. For example, if you have a 4000 shard stream and two registered +// stream consumers, you can make one SubscribeToShard request per second for +// each combination of shard and registered consumer, allowing you to subscribe +// both consumers to all 4000 shards in one second. +// +// If you call SubscribeToShard again with the same ConsumerARN and ShardId +// within 5 seconds of a successful call, you'll get a ResourceInUseException. +// If you call SubscribeToShard 5 seconds or more after a successful call, the +// first connection will expire and the second call will take over the subscription. +// +// For an example of how to use this operations, see Enhanced Fan-Out Using +// the Kinesis Data Streams API (/streams/latest/dev/building-enhanced-consumers-api.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3494,13 +3527,18 @@ func (c *Kinesis) UpdateShardCountRequest(input *UpdateShardCountInput) (req *re // // To update the shard count, Kinesis Data Streams performs splits or merges // on individual shards. This can cause short-lived shards to be created, in -// addition to the final shards. We recommend that you double or halve the shard -// count, as this results in the fewest number of splits or merges. +// addition to the final shards. These short-lived shards count towards your +// total shard limit for your account in the Region. +// +// When using this operation, we recommend that you specify a target shard count +// that is a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target +// value within your shard limit. However, if you specify a target that isn't +// a multiple of 25%, the scaling action might take longer to complete. // // This operation has the following default limits. By default, you cannot do // the following: // -// * Scale more than twice per rolling 24-hour period per stream +// * Scale more than ten times per rolling 24-hour period per stream // // * Scale up to more than double your current shard count for a stream // @@ -3513,7 +3551,7 @@ func (c *Kinesis) UpdateShardCountRequest(input *UpdateShardCountInput) (req *re // // * Scale up to more than the shard limit for your account // -// For the default limits for an AWS account, see Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) +// For the default limits for an AWS account, see Streams Limits (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide. To request an increase // in the call rate limit, the shard limit for this API, or your overall shard // limit, use the limits form (https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&limitType=service-code-kinesis). @@ -3637,7 +3675,52 @@ func (s AddTagsToStreamOutput) GoString() string { return s.String() } -// An object that represents the details of the consumer you registered. +type ChildShard struct { + _ struct{} `type:"structure"` + + // The range of possible hash key values for the shard, which is a set of ordered + // contiguous positive integers. + // + // HashKeyRange is a required field + HashKeyRange *HashKeyRange `type:"structure" required:"true"` + + // ParentShards is a required field + ParentShards []*string `type:"list" required:"true"` + + // ShardId is a required field + ShardId *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s ChildShard) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ChildShard) GoString() string { + return s.String() +} + +// SetHashKeyRange sets the HashKeyRange field's value. +func (s *ChildShard) SetHashKeyRange(v *HashKeyRange) *ChildShard { + s.HashKeyRange = v + return s +} + +// SetParentShards sets the ParentShards field's value. +func (s *ChildShard) SetParentShards(v []*string) *ChildShard { + s.ParentShards = v + return s +} + +// SetShardId sets the ShardId field's value. +func (s *ChildShard) SetShardId(v string) *ChildShard { + s.ShardId = &v + return s +} + +// An object that represents the details of the consumer you registered. This +// type of object is returned by RegisterStreamConsumer. type Consumer struct { _ struct{} `type:"structure"` @@ -3700,7 +3783,8 @@ func (s *Consumer) SetConsumerStatus(v string) *Consumer { return s } -// An object that represents the details of a registered consumer. +// An object that represents the details of a registered consumer. This type +// of object is returned by DescribeStreamConsumer. type ConsumerDescription struct { _ struct{} `type:"structure"` @@ -3782,8 +3866,6 @@ type CreateStreamInput struct { // is a function of the number of shards; more shards are required for greater // provisioned throughput. // - // DefaultShardLimit; - // // ShardCount is a required field ShardCount *int64 `min:"1" type:"integer" required:"true"` @@ -3863,7 +3945,7 @@ type DecreaseStreamRetentionPeriodInput struct { // retention period. // // RetentionPeriodHours is a required field - RetentionPeriodHours *int64 `min:"1" type:"integer" required:"true"` + RetentionPeriodHours *int64 `type:"integer" required:"true"` // The name of the stream to modify. // @@ -3887,9 +3969,6 @@ func (s *DecreaseStreamRetentionPeriodInput) Validate() error { if s.RetentionPeriodHours == nil { invalidParams.Add(request.NewErrParamRequired("RetentionPeriodHours")) } - if s.RetentionPeriodHours != nil && *s.RetentionPeriodHours < 1 { - invalidParams.Add(request.NewErrParamMinValue("RetentionPeriodHours", 1)) - } if s.StreamName == nil { invalidParams.Add(request.NewErrParamRequired("StreamName")) } @@ -4399,7 +4478,7 @@ type DisableEnhancedMonitoringInput struct { // * ALL // // For more information, see Monitoring the Amazon Kinesis Data Streams Service - // with Amazon CloudWatch (http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html) + // with Amazon CloudWatch (https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html) // in the Amazon Kinesis Data Streams Developer Guide. // // ShardLevelMetrics is a required field @@ -4481,7 +4560,7 @@ type EnableEnhancedMonitoringInput struct { // * ALL // // For more information, see Monitoring the Amazon Kinesis Data Streams Service - // with Amazon CloudWatch (http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html) + // with Amazon CloudWatch (https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html) // in the Amazon Kinesis Data Streams Developer Guide. // // ShardLevelMetrics is a required field @@ -4563,7 +4642,7 @@ type EnhancedMetrics struct { // * ALL // // For more information, see Monitoring the Amazon Kinesis Data Streams Service - // with Amazon CloudWatch (http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html) + // with Amazon CloudWatch (https://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html) // in the Amazon Kinesis Data Streams Developer Guide. ShardLevelMetrics []*string `min:"1" type:"list"` } @@ -4747,6 +4826,7 @@ type GetRecordsInput struct { // The maximum number of records to return. Specify a value of up to 10,000. // If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException. + // The default value is 10,000. Limit *int64 `min:"1" type:"integer"` // The position in the shard from which you want to start sequentially reading @@ -4802,6 +4882,8 @@ func (s *GetRecordsInput) SetShardIterator(v string) *GetRecordsInput { type GetRecordsOutput struct { _ struct{} `type:"structure"` + ChildShards []*ChildShard `type:"list"` + // The number of milliseconds the GetRecords response is from the tip of the // stream, indicating how far behind current time the consumer is. A value of // zero indicates that record processing is caught up, and there are no new @@ -4829,6 +4911,12 @@ func (s GetRecordsOutput) GoString() string { return s.String() } +// SetChildShards sets the ChildShards field's value. +func (s *GetRecordsOutput) SetChildShards(v []*ChildShard) *GetRecordsOutput { + s.ChildShards = v + return s +} + // SetMillisBehindLatest sets the MillisBehindLatest field's value. func (s *GetRecordsOutput) SetMillisBehindLatest(v int64) *GetRecordsOutput { s.MillisBehindLatest = &v @@ -5035,7 +5123,7 @@ type IncreaseStreamRetentionPeriodInput struct { // retention period. // // RetentionPeriodHours is a required field - RetentionPeriodHours *int64 `min:"1" type:"integer" required:"true"` + RetentionPeriodHours *int64 `type:"integer" required:"true"` // The name of the stream to modify. // @@ -5059,9 +5147,6 @@ func (s *IncreaseStreamRetentionPeriodInput) Validate() error { if s.RetentionPeriodHours == nil { invalidParams.Add(request.NewErrParamRequired("RetentionPeriodHours")) } - if s.RetentionPeriodHours != nil && *s.RetentionPeriodHours < 1 { - invalidParams.Add(request.NewErrParamMinValue("RetentionPeriodHours", 1)) - } if s.StreamName == nil { invalidParams.Add(request.NewErrParamRequired("StreamName")) } @@ -5101,6 +5186,8 @@ func (s IncreaseStreamRetentionPeriodOutput) GoString() string { return s.String() } +// The processing of the request failed because of an unknown error, exception, +// or failure. type InternalFailureException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -5419,7 +5506,7 @@ func (s *KMSDisabledException) RequestID() string { // The request was rejected because the state of the specified resource isn't // valid for this request. For more information, see How Key State Affects Use -// of a Customer Master Key (http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) +// of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) // in the AWS Key Management Service Developer Guide. type KMSInvalidStateException struct { _ struct{} `type:"structure"` @@ -5680,7 +5767,7 @@ func (s *KMSOptInRequired) RequestID() string { } // The request was denied due to request throttling. For more information about -// throttling, see Limits (http://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) +// throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) // in the AWS Key Management Service Developer Guide. type KMSThrottlingException struct { _ struct{} `type:"structure"` @@ -5839,7 +5926,7 @@ type ListShardsInput struct { // The maximum number of shards to return in a single call to ListShards. The // minimum value you can specify for this parameter is 1, and the maximum is - // 1,000, which is also the default. + // 10,000, which is also the default. // // When the number of shards to be listed is greater than the value of MaxResults, // the response contains a NextToken value that you can use in a subsequent @@ -5867,6 +5954,8 @@ type ListShardsInput struct { // If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException. NextToken *string `min:"1" type:"string"` + ShardFilter *ShardFilter `type:"structure"` + // Specify this input parameter to distinguish data streams that have the same // name. For example, if you create a data stream and then delete it, and you // later create another data stream with the same name, you can use this input @@ -5907,6 +5996,11 @@ func (s *ListShardsInput) Validate() error { if s.StreamName != nil && len(*s.StreamName) < 1 { invalidParams.Add(request.NewErrParamMinLen("StreamName", 1)) } + if s.ShardFilter != nil { + if err := s.ShardFilter.Validate(); err != nil { + invalidParams.AddNested("ShardFilter", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -5932,6 +6026,12 @@ func (s *ListShardsInput) SetNextToken(v string) *ListShardsInput { return s } +// SetShardFilter sets the ShardFilter field's value. +func (s *ListShardsInput) SetShardFilter(v *ShardFilter) *ListShardsInput { + s.ShardFilter = v + return s +} + // SetStreamCreationTimestamp sets the StreamCreationTimestamp field's value. func (s *ListShardsInput) SetStreamCreationTimestamp(v time.Time) *ListShardsInput { s.StreamCreationTimestamp = &v @@ -6423,9 +6523,9 @@ func (s MergeShardsOutput) GoString() string { // The request rate for the stream is too high, or the requested data is too // large for the available throughput. Reduce the frequency or size of your -// requests. For more information, see Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) +// requests. For more information, see Streams Limits (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and -// Exponential Backoff in AWS (http://docs.aws.amazon.com/general/latest/gr/api-retries.html) +// Exponential Backoff in AWS (https://docs.aws.amazon.com/general/latest/gr/api-retries.html) // in the AWS General Reference. type ProvisionedThroughputExceededException struct { _ struct{} `type:"structure"` @@ -6490,7 +6590,7 @@ type PutRecordInput struct { // The data blob to put into the record, which is base64-encoded when the blob // is serialized. When the data blob (the payload before base64-encoding) is // added to the partition key size, the total size must not exceed the maximum - // record size (1 MB). + // record size (1 MiB). // // Data is automatically base64 encoded/decoded by the SDK. // @@ -6776,7 +6876,7 @@ type PutRecordsRequestEntry struct { // The data blob to put into the record, which is base64-encoded when the blob // is serialized. When the data blob (the payload before base64-encoding) is // added to the partition key size, the total size must not exceed the maximum - // record size (1 MB). + // record size (1 MiB). // // Data is automatically base64 encoded/decoded by the SDK. // @@ -6917,7 +7017,7 @@ type Record struct { // Data Streams, which does not inspect, interpret, or change the data in the // blob in any way. When the data blob (the payload before base64-encoding) // is added to the partition key size, the total size must not exceed the maximum - // record size (1 MB). + // record size (1 MiB). // // Data is automatically base64 encoded/decoded by the SDK. // @@ -7422,6 +7522,61 @@ func (s *Shard) SetShardId(v string) *Shard { return s } +type ShardFilter struct { + _ struct{} `type:"structure"` + + ShardId *string `min:"1" type:"string"` + + Timestamp *time.Time `type:"timestamp"` + + // Type is a required field + Type *string `type:"string" required:"true" enum:"ShardFilterType"` +} + +// String returns the string representation +func (s ShardFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ShardFilter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ShardFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ShardFilter"} + if s.ShardId != nil && len(*s.ShardId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ShardId", 1)) + } + if s.Type == nil { + invalidParams.Add(request.NewErrParamRequired("Type")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetShardId sets the ShardId field's value. +func (s *ShardFilter) SetShardId(v string) *ShardFilter { + s.ShardId = &v + return s +} + +// SetTimestamp sets the Timestamp field's value. +func (s *ShardFilter) SetTimestamp(v time.Time) *ShardFilter { + s.Timestamp = &v + return s +} + +// SetType sets the Type field's value. +func (s *ShardFilter) SetType(v string) *ShardFilter { + s.Type = &v + return s +} + // Represents the input for SplitShard. type SplitShardInput struct { _ struct{} `type:"structure"` @@ -7618,10 +7773,37 @@ func (s StartStreamEncryptionOutput) GoString() string { type StartingPosition struct { _ struct{} `type:"structure"` + // The sequence number of the data record in the shard from which to start streaming. + // To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER + // or AFTER_SEQUENCE_NUMBER. SequenceNumber *string `type:"string"` + // The time stamp of the data record from which to start reading. To specify + // a time stamp, set StartingPosition to Type AT_TIMESTAMP. A time stamp is + // the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 + // or 1459799926.480. If a record with this exact time stamp does not exist, + // records will be streamed from the next (later) record. If the time stamp + // is older than the current trim horizon, records will be streamed from the + // oldest untrimmed data record (TRIM_HORIZON). Timestamp *time.Time `type:"timestamp"` + // You can set the starting position to one of the following values: + // + // AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the sequence + // number specified in the SequenceNumber field. + // + // AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by + // the sequence number specified in the SequenceNumber field. + // + // AT_TIMESTAMP: Start streaming from the position denoted by the time stamp + // specified in the Timestamp field. + // + // TRIM_HORIZON: Start streaming at the last untrimmed record in the shard, + // which is the oldest data record in the shard. + // + // LATEST: Start streaming just after the most recent record in the shard, so + // that you always read the most recent data in the shard. + // // Type is a required field Type *string `type:"string" required:"true" enum:"ShardIteratorType"` } @@ -7806,10 +7988,11 @@ type StreamDescription struct { // * Master key owned by Kinesis Data Streams: alias/aws/kinesis KeyId *string `min:"1" type:"string"` - // The current retention period, in hours. + // The current retention period, in hours. Minimum value of 24. Maximum value + // of 168. // // RetentionPeriodHours is a required field - RetentionPeriodHours *int64 `min:"1" type:"integer" required:"true"` + RetentionPeriodHours *int64 `type:"integer" required:"true"` // The shards that comprise the stream. // @@ -7965,7 +8148,7 @@ type StreamDescriptionSummary struct { // The current retention period, in hours. // // RetentionPeriodHours is a required field - RetentionPeriodHours *int64 `min:"1" type:"integer" required:"true"` + RetentionPeriodHours *int64 `type:"integer" required:"true"` // The Amazon Resource Name (ARN) for the stream being described. // @@ -8074,11 +8257,16 @@ func (s *StreamDescriptionSummary) SetStreamStatus(v string) *StreamDescriptionS } // After you call SubscribeToShard, Kinesis Data Streams sends events of this -// type to your consumer. +// type over an HTTP/2 connection to your consumer. type SubscribeToShardEvent struct { _ struct{} `type:"structure"` - // Use this as StartingSequenceNumber in the next call to SubscribeToShard. + ChildShards []*ChildShard `type:"list"` + + // Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition + // set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber + // for checkpointing because it captures your shard progress even when no data + // is written to the shard. // // ContinuationSequenceNumber is a required field ContinuationSequenceNumber *string `type:"string" required:"true"` @@ -8105,6 +8293,12 @@ func (s SubscribeToShardEvent) GoString() string { return s.String() } +// SetChildShards sets the ChildShards field's value. +func (s *SubscribeToShardEvent) SetChildShards(v []*ChildShard) *SubscribeToShardEvent { + s.ChildShards = v + return s +} + // SetContinuationSequenceNumber sets the ContinuationSequenceNumber field's value. func (s *SubscribeToShardEvent) SetContinuationSequenceNumber(v string) *SubscribeToShardEvent { s.ContinuationSequenceNumber = &v @@ -8507,7 +8701,19 @@ type UpdateShardCountInput struct { // StreamName is a required field StreamName *string `min:"1" type:"string" required:"true"` - // The new number of shards. + // The new number of shards. This value has the following default limits. By + // default, you cannot do the following: + // + // * Set this value to more than double your current shard count for a stream. + // + // * Set this value below half your current shard count for a stream. + // + // * Set this value to more than 500 shards in a stream (the default limit + // for shard count per stream is 500 per account per region), unless you + // request a limit increase. + // + // * Scale a stream with more than 500 shards down unless you set this value + // to less than 500 shards. // // TargetShardCount is a required field TargetShardCount *int64 `min:"1" type:"integer" required:"true"` @@ -8695,6 +8901,38 @@ func ScalingType_Values() []string { } } +const ( + // ShardFilterTypeAfterShardId is a ShardFilterType enum value + ShardFilterTypeAfterShardId = "AFTER_SHARD_ID" + + // ShardFilterTypeAtTrimHorizon is a ShardFilterType enum value + ShardFilterTypeAtTrimHorizon = "AT_TRIM_HORIZON" + + // ShardFilterTypeFromTrimHorizon is a ShardFilterType enum value + ShardFilterTypeFromTrimHorizon = "FROM_TRIM_HORIZON" + + // ShardFilterTypeAtLatest is a ShardFilterType enum value + ShardFilterTypeAtLatest = "AT_LATEST" + + // ShardFilterTypeAtTimestamp is a ShardFilterType enum value + ShardFilterTypeAtTimestamp = "AT_TIMESTAMP" + + // ShardFilterTypeFromTimestamp is a ShardFilterType enum value + ShardFilterTypeFromTimestamp = "FROM_TIMESTAMP" +) + +// ShardFilterType_Values returns all elements of the ShardFilterType enum +func ShardFilterType_Values() []string { + return []string{ + ShardFilterTypeAfterShardId, + ShardFilterTypeAtTrimHorizon, + ShardFilterTypeFromTrimHorizon, + ShardFilterTypeAtLatest, + ShardFilterTypeAtTimestamp, + ShardFilterTypeFromTimestamp, + } +} + const ( // ShardIteratorTypeAtSequenceNumber is a ShardIteratorType enum value ShardIteratorTypeAtSequenceNumber = "AT_SEQUENCE_NUMBER" diff --git a/service/kinesis/errors.go b/service/kinesis/errors.go index ba7c89dbae..da7880ee58 100644 --- a/service/kinesis/errors.go +++ b/service/kinesis/errors.go @@ -22,6 +22,9 @@ const ( // ErrCodeInternalFailureException for service response error code // "InternalFailureException". + // + // The processing of the request failed because of an unknown error, exception, + // or failure. ErrCodeInternalFailureException = "InternalFailureException" // ErrCodeInvalidArgumentException for service response error code @@ -50,7 +53,7 @@ const ( // // The request was rejected because the state of the specified resource isn't // valid for this request. For more information, see How Key State Affects Use - // of a Customer Master Key (http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) + // of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) // in the AWS Key Management Service Developer Guide. ErrCodeKMSInvalidStateException = "KMSInvalidStateException" @@ -71,7 +74,7 @@ const ( // "KMSThrottlingException". // // The request was denied due to request throttling. For more information about - // throttling, see Limits (http://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) + // throttling, see Limits (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) // in the AWS Key Management Service Developer Guide. ErrCodeKMSThrottlingException = "KMSThrottlingException" @@ -87,9 +90,9 @@ const ( // // The request rate for the stream is too high, or the requested data is too // large for the available throughput. Reduce the frequency or size of your - // requests. For more information, see Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) + // requests. For more information, see Streams Limits (https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) // in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and - // Exponential Backoff in AWS (http://docs.aws.amazon.com/general/latest/gr/api-retries.html) + // Exponential Backoff in AWS (https://docs.aws.amazon.com/general/latest/gr/api-retries.html) // in the AWS General Reference. ErrCodeProvisionedThroughputExceededException = "ProvisionedThroughputExceededException" diff --git a/service/kinesis/eventstream_test.go b/service/kinesis/eventstream_test.go index d3d6cdf716..8023745851 100644 --- a/service/kinesis/eventstream_test.go +++ b/service/kinesis/eventstream_test.go @@ -228,6 +228,44 @@ func mockSubscribeToShardReadEvents() ( expectEvents := []SubscribeToShardEventStreamEvent{ &SubscribeToShardOutput{}, &SubscribeToShardEvent{ + ChildShards: []*ChildShard{ + { + HashKeyRange: &HashKeyRange{ + EndingHashKey: aws.String("string value goes here"), + StartingHashKey: aws.String("string value goes here"), + }, + ParentShards: []*string{ + aws.String("string value goes here"), + aws.String("string value goes here"), + aws.String("string value goes here"), + }, + ShardId: aws.String("string value goes here"), + }, + { + HashKeyRange: &HashKeyRange{ + EndingHashKey: aws.String("string value goes here"), + StartingHashKey: aws.String("string value goes here"), + }, + ParentShards: []*string{ + aws.String("string value goes here"), + aws.String("string value goes here"), + aws.String("string value goes here"), + }, + ShardId: aws.String("string value goes here"), + }, + { + HashKeyRange: &HashKeyRange{ + EndingHashKey: aws.String("string value goes here"), + StartingHashKey: aws.String("string value goes here"), + }, + ParentShards: []*string{ + aws.String("string value goes here"), + aws.String("string value goes here"), + aws.String("string value goes here"), + }, + ShardId: aws.String("string value goes here"), + }, + }, ContinuationSequenceNumber: aws.String("string value goes here"), MillisBehindLatest: aws.Int64(1234), Records: []*Record{ diff --git a/service/quicksight/api.go b/service/quicksight/api.go index ff3d6ef6af..e2bb9a7725 100644 --- a/service/quicksight/api.go +++ b/service/quicksight/api.go @@ -154,8 +154,22 @@ func (c *QuickSight) CreateAccountCustomizationRequest(input *CreateAccountCusto // CreateAccountCustomization API operation for Amazon QuickSight. // -// Creates a customization for the Amazon QuickSight subscription associated -// with your AWS account. +// Creates Amazon QuickSight customizations the current AWS Region. Currently, +// you can add a custom default theme by using the CreateAccountCustomization +// or UpdateAccountCustomization API operation. To further customize QuickSight +// by removing QuickSight sample assets and videos for all new users, see Customizing +// QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html) +// in the Amazon QuickSight User Guide. +// +// You can create customizations for your AWS account or, if you specify a namespace, +// for a QuickSight namespace instead. Customizations that apply to a namespace +// always override customizations that apply to an AWS account. To find out +// which customizations apply, use the DescribeAccountCustomization API operation. +// +// Before you add a theme as the namespace default, make sure that you first +// share the theme with the namespace. If you don't share it with the namespace, +// the theme won't be visible to your users even if you use this API operation +// to make it the default theme. // // 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 @@ -212,6 +226,106 @@ func (c *QuickSight) CreateAccountCustomizationWithContext(ctx aws.Context, inpu return out, req.Send() } +const opCreateAnalysis = "CreateAnalysis" + +// CreateAnalysisRequest generates a "aws/request.Request" representing the +// client's request for the CreateAnalysis 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 CreateAnalysis for more information on using the CreateAnalysis +// 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 CreateAnalysisRequest method. +// req, resp := client.CreateAnalysisRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysis +func (c *QuickSight) CreateAnalysisRequest(input *CreateAnalysisInput) (req *request.Request, output *CreateAnalysisOutput) { + op := &request.Operation{ + Name: opCreateAnalysis, + HTTPMethod: "POST", + HTTPPath: "/accounts/{AwsAccountId}/analyses/{AnalysisId}", + } + + if input == nil { + input = &CreateAnalysisInput{} + } + + output = &CreateAnalysisOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateAnalysis API operation for Amazon QuickSight. +// +// Creates an analysis in Amazon QuickSight. +// +// 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 QuickSight's +// API operation CreateAnalysis for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * ThrottlingException +// Access is throttled. +// +// * ResourceExistsException +// The resource specified already exists. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysis +func (c *QuickSight) CreateAnalysis(input *CreateAnalysisInput) (*CreateAnalysisOutput, error) { + req, out := c.CreateAnalysisRequest(input) + return out, req.Send() +} + +// CreateAnalysisWithContext is the same as CreateAnalysis with the addition of +// the ability to pass a context and additional request options. +// +// See CreateAnalysis 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 *QuickSight) CreateAnalysisWithContext(ctx aws.Context, input *CreateAnalysisInput, opts ...request.Option) (*CreateAnalysisOutput, error) { + req, out := c.CreateAnalysisRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateDashboard = "CreateDashboard" // CreateDashboardRequest generates a "aws/request.Request" representing the @@ -261,10 +375,9 @@ func (c *QuickSight) CreateDashboardRequest(input *CreateDashboardInput) (req *r // // A dashboard is an entity in QuickSight that identifies QuickSight reports, // created from analyses. You can share QuickSight dashboards. With the right -// permissions, you can create scheduled email reports from them. The CreateDashboard, -// DescribeDashboard, and ListDashboardsByUser API operations act on the dashboard -// entity. If you have the correct permissions, you can create a dashboard from -// a template that exists in a different AWS account. +// permissions, you can create scheduled email reports from them. If you have +// the correct permissions, you can create a dashboard from a template that +// exists in a different AWS account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -822,8 +935,8 @@ func (c *QuickSight) CreateIAMPolicyAssignmentRequest(input *CreateIAMPolicyAssi // Access is throttled. // // * ConcurrentUpdatingException -// A resource is already in a state that indicates an action is happening that -// must complete before a new update can be applied. +// A resource is already in a state that indicates an operation is happening +// that must complete before a new update can be applied. // // * InternalFailureException // An internal failure occurred. @@ -1556,7 +1669,8 @@ func (c *QuickSight) DeleteAccountCustomizationRequest(input *DeleteAccountCusto // DeleteAccountCustomization API operation for Amazon QuickSight. // -// Deletes customizations for the QuickSight subscription on your AWS account. +// Deletes all Amazon QuickSight customizations in this AWS Region for the specified +// AWS Account and QuickSight namespace. // // 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 @@ -1610,6 +1724,117 @@ func (c *QuickSight) DeleteAccountCustomizationWithContext(ctx aws.Context, inpu return out, req.Send() } +const opDeleteAnalysis = "DeleteAnalysis" + +// DeleteAnalysisRequest generates a "aws/request.Request" representing the +// client's request for the DeleteAnalysis 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 DeleteAnalysis for more information on using the DeleteAnalysis +// 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 DeleteAnalysisRequest method. +// req, resp := client.DeleteAnalysisRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAnalysis +func (c *QuickSight) DeleteAnalysisRequest(input *DeleteAnalysisInput) (req *request.Request, output *DeleteAnalysisOutput) { + op := &request.Operation{ + Name: opDeleteAnalysis, + HTTPMethod: "DELETE", + HTTPPath: "/accounts/{AwsAccountId}/analyses/{AnalysisId}", + } + + if input == nil { + input = &DeleteAnalysisInput{} + } + + output = &DeleteAnalysisOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteAnalysis API operation for Amazon QuickSight. +// +// Deletes an analysis from Amazon QuickSight. You can optionally include a +// recovery window during which you can restore the analysis. If you don't specify +// a recovery window value, the operation defaults to 30 days. QuickSight attaches +// a DeletionTime stamp to the response that specifies the end of the recovery +// window. At the end of the recovery window, QuickSight deletes the analysis +// permanently. +// +// At any time before recovery window ends, you can use the RestoreAnalysis +// API operation to remove the DeletionTime stamp and cancel the deletion of +// the analysis. The analysis remains visible in the API until it's deleted, +// so you can describe it but you can't make a template from it. +// +// An analysis that's scheduled for deletion isn't accessible in the QuickSight +// console. To access it in the console, restore it. Deleting an analysis doesn't +// delete the dashboards that you publish from it. +// +// 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 QuickSight's +// API operation DeleteAnalysis for usage and error information. +// +// Returned Error Types: +// * ThrottlingException +// Access is throttled. +// +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAnalysis +func (c *QuickSight) DeleteAnalysis(input *DeleteAnalysisInput) (*DeleteAnalysisOutput, error) { + req, out := c.DeleteAnalysisRequest(input) + return out, req.Send() +} + +// DeleteAnalysisWithContext is the same as DeleteAnalysis with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteAnalysis 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 *QuickSight) DeleteAnalysisWithContext(ctx aws.Context, input *DeleteAnalysisInput, opts ...request.Option) (*DeleteAnalysisOutput, error) { + req, out := c.DeleteAnalysisRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteDashboard = "DeleteDashboard" // DeleteDashboardRequest generates a "aws/request.Request" representing the @@ -1846,7 +2071,7 @@ func (c *QuickSight) DeleteDataSourceRequest(input *DeleteDataSourceInput) (req // DeleteDataSource API operation for Amazon QuickSight. // -// Deletes the data source permanently. This action breaks all the datasets +// Deletes the data source permanently. This operation breaks all the datasets // that reference the deleted data source. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2175,8 +2400,8 @@ func (c *QuickSight) DeleteIAMPolicyAssignmentRequest(input *DeleteIAMPolicyAssi // Access is throttled. // // * ConcurrentUpdatingException -// A resource is already in a state that indicates an action is happening that -// must complete before a new update can be applied. +// A resource is already in a state that indicates an operation is happening +// that must complete before a new update can be applied. // // * InternalFailureException // An internal failure occurred. @@ -2250,7 +2475,7 @@ func (c *QuickSight) DeleteNamespaceRequest(input *DeleteNamespaceInput) (req *r // Deletes a namespace and the users and groups that are associated with the // namespace. This is an asynchronous process. Assets including dashboards, // analyses, datasets and data sources are not deleted. To delete these assets, -// you use the APIs for the relevant asset. +// you use the API operations for the relevant asset. // // 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 @@ -2954,7 +3179,46 @@ func (c *QuickSight) DescribeAccountCustomizationRequest(input *DescribeAccountC // DescribeAccountCustomization API operation for Amazon QuickSight. // -// Describes the customizations associated with your AWS account. +// Describes the customizations associated with the provided AWS account and +// Amazon QuickSight namespace in an AWS Region. The QuickSight console evaluates +// which customizations to apply by running this API operation with the Resolved +// flag included. +// +// To determine what customizations display when you run this command, it can +// help to visualize the relationship of the entities involved. +// +// * AWS Account - The AWS account exists at the top of the hierarchy. It +// has the potential to use all of the AWS Regions and AWS Services. When +// you subscribe to QuickSight, you choose one AWS Region to use as your +// home region. That's where your free SPICE capacity is located. You can +// use QuickSight in any supported AWS Region. +// +// * AWS Region - In each AWS Region where you sign in to QuickSight at least +// once, QuickSight acts as a separate instance of the same service. If you +// have a user directory, it resides in us-east-1, which is the US East (N. +// Virginia). Generally speaking, these users have access to QuickSight in +// any AWS Region, unless they are constrained to a namespace. To run the +// command in a different AWS Region, you change your region settings. If +// you're using the AWS CLI, you can use one of the following options: Use +// command line options (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html). +// Use named profiles (https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). +// Run aws configure to change your default AWS Region. Use Enter to key +// the same settings for your keys. For more information, see Configuring +// the AWS CLI (https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html). +// +// * Namespace - A QuickSight namespace is a partition that contains users +// and assets (data sources, datasets, dashboards, and so on). To access +// assets that are in a specific namespace, users and groups must also be +// part of the same namespace. People who share a namespace are completely +// isolated from users and assets in other namespaces, even if they are in +// the same AWS account and AWS Region. +// +// * Applied customizations - Within an AWS Region, a set of QuickSight customizations +// can apply to an AWS account or to a namespace. Settings that you apply +// to a namespace override settings that you apply to an AWS Account. All +// settings are isolated to a single AWS Region. To apply them in other AWS +// Regions, run the CreateAccountCustomization command in each AWS Region +// where you want to apply the same customizations. // // 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 @@ -3107,58 +3371,58 @@ func (c *QuickSight) DescribeAccountSettingsWithContext(ctx aws.Context, input * return out, req.Send() } -const opDescribeDashboard = "DescribeDashboard" +const opDescribeAnalysis = "DescribeAnalysis" -// DescribeDashboardRequest generates a "aws/request.Request" representing the -// client's request for the DescribeDashboard operation. The "output" return +// DescribeAnalysisRequest generates a "aws/request.Request" representing the +// client's request for the DescribeAnalysis 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 DescribeDashboard for more information on using the DescribeDashboard +// See DescribeAnalysis for more information on using the DescribeAnalysis // 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 DescribeDashboardRequest method. -// req, resp := client.DescribeDashboardRequest(params) +// // Example sending a request using the DescribeAnalysisRequest method. +// req, resp := client.DescribeAnalysisRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboard -func (c *QuickSight) DescribeDashboardRequest(input *DescribeDashboardInput) (req *request.Request, output *DescribeDashboardOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysis +func (c *QuickSight) DescribeAnalysisRequest(input *DescribeAnalysisInput) (req *request.Request, output *DescribeAnalysisOutput) { op := &request.Operation{ - Name: opDescribeDashboard, + Name: opDescribeAnalysis, HTTPMethod: "GET", - HTTPPath: "/accounts/{AwsAccountId}/dashboards/{DashboardId}", + HTTPPath: "/accounts/{AwsAccountId}/analyses/{AnalysisId}", } if input == nil { - input = &DescribeDashboardInput{} + input = &DescribeAnalysisInput{} } - output = &DescribeDashboardOutput{} + output = &DescribeAnalysisOutput{} req = c.newRequest(op, input, output) return } -// DescribeDashboard API operation for Amazon QuickSight. +// DescribeAnalysis API operation for Amazon QuickSight. // -// Provides a summary for a dashboard. +// Provides a summary of the metadata for an analysis. // // 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 QuickSight's -// API operation DescribeDashboard for usage and error information. +// API operation DescribeAnalysis for usage and error information. // // Returned Error Types: // * InvalidParameterValueException @@ -3186,80 +3450,80 @@ func (c *QuickSight) DescribeDashboardRequest(input *DescribeDashboardInput) (re // * InternalFailureException // An internal failure occurred. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboard -func (c *QuickSight) DescribeDashboard(input *DescribeDashboardInput) (*DescribeDashboardOutput, error) { - req, out := c.DescribeDashboardRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysis +func (c *QuickSight) DescribeAnalysis(input *DescribeAnalysisInput) (*DescribeAnalysisOutput, error) { + req, out := c.DescribeAnalysisRequest(input) return out, req.Send() } -// DescribeDashboardWithContext is the same as DescribeDashboard with the addition of +// DescribeAnalysisWithContext is the same as DescribeAnalysis with the addition of // the ability to pass a context and additional request options. // -// See DescribeDashboard for details on how to use this API operation. +// See DescribeAnalysis 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 *QuickSight) DescribeDashboardWithContext(ctx aws.Context, input *DescribeDashboardInput, opts ...request.Option) (*DescribeDashboardOutput, error) { - req, out := c.DescribeDashboardRequest(input) +func (c *QuickSight) DescribeAnalysisWithContext(ctx aws.Context, input *DescribeAnalysisInput, opts ...request.Option) (*DescribeAnalysisOutput, error) { + req, out := c.DescribeAnalysisRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeDashboardPermissions = "DescribeDashboardPermissions" +const opDescribeAnalysisPermissions = "DescribeAnalysisPermissions" -// DescribeDashboardPermissionsRequest generates a "aws/request.Request" representing the -// client's request for the DescribeDashboardPermissions operation. The "output" return +// DescribeAnalysisPermissionsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeAnalysisPermissions 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 DescribeDashboardPermissions for more information on using the DescribeDashboardPermissions +// See DescribeAnalysisPermissions for more information on using the DescribeAnalysisPermissions // 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 DescribeDashboardPermissionsRequest method. -// req, resp := client.DescribeDashboardPermissionsRequest(params) +// // Example sending a request using the DescribeAnalysisPermissionsRequest method. +// req, resp := client.DescribeAnalysisPermissionsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissions -func (c *QuickSight) DescribeDashboardPermissionsRequest(input *DescribeDashboardPermissionsInput) (req *request.Request, output *DescribeDashboardPermissionsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisPermissions +func (c *QuickSight) DescribeAnalysisPermissionsRequest(input *DescribeAnalysisPermissionsInput) (req *request.Request, output *DescribeAnalysisPermissionsOutput) { op := &request.Operation{ - Name: opDescribeDashboardPermissions, + Name: opDescribeAnalysisPermissions, HTTPMethod: "GET", - HTTPPath: "/accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions", + HTTPPath: "/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions", } if input == nil { - input = &DescribeDashboardPermissionsInput{} + input = &DescribeAnalysisPermissionsInput{} } - output = &DescribeDashboardPermissionsOutput{} + output = &DescribeAnalysisPermissionsOutput{} req = c.newRequest(op, input, output) return } -// DescribeDashboardPermissions API operation for Amazon QuickSight. +// DescribeAnalysisPermissions API operation for Amazon QuickSight. // -// Describes read and write permissions for a dashboard. +// Provides the read and write permissions for an analysis. // // 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 QuickSight's -// API operation DescribeDashboardPermissions for usage and error information. +// API operation DescribeAnalysisPermissions for usage and error information. // // Returned Error Types: // * InvalidParameterValueException @@ -3280,82 +3544,88 @@ func (c *QuickSight) DescribeDashboardPermissionsRequest(input *DescribeDashboar // * InternalFailureException // An internal failure occurred. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissions -func (c *QuickSight) DescribeDashboardPermissions(input *DescribeDashboardPermissionsInput) (*DescribeDashboardPermissionsOutput, error) { - req, out := c.DescribeDashboardPermissionsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisPermissions +func (c *QuickSight) DescribeAnalysisPermissions(input *DescribeAnalysisPermissionsInput) (*DescribeAnalysisPermissionsOutput, error) { + req, out := c.DescribeAnalysisPermissionsRequest(input) return out, req.Send() } -// DescribeDashboardPermissionsWithContext is the same as DescribeDashboardPermissions with the addition of +// DescribeAnalysisPermissionsWithContext is the same as DescribeAnalysisPermissions with the addition of // the ability to pass a context and additional request options. // -// See DescribeDashboardPermissions for details on how to use this API operation. +// See DescribeAnalysisPermissions 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 *QuickSight) DescribeDashboardPermissionsWithContext(ctx aws.Context, input *DescribeDashboardPermissionsInput, opts ...request.Option) (*DescribeDashboardPermissionsOutput, error) { - req, out := c.DescribeDashboardPermissionsRequest(input) +func (c *QuickSight) DescribeAnalysisPermissionsWithContext(ctx aws.Context, input *DescribeAnalysisPermissionsInput, opts ...request.Option) (*DescribeAnalysisPermissionsOutput, error) { + req, out := c.DescribeAnalysisPermissionsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeDataSet = "DescribeDataSet" +const opDescribeDashboard = "DescribeDashboard" -// DescribeDataSetRequest generates a "aws/request.Request" representing the -// client's request for the DescribeDataSet operation. The "output" return +// DescribeDashboardRequest generates a "aws/request.Request" representing the +// client's request for the DescribeDashboard 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 DescribeDataSet for more information on using the DescribeDataSet +// See DescribeDashboard for more information on using the DescribeDashboard // 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 DescribeDataSetRequest method. -// req, resp := client.DescribeDataSetRequest(params) +// // Example sending a request using the DescribeDashboardRequest method. +// req, resp := client.DescribeDashboardRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSet -func (c *QuickSight) DescribeDataSetRequest(input *DescribeDataSetInput) (req *request.Request, output *DescribeDataSetOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboard +func (c *QuickSight) DescribeDashboardRequest(input *DescribeDashboardInput) (req *request.Request, output *DescribeDashboardOutput) { op := &request.Operation{ - Name: opDescribeDataSet, + Name: opDescribeDashboard, HTTPMethod: "GET", - HTTPPath: "/accounts/{AwsAccountId}/data-sets/{DataSetId}", + HTTPPath: "/accounts/{AwsAccountId}/dashboards/{DashboardId}", } if input == nil { - input = &DescribeDataSetInput{} + input = &DescribeDashboardInput{} } - output = &DescribeDataSetOutput{} + output = &DescribeDashboardOutput{} req = c.newRequest(op, input, output) return } -// DescribeDataSet API operation for Amazon QuickSight. +// DescribeDashboard API operation for Amazon QuickSight. // -// Describes a dataset. +// Provides a summary for a dashboard. // // 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 QuickSight's -// API operation DescribeDataSet for usage and error information. +// API operation DescribeDashboard for usage and error information. // // Returned Error Types: +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// // * AccessDeniedException // You don't have access to this item. The provided credentials couldn't be // validated. You might not be authorized to carry out the request. Make sure @@ -3363,25 +3633,214 @@ func (c *QuickSight) DescribeDataSetRequest(input *DescribeDataSetInput) (req *r // your policies have the correct permissions, and that you are using the correct // access keys. // -// * InvalidParameterValueException -// One or more parameters has a value that isn't valid. -// // * ThrottlingException // Access is throttled. // -// * ResourceNotFoundException -// One or more resources can't be found. +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. // // * InternalFailureException // An internal failure occurred. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSet -func (c *QuickSight) DescribeDataSet(input *DescribeDataSetInput) (*DescribeDataSetOutput, error) { - req, out := c.DescribeDataSetRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboard +func (c *QuickSight) DescribeDashboard(input *DescribeDashboardInput) (*DescribeDashboardOutput, error) { + req, out := c.DescribeDashboardRequest(input) return out, req.Send() } -// DescribeDataSetWithContext is the same as DescribeDataSet with the addition of +// DescribeDashboardWithContext is the same as DescribeDashboard with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeDashboard 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 *QuickSight) DescribeDashboardWithContext(ctx aws.Context, input *DescribeDashboardInput, opts ...request.Option) (*DescribeDashboardOutput, error) { + req, out := c.DescribeDashboardRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeDashboardPermissions = "DescribeDashboardPermissions" + +// DescribeDashboardPermissionsRequest generates a "aws/request.Request" representing the +// client's request for the DescribeDashboardPermissions 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 DescribeDashboardPermissions for more information on using the DescribeDashboardPermissions +// 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 DescribeDashboardPermissionsRequest method. +// req, resp := client.DescribeDashboardPermissionsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissions +func (c *QuickSight) DescribeDashboardPermissionsRequest(input *DescribeDashboardPermissionsInput) (req *request.Request, output *DescribeDashboardPermissionsOutput) { + op := &request.Operation{ + Name: opDescribeDashboardPermissions, + HTTPMethod: "GET", + HTTPPath: "/accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions", + } + + if input == nil { + input = &DescribeDashboardPermissionsInput{} + } + + output = &DescribeDashboardPermissionsOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeDashboardPermissions API operation for Amazon QuickSight. +// +// Describes read and write permissions for a dashboard. +// +// 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 QuickSight's +// API operation DescribeDashboardPermissions for usage and error information. +// +// Returned Error Types: +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ThrottlingException +// Access is throttled. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissions +func (c *QuickSight) DescribeDashboardPermissions(input *DescribeDashboardPermissionsInput) (*DescribeDashboardPermissionsOutput, error) { + req, out := c.DescribeDashboardPermissionsRequest(input) + return out, req.Send() +} + +// DescribeDashboardPermissionsWithContext is the same as DescribeDashboardPermissions with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeDashboardPermissions 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 *QuickSight) DescribeDashboardPermissionsWithContext(ctx aws.Context, input *DescribeDashboardPermissionsInput, opts ...request.Option) (*DescribeDashboardPermissionsOutput, error) { + req, out := c.DescribeDashboardPermissionsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeDataSet = "DescribeDataSet" + +// DescribeDataSetRequest generates a "aws/request.Request" representing the +// client's request for the DescribeDataSet 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 DescribeDataSet for more information on using the DescribeDataSet +// 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 DescribeDataSetRequest method. +// req, resp := client.DescribeDataSetRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSet +func (c *QuickSight) DescribeDataSetRequest(input *DescribeDataSetInput) (req *request.Request, output *DescribeDataSetOutput) { + op := &request.Operation{ + Name: opDescribeDataSet, + HTTPMethod: "GET", + HTTPPath: "/accounts/{AwsAccountId}/data-sets/{DataSetId}", + } + + if input == nil { + input = &DescribeDataSetInput{} + } + + output = &DescribeDataSetOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeDataSet API operation for Amazon QuickSight. +// +// Describes a dataset. +// +// 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 QuickSight's +// API operation DescribeDataSet for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You don't have access to this item. The provided credentials couldn't be +// validated. You might not be authorized to carry out the request. Make sure +// that your account is authorized to use the Amazon QuickSight service, that +// your policies have the correct permissions, and that you are using the correct +// access keys. +// +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * ThrottlingException +// Access is throttled. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSet +func (c *QuickSight) DescribeDataSet(input *DescribeDataSetInput) (*DescribeDataSetOutput, error) { + req, out := c.DescribeDataSetRequest(input) + return out, req.Send() +} + +// DescribeDataSetWithContext is the same as DescribeDataSet with the addition of // the ability to pass a context and additional request options. // // See DescribeDataSet for details on how to use this API operation. @@ -4823,9 +5282,10 @@ func (c *QuickSight) GetDashboardEmbedUrlRequest(input *GetDashboardEmbedUrlInpu // GetDashboardEmbedUrl API operation for Amazon QuickSight. // -// Generates a URL and authorization code that you can embed in your web server -// code. Before you use this command, make sure that you have configured the -// dashboards and permissions. +// Generates a session URL and authorization code that you can use to embed +// an Amazon QuickSight read-only dashboard in your web server code. Before +// you use this command, make sure that you have configured the dashboards and +// permissions. // // Currently, you can use GetDashboardEmbedURL only from the server, not from // the user's browser. The following rules apply to the combination of URL and @@ -4839,10 +5299,8 @@ func (c *QuickSight) GetDashboardEmbedUrlRequest(input *GetDashboardEmbedUrlInpu // // * The resulting user session is valid for 10 hours. // -// For more information, see Embedding Amazon QuickSight Dashboards (https://docs.aws.amazon.com/quicksight/latest/user/embedding-dashboards.html) -// in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards -// (https://docs.aws.amazon.com/quicksight/latest/APIReference/qs-dev-embedded-dashboards.html) -// in the Amazon QuickSight API Reference. +// For more information, see Embedding Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/embedding-dashboards.html) +// in the Amazon QuickSight User Guide . // // 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 @@ -4963,8 +5421,20 @@ func (c *QuickSight) GetSessionEmbedUrlRequest(input *GetSessionEmbedUrlInput) ( // GetSessionEmbedUrl API operation for Amazon QuickSight. // -// Generates a session URL and authorization code that you can embed in your -// web server code. +// Generates a session URL and authorization code that you can use to embed +// the Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl +// where you want to provide an authoring portal that allows users to create +// data sources, datasets, analyses, and dashboards. The users who access an +// embedded QuickSight console need belong to the author or admin security cohort. +// If you want to restrict permissions to some of these features, add a custom +// permissions profile to the user with the UpdateUser API operation. Use RegisterUser +// API operation to add a new user with a custom permission profile attached. +// For more information, see the following sections in the Amazon QuickSight +// User Guide: +// +// * Embedding the Amazon QuickSight Console (https://docs.aws.amazon.com/quicksight/latest/user/embedding-the-quicksight-console.html) +// +// * Customizing Access to the Amazon QuickSight Console (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html) // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5033,37 +5503,37 @@ func (c *QuickSight) GetSessionEmbedUrlWithContext(ctx aws.Context, input *GetSe return out, req.Send() } -const opListDashboardVersions = "ListDashboardVersions" +const opListAnalyses = "ListAnalyses" -// ListDashboardVersionsRequest generates a "aws/request.Request" representing the -// client's request for the ListDashboardVersions operation. The "output" return +// ListAnalysesRequest generates a "aws/request.Request" representing the +// client's request for the ListAnalyses 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 ListDashboardVersions for more information on using the ListDashboardVersions +// See ListAnalyses for more information on using the ListAnalyses // 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 ListDashboardVersionsRequest method. -// req, resp := client.ListDashboardVersionsRequest(params) +// // Example sending a request using the ListAnalysesRequest method. +// req, resp := client.ListAnalysesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDashboardVersions -func (c *QuickSight) ListDashboardVersionsRequest(input *ListDashboardVersionsInput) (req *request.Request, output *ListDashboardVersionsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalyses +func (c *QuickSight) ListAnalysesRequest(input *ListAnalysesInput) (req *request.Request, output *ListAnalysesOutput) { op := &request.Operation{ - Name: opListDashboardVersions, + Name: opListAnalyses, HTTPMethod: "GET", - HTTPPath: "/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions", + HTTPPath: "/accounts/{AwsAccountId}/analyses", Paginator: &request.Paginator{ InputTokens: []string{"NextToken"}, OutputTokens: []string{"NextToken"}, @@ -5073,32 +5543,26 @@ func (c *QuickSight) ListDashboardVersionsRequest(input *ListDashboardVersionsIn } if input == nil { - input = &ListDashboardVersionsInput{} + input = &ListAnalysesInput{} } - output = &ListDashboardVersionsOutput{} + output = &ListAnalysesOutput{} req = c.newRequest(op, input, output) return } -// ListDashboardVersions API operation for Amazon QuickSight. +// ListAnalyses API operation for Amazon QuickSight. // -// Lists all the versions of the dashboards in the QuickSight subscription. +// Lists Amazon QuickSight analyses that exist in the specified AWS account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon QuickSight's -// API operation ListDashboardVersions for usage and error information. +// API operation ListAnalyses for usage and error information. // // Returned Error Types: -// * InvalidParameterValueException -// One or more parameters has a value that isn't valid. -// -// * ResourceNotFoundException -// One or more resources can't be found. -// // * ThrottlingException // Access is throttled. // @@ -5114,65 +5578,65 @@ func (c *QuickSight) ListDashboardVersionsRequest(input *ListDashboardVersionsIn // * InternalFailureException // An internal failure occurred. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDashboardVersions -func (c *QuickSight) ListDashboardVersions(input *ListDashboardVersionsInput) (*ListDashboardVersionsOutput, error) { - req, out := c.ListDashboardVersionsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalyses +func (c *QuickSight) ListAnalyses(input *ListAnalysesInput) (*ListAnalysesOutput, error) { + req, out := c.ListAnalysesRequest(input) return out, req.Send() } -// ListDashboardVersionsWithContext is the same as ListDashboardVersions with the addition of +// ListAnalysesWithContext is the same as ListAnalyses with the addition of // the ability to pass a context and additional request options. // -// See ListDashboardVersions for details on how to use this API operation. +// See ListAnalyses 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 *QuickSight) ListDashboardVersionsWithContext(ctx aws.Context, input *ListDashboardVersionsInput, opts ...request.Option) (*ListDashboardVersionsOutput, error) { - req, out := c.ListDashboardVersionsRequest(input) +func (c *QuickSight) ListAnalysesWithContext(ctx aws.Context, input *ListAnalysesInput, opts ...request.Option) (*ListAnalysesOutput, error) { + req, out := c.ListAnalysesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListDashboardVersionsPages iterates over the pages of a ListDashboardVersions operation, +// ListAnalysesPages iterates over the pages of a ListAnalyses operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListDashboardVersions method for more information on how to use this operation. +// See ListAnalyses 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 ListDashboardVersions operation. +// // Example iterating over at most 3 pages of a ListAnalyses operation. // pageNum := 0 -// err := client.ListDashboardVersionsPages(params, -// func(page *quicksight.ListDashboardVersionsOutput, lastPage bool) bool { +// err := client.ListAnalysesPages(params, +// func(page *quicksight.ListAnalysesOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) // -func (c *QuickSight) ListDashboardVersionsPages(input *ListDashboardVersionsInput, fn func(*ListDashboardVersionsOutput, bool) bool) error { - return c.ListDashboardVersionsPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *QuickSight) ListAnalysesPages(input *ListAnalysesInput, fn func(*ListAnalysesOutput, bool) bool) error { + return c.ListAnalysesPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListDashboardVersionsPagesWithContext same as ListDashboardVersionsPages except +// ListAnalysesPagesWithContext same as ListAnalysesPages 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 *QuickSight) ListDashboardVersionsPagesWithContext(ctx aws.Context, input *ListDashboardVersionsInput, fn func(*ListDashboardVersionsOutput, bool) bool, opts ...request.Option) error { +func (c *QuickSight) ListAnalysesPagesWithContext(ctx aws.Context, input *ListAnalysesInput, fn func(*ListAnalysesOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListDashboardVersionsInput + var inCpy *ListAnalysesInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListDashboardVersionsRequest(inCpy) + req, _ := c.ListAnalysesRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -5180,7 +5644,7 @@ func (c *QuickSight) ListDashboardVersionsPagesWithContext(ctx aws.Context, inpu } for p.Next() { - if !fn(p.Page().(*ListDashboardVersionsOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListAnalysesOutput), !p.HasNextPage()) { break } } @@ -5188,37 +5652,37 @@ func (c *QuickSight) ListDashboardVersionsPagesWithContext(ctx aws.Context, inpu return p.Err() } -const opListDashboards = "ListDashboards" +const opListDashboardVersions = "ListDashboardVersions" -// ListDashboardsRequest generates a "aws/request.Request" representing the -// client's request for the ListDashboards operation. The "output" return +// ListDashboardVersionsRequest generates a "aws/request.Request" representing the +// client's request for the ListDashboardVersions 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 ListDashboards for more information on using the ListDashboards +// See ListDashboardVersions for more information on using the ListDashboardVersions // 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 ListDashboardsRequest method. -// req, resp := client.ListDashboardsRequest(params) +// // Example sending a request using the ListDashboardVersionsRequest method. +// req, resp := client.ListDashboardVersionsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDashboards -func (c *QuickSight) ListDashboardsRequest(input *ListDashboardsInput) (req *request.Request, output *ListDashboardsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDashboardVersions +func (c *QuickSight) ListDashboardVersionsRequest(input *ListDashboardVersionsInput) (req *request.Request, output *ListDashboardVersionsOutput) { op := &request.Operation{ - Name: opListDashboards, + Name: opListDashboardVersions, HTTPMethod: "GET", - HTTPPath: "/accounts/{AwsAccountId}/dashboards", + HTTPPath: "/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions", Paginator: &request.Paginator{ InputTokens: []string{"NextToken"}, OutputTokens: []string{"NextToken"}, @@ -5228,15 +5692,170 @@ func (c *QuickSight) ListDashboardsRequest(input *ListDashboardsInput) (req *req } if input == nil { - input = &ListDashboardsInput{} + input = &ListDashboardVersionsInput{} } - output = &ListDashboardsOutput{} + output = &ListDashboardVersionsOutput{} req = c.newRequest(op, input, output) return } -// ListDashboards API operation for Amazon QuickSight. +// ListDashboardVersions API operation for Amazon QuickSight. +// +// Lists all the versions of the dashboards in the QuickSight subscription. +// +// 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 QuickSight's +// API operation ListDashboardVersions for usage and error information. +// +// Returned Error Types: +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ThrottlingException +// Access is throttled. +// +// * InvalidNextTokenException +// The NextToken value isn't valid. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDashboardVersions +func (c *QuickSight) ListDashboardVersions(input *ListDashboardVersionsInput) (*ListDashboardVersionsOutput, error) { + req, out := c.ListDashboardVersionsRequest(input) + return out, req.Send() +} + +// ListDashboardVersionsWithContext is the same as ListDashboardVersions with the addition of +// the ability to pass a context and additional request options. +// +// See ListDashboardVersions 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 *QuickSight) ListDashboardVersionsWithContext(ctx aws.Context, input *ListDashboardVersionsInput, opts ...request.Option) (*ListDashboardVersionsOutput, error) { + req, out := c.ListDashboardVersionsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListDashboardVersionsPages iterates over the pages of a ListDashboardVersions operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListDashboardVersions 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 ListDashboardVersions operation. +// pageNum := 0 +// err := client.ListDashboardVersionsPages(params, +// func(page *quicksight.ListDashboardVersionsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *QuickSight) ListDashboardVersionsPages(input *ListDashboardVersionsInput, fn func(*ListDashboardVersionsOutput, bool) bool) error { + return c.ListDashboardVersionsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListDashboardVersionsPagesWithContext same as ListDashboardVersionsPages 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 *QuickSight) ListDashboardVersionsPagesWithContext(ctx aws.Context, input *ListDashboardVersionsInput, fn func(*ListDashboardVersionsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListDashboardVersionsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListDashboardVersionsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListDashboardVersionsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListDashboards = "ListDashboards" + +// ListDashboardsRequest generates a "aws/request.Request" representing the +// client's request for the ListDashboards 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 ListDashboards for more information on using the ListDashboards +// 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 ListDashboardsRequest method. +// req, resp := client.ListDashboardsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDashboards +func (c *QuickSight) ListDashboardsRequest(input *ListDashboardsInput) (req *request.Request, output *ListDashboardsOutput) { + op := &request.Operation{ + Name: opListDashboards, + HTTPMethod: "GET", + HTTPPath: "/accounts/{AwsAccountId}/dashboards", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListDashboardsInput{} + } + + output = &ListDashboardsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListDashboards API operation for Amazon QuickSight. // // Lists dashboards in an AWS account. // @@ -6028,8 +6647,8 @@ func (c *QuickSight) ListIAMPolicyAssignmentsForUserRequest(input *ListIAMPolicy // Access is throttled. // // * ConcurrentUpdatingException -// A resource is already in a state that indicates an action is happening that -// must complete before a new update can be applied. +// A resource is already in a state that indicates an operation is happening +// that must complete before a new update can be applied. // // * InternalFailureException // An internal failure occurred. @@ -7558,190 +8177,442 @@ func (c *QuickSight) RegisterUserWithContext(ctx aws.Context, input *RegisterUse return out, req.Send() } -const opSearchDashboards = "SearchDashboards" +const opRestoreAnalysis = "RestoreAnalysis" -// SearchDashboardsRequest generates a "aws/request.Request" representing the -// client's request for the SearchDashboards operation. The "output" return +// RestoreAnalysisRequest generates a "aws/request.Request" representing the +// client's request for the RestoreAnalysis 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 SearchDashboards for more information on using the SearchDashboards +// See RestoreAnalysis for more information on using the RestoreAnalysis // 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 SearchDashboardsRequest method. -// req, resp := client.SearchDashboardsRequest(params) +// // Example sending a request using the RestoreAnalysisRequest method. +// req, resp := client.RestoreAnalysisRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDashboards -func (c *QuickSight) SearchDashboardsRequest(input *SearchDashboardsInput) (req *request.Request, output *SearchDashboardsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysis +func (c *QuickSight) RestoreAnalysisRequest(input *RestoreAnalysisInput) (req *request.Request, output *RestoreAnalysisOutput) { op := &request.Operation{ - Name: opSearchDashboards, + Name: opRestoreAnalysis, HTTPMethod: "POST", - HTTPPath: "/accounts/{AwsAccountId}/search/dashboards", - Paginator: &request.Paginator{ - InputTokens: []string{"NextToken"}, - OutputTokens: []string{"NextToken"}, - LimitToken: "MaxResults", - TruncationToken: "", - }, + HTTPPath: "/accounts/{AwsAccountId}/restore/analyses/{AnalysisId}", } if input == nil { - input = &SearchDashboardsInput{} + input = &RestoreAnalysisInput{} } - output = &SearchDashboardsOutput{} + output = &RestoreAnalysisOutput{} req = c.newRequest(op, input, output) return } -// SearchDashboards API operation for Amazon QuickSight. +// RestoreAnalysis API operation for Amazon QuickSight. // -// Searchs for dashboards that belong to a user. +// Restores an analysis. // // 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 QuickSight's -// API operation SearchDashboards for usage and error information. +// API operation RestoreAnalysis for usage and error information. // // Returned Error Types: // * ThrottlingException // Access is throttled. // -// * ResourceNotFoundException -// One or more resources can't be found. -// // * InvalidParameterValueException // One or more parameters has a value that isn't valid. // +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// // * UnsupportedUserEditionException // This error indicates that you are calling an operation on an Amazon QuickSight // subscription where the edition doesn't include support for that operation. // Amazon QuickSight currently has Standard Edition and Enterprise Edition. // Not every operation and capability is available in every edition. // -// * InvalidNextTokenException -// The NextToken value isn't valid. -// // * InternalFailureException // An internal failure occurred. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDashboards -func (c *QuickSight) SearchDashboards(input *SearchDashboardsInput) (*SearchDashboardsOutput, error) { - req, out := c.SearchDashboardsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysis +func (c *QuickSight) RestoreAnalysis(input *RestoreAnalysisInput) (*RestoreAnalysisOutput, error) { + req, out := c.RestoreAnalysisRequest(input) return out, req.Send() } -// SearchDashboardsWithContext is the same as SearchDashboards with the addition of +// RestoreAnalysisWithContext is the same as RestoreAnalysis with the addition of // the ability to pass a context and additional request options. // -// See SearchDashboards for details on how to use this API operation. +// See RestoreAnalysis 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 *QuickSight) SearchDashboardsWithContext(ctx aws.Context, input *SearchDashboardsInput, opts ...request.Option) (*SearchDashboardsOutput, error) { - req, out := c.SearchDashboardsRequest(input) +func (c *QuickSight) RestoreAnalysisWithContext(ctx aws.Context, input *RestoreAnalysisInput, opts ...request.Option) (*RestoreAnalysisOutput, error) { + req, out := c.RestoreAnalysisRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// SearchDashboardsPages iterates over the pages of a SearchDashboards operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. -// -// See SearchDashboards 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 SearchDashboards operation. -// pageNum := 0 -// err := client.SearchDashboardsPages(params, -// func(page *quicksight.SearchDashboardsOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) -// -func (c *QuickSight) SearchDashboardsPages(input *SearchDashboardsInput, fn func(*SearchDashboardsOutput, bool) bool) error { - return c.SearchDashboardsPagesWithContext(aws.BackgroundContext(), input, fn) -} - -// SearchDashboardsPagesWithContext same as SearchDashboardsPages 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 *QuickSight) SearchDashboardsPagesWithContext(ctx aws.Context, input *SearchDashboardsInput, fn func(*SearchDashboardsOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *SearchDashboardsInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.SearchDashboardsRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*SearchDashboardsOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() -} - -const opTagResource = "TagResource" +const opSearchAnalyses = "SearchAnalyses" -// TagResourceRequest generates a "aws/request.Request" representing the -// client's request for the TagResource operation. The "output" return +// SearchAnalysesRequest generates a "aws/request.Request" representing the +// client's request for the SearchAnalyses operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See TagResource for more information on using the TagResource +// See SearchAnalyses for more information on using the SearchAnalyses // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the TagResourceRequest method. -// req, resp := client.TagResourceRequest(params) +// // Example sending a request using the SearchAnalysesRequest method. +// req, resp := client.SearchAnalysesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TagResource -func (c *QuickSight) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAnalyses +func (c *QuickSight) SearchAnalysesRequest(input *SearchAnalysesInput) (req *request.Request, output *SearchAnalysesOutput) { op := &request.Operation{ - Name: opTagResource, + Name: opSearchAnalyses, + HTTPMethod: "POST", + HTTPPath: "/accounts/{AwsAccountId}/search/analyses", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &SearchAnalysesInput{} + } + + output = &SearchAnalysesOutput{} + req = c.newRequest(op, input, output) + return +} + +// SearchAnalyses API operation for Amazon QuickSight. +// +// Searches for analyses that belong to the user specified in the filter. +// +// 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 QuickSight's +// API operation SearchAnalyses for usage and error information. +// +// Returned Error Types: +// * ThrottlingException +// Access is throttled. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * InvalidNextTokenException +// The NextToken value isn't valid. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAnalyses +func (c *QuickSight) SearchAnalyses(input *SearchAnalysesInput) (*SearchAnalysesOutput, error) { + req, out := c.SearchAnalysesRequest(input) + return out, req.Send() +} + +// SearchAnalysesWithContext is the same as SearchAnalyses with the addition of +// the ability to pass a context and additional request options. +// +// See SearchAnalyses 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 *QuickSight) SearchAnalysesWithContext(ctx aws.Context, input *SearchAnalysesInput, opts ...request.Option) (*SearchAnalysesOutput, error) { + req, out := c.SearchAnalysesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// SearchAnalysesPages iterates over the pages of a SearchAnalyses operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See SearchAnalyses 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 SearchAnalyses operation. +// pageNum := 0 +// err := client.SearchAnalysesPages(params, +// func(page *quicksight.SearchAnalysesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *QuickSight) SearchAnalysesPages(input *SearchAnalysesInput, fn func(*SearchAnalysesOutput, bool) bool) error { + return c.SearchAnalysesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// SearchAnalysesPagesWithContext same as SearchAnalysesPages 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 *QuickSight) SearchAnalysesPagesWithContext(ctx aws.Context, input *SearchAnalysesInput, fn func(*SearchAnalysesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *SearchAnalysesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.SearchAnalysesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*SearchAnalysesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opSearchDashboards = "SearchDashboards" + +// SearchDashboardsRequest generates a "aws/request.Request" representing the +// client's request for the SearchDashboards 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 SearchDashboards for more information on using the SearchDashboards +// 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 SearchDashboardsRequest method. +// req, resp := client.SearchDashboardsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDashboards +func (c *QuickSight) SearchDashboardsRequest(input *SearchDashboardsInput) (req *request.Request, output *SearchDashboardsOutput) { + op := &request.Operation{ + Name: opSearchDashboards, + HTTPMethod: "POST", + HTTPPath: "/accounts/{AwsAccountId}/search/dashboards", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &SearchDashboardsInput{} + } + + output = &SearchDashboardsOutput{} + req = c.newRequest(op, input, output) + return +} + +// SearchDashboards API operation for Amazon QuickSight. +// +// Searches for dashboards that belong to a user. +// +// 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 QuickSight's +// API operation SearchDashboards for usage and error information. +// +// Returned Error Types: +// * ThrottlingException +// Access is throttled. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * InvalidNextTokenException +// The NextToken value isn't valid. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDashboards +func (c *QuickSight) SearchDashboards(input *SearchDashboardsInput) (*SearchDashboardsOutput, error) { + req, out := c.SearchDashboardsRequest(input) + return out, req.Send() +} + +// SearchDashboardsWithContext is the same as SearchDashboards with the addition of +// the ability to pass a context and additional request options. +// +// See SearchDashboards 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 *QuickSight) SearchDashboardsWithContext(ctx aws.Context, input *SearchDashboardsInput, opts ...request.Option) (*SearchDashboardsOutput, error) { + req, out := c.SearchDashboardsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// SearchDashboardsPages iterates over the pages of a SearchDashboards operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See SearchDashboards 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 SearchDashboards operation. +// pageNum := 0 +// err := client.SearchDashboardsPages(params, +// func(page *quicksight.SearchDashboardsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *QuickSight) SearchDashboardsPages(input *SearchDashboardsInput, fn func(*SearchDashboardsOutput, bool) bool) error { + return c.SearchDashboardsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// SearchDashboardsPagesWithContext same as SearchDashboardsPages 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 *QuickSight) SearchDashboardsPagesWithContext(ctx aws.Context, input *SearchDashboardsInput, fn func(*SearchDashboardsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *SearchDashboardsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.SearchDashboardsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*SearchDashboardsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opTagResource = "TagResource" + +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See TagResource for more information on using the TagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the TagResourceRequest method. +// req, resp := client.TagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TagResource +func (c *QuickSight) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { + op := &request.Operation{ + Name: opTagResource, HTTPMethod: "POST", HTTPPath: "/resources/{ResourceArn}/tags", } @@ -7972,8 +8843,13 @@ func (c *QuickSight) UpdateAccountCustomizationRequest(input *UpdateAccountCusto // UpdateAccountCustomization API operation for Amazon QuickSight. // -// Updates customizations associated with the QuickSight subscription on your -// AWS account. +// Updates Amazon QuickSight customizations the current AWS Region. Currently, +// the only customization you can use is a theme. +// +// You can use customizations for your AWS account or, if you specify a namespace, +// for a QuickSight namespace instead. Customizations that apply to a namespace +// override customizations that apply to an AWS account. To find out which customizations +// apply, use the DescribeAccountCustomization API operation. // // 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 @@ -8002,91 +8878,285 @@ func (c *QuickSight) UpdateAccountCustomizationRequest(input *UpdateAccountCusto // * InternalFailureException // An internal failure occurred. // -// * ResourceUnavailableException -// This resource is currently unavailable. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomization -func (c *QuickSight) UpdateAccountCustomization(input *UpdateAccountCustomizationInput) (*UpdateAccountCustomizationOutput, error) { - req, out := c.UpdateAccountCustomizationRequest(input) +// * ResourceUnavailableException +// This resource is currently unavailable. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomization +func (c *QuickSight) UpdateAccountCustomization(input *UpdateAccountCustomizationInput) (*UpdateAccountCustomizationOutput, error) { + req, out := c.UpdateAccountCustomizationRequest(input) + return out, req.Send() +} + +// UpdateAccountCustomizationWithContext is the same as UpdateAccountCustomization with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateAccountCustomization 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 *QuickSight) UpdateAccountCustomizationWithContext(ctx aws.Context, input *UpdateAccountCustomizationInput, opts ...request.Option) (*UpdateAccountCustomizationOutput, error) { + req, out := c.UpdateAccountCustomizationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateAccountSettings = "UpdateAccountSettings" + +// UpdateAccountSettingsRequest generates a "aws/request.Request" representing the +// client's request for the UpdateAccountSettings 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 UpdateAccountSettings for more information on using the UpdateAccountSettings +// 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 UpdateAccountSettingsRequest method. +// req, resp := client.UpdateAccountSettingsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettings +func (c *QuickSight) UpdateAccountSettingsRequest(input *UpdateAccountSettingsInput) (req *request.Request, output *UpdateAccountSettingsOutput) { + op := &request.Operation{ + Name: opUpdateAccountSettings, + HTTPMethod: "PUT", + HTTPPath: "/accounts/{AwsAccountId}/settings", + } + + if input == nil { + input = &UpdateAccountSettingsInput{} + } + + output = &UpdateAccountSettingsOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateAccountSettings API operation for Amazon QuickSight. +// +// Updates the Amazon QuickSight settings in your AWS Account. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon QuickSight's +// API operation UpdateAccountSettings for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You don't have access to this item. The provided credentials couldn't be +// validated. You might not be authorized to carry out the request. Make sure +// that your account is authorized to use the Amazon QuickSight service, that +// your policies have the correct permissions, and that you are using the correct +// access keys. +// +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ThrottlingException +// Access is throttled. +// +// * InternalFailureException +// An internal failure occurred. +// +// * ResourceUnavailableException +// This resource is currently unavailable. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettings +func (c *QuickSight) UpdateAccountSettings(input *UpdateAccountSettingsInput) (*UpdateAccountSettingsOutput, error) { + req, out := c.UpdateAccountSettingsRequest(input) + return out, req.Send() +} + +// UpdateAccountSettingsWithContext is the same as UpdateAccountSettings with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateAccountSettings 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 *QuickSight) UpdateAccountSettingsWithContext(ctx aws.Context, input *UpdateAccountSettingsInput, opts ...request.Option) (*UpdateAccountSettingsOutput, error) { + req, out := c.UpdateAccountSettingsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateAnalysis = "UpdateAnalysis" + +// UpdateAnalysisRequest generates a "aws/request.Request" representing the +// client's request for the UpdateAnalysis 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 UpdateAnalysis for more information on using the UpdateAnalysis +// 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 UpdateAnalysisRequest method. +// req, resp := client.UpdateAnalysisRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysis +func (c *QuickSight) UpdateAnalysisRequest(input *UpdateAnalysisInput) (req *request.Request, output *UpdateAnalysisOutput) { + op := &request.Operation{ + Name: opUpdateAnalysis, + HTTPMethod: "PUT", + HTTPPath: "/accounts/{AwsAccountId}/analyses/{AnalysisId}", + } + + if input == nil { + input = &UpdateAnalysisInput{} + } + + output = &UpdateAnalysisOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateAnalysis API operation for Amazon QuickSight. +// +// Updates an analysis in Amazon QuickSight +// +// 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 QuickSight's +// API operation UpdateAnalysis for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * InvalidParameterValueException +// One or more parameters has a value that isn't valid. +// +// * ThrottlingException +// Access is throttled. +// +// * ResourceExistsException +// The resource specified already exists. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * InternalFailureException +// An internal failure occurred. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysis +func (c *QuickSight) UpdateAnalysis(input *UpdateAnalysisInput) (*UpdateAnalysisOutput, error) { + req, out := c.UpdateAnalysisRequest(input) return out, req.Send() } -// UpdateAccountCustomizationWithContext is the same as UpdateAccountCustomization with the addition of +// UpdateAnalysisWithContext is the same as UpdateAnalysis with the addition of // the ability to pass a context and additional request options. // -// See UpdateAccountCustomization for details on how to use this API operation. +// See UpdateAnalysis 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 *QuickSight) UpdateAccountCustomizationWithContext(ctx aws.Context, input *UpdateAccountCustomizationInput, opts ...request.Option) (*UpdateAccountCustomizationOutput, error) { - req, out := c.UpdateAccountCustomizationRequest(input) +func (c *QuickSight) UpdateAnalysisWithContext(ctx aws.Context, input *UpdateAnalysisInput, opts ...request.Option) (*UpdateAnalysisOutput, error) { + req, out := c.UpdateAnalysisRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateAccountSettings = "UpdateAccountSettings" +const opUpdateAnalysisPermissions = "UpdateAnalysisPermissions" -// UpdateAccountSettingsRequest generates a "aws/request.Request" representing the -// client's request for the UpdateAccountSettings operation. The "output" return +// UpdateAnalysisPermissionsRequest generates a "aws/request.Request" representing the +// client's request for the UpdateAnalysisPermissions 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 UpdateAccountSettings for more information on using the UpdateAccountSettings +// See UpdateAnalysisPermissions for more information on using the UpdateAnalysisPermissions // 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 UpdateAccountSettingsRequest method. -// req, resp := client.UpdateAccountSettingsRequest(params) +// // Example sending a request using the UpdateAnalysisPermissionsRequest method. +// req, resp := client.UpdateAnalysisPermissionsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettings -func (c *QuickSight) UpdateAccountSettingsRequest(input *UpdateAccountSettingsInput) (req *request.Request, output *UpdateAccountSettingsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisPermissions +func (c *QuickSight) UpdateAnalysisPermissionsRequest(input *UpdateAnalysisPermissionsInput) (req *request.Request, output *UpdateAnalysisPermissionsOutput) { op := &request.Operation{ - Name: opUpdateAccountSettings, + Name: opUpdateAnalysisPermissions, HTTPMethod: "PUT", - HTTPPath: "/accounts/{AwsAccountId}/settings", + HTTPPath: "/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions", } if input == nil { - input = &UpdateAccountSettingsInput{} + input = &UpdateAnalysisPermissionsInput{} } - output = &UpdateAccountSettingsOutput{} + output = &UpdateAnalysisPermissionsOutput{} req = c.newRequest(op, input, output) return } -// UpdateAccountSettings API operation for Amazon QuickSight. +// UpdateAnalysisPermissions API operation for Amazon QuickSight. // -// Updates the settings for the Amazon QuickSight subscription in your AWS Account. +// Updates the read and write permissions for an analysis. // // 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 QuickSight's -// API operation UpdateAccountSettings for usage and error information. +// API operation UpdateAnalysisPermissions for usage and error information. // // Returned Error Types: -// * AccessDeniedException -// You don't have access to this item. The provided credentials couldn't be -// validated. You might not be authorized to carry out the request. Make sure -// that your account is authorized to use the Amazon QuickSight service, that -// your policies have the correct permissions, and that you are using the correct -// access keys. +// * ThrottlingException +// Access is throttled. // // * InvalidParameterValueException // One or more parameters has a value that isn't valid. @@ -8094,32 +9164,35 @@ func (c *QuickSight) UpdateAccountSettingsRequest(input *UpdateAccountSettingsIn // * ResourceNotFoundException // One or more resources can't be found. // -// * ThrottlingException -// Access is throttled. +// * UnsupportedUserEditionException +// This error indicates that you are calling an operation on an Amazon QuickSight +// subscription where the edition doesn't include support for that operation. +// Amazon QuickSight currently has Standard Edition and Enterprise Edition. +// Not every operation and capability is available in every edition. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. // // * InternalFailureException // An internal failure occurred. // -// * ResourceUnavailableException -// This resource is currently unavailable. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettings -func (c *QuickSight) UpdateAccountSettings(input *UpdateAccountSettingsInput) (*UpdateAccountSettingsOutput, error) { - req, out := c.UpdateAccountSettingsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisPermissions +func (c *QuickSight) UpdateAnalysisPermissions(input *UpdateAnalysisPermissionsInput) (*UpdateAnalysisPermissionsOutput, error) { + req, out := c.UpdateAnalysisPermissionsRequest(input) return out, req.Send() } -// UpdateAccountSettingsWithContext is the same as UpdateAccountSettings with the addition of +// UpdateAnalysisPermissionsWithContext is the same as UpdateAnalysisPermissions with the addition of // the ability to pass a context and additional request options. // -// See UpdateAccountSettings for details on how to use this API operation. +// See UpdateAnalysisPermissions 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 *QuickSight) UpdateAccountSettingsWithContext(ctx aws.Context, input *UpdateAccountSettingsInput, opts ...request.Option) (*UpdateAccountSettingsOutput, error) { - req, out := c.UpdateAccountSettingsRequest(input) +func (c *QuickSight) UpdateAnalysisPermissionsWithContext(ctx aws.Context, input *UpdateAnalysisPermissionsInput, opts ...request.Option) (*UpdateAnalysisPermissionsOutput, error) { + req, out := c.UpdateAnalysisPermissionsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() @@ -8998,8 +10071,8 @@ func (c *QuickSight) UpdateIAMPolicyAssignmentRequest(input *UpdateIAMPolicyAssi // Access is throttled. // // * ConcurrentUpdatingException -// A resource is already in a state that indicates an action is happening that -// must complete before a new update can be applied. +// A resource is already in a state that indicates an operation is happening +// that must complete before a new update can be applied. // // * InternalFailureException // An internal failure occurred. @@ -9810,7 +10883,8 @@ func (s *AccessDeniedException) RequestID() string { return s.RespMetadata.RequestID } -// The customizations associated with your AWS account for QuickSight. +// The Amazon QuickSight customizations associated with your AWS account or +// a QuickSight namespace in a specific AWS Region. type AccountCustomization struct { _ struct{} `type:"structure"` @@ -9838,13 +10912,16 @@ func (s *AccountCustomization) SetDefaultTheme(v string) *AccountCustomization { type AccountSettings struct { _ struct{} `type:"structure"` - // The name associated with the QuickSight subscription in your AWS account. + // The "account name" you provided for the QuickSight subscription in your AWS + // account. You create this name when you sign up for QuickSight. It is unique + // in all of AWS and it appears only in the console when users sign in. AccountName *string `type:"string"` // The default QuickSight namespace for your AWS account. DefaultNamespace *string `type:"string"` - // The edition of QuickSight that you're currently subscribed to. + // The edition of QuickSight that you're currently subscribed to: Enterprise + // edition or Standard edition. Edition *string `type:"string" enum:"Edition"` // The main notification email for your QuickSight subscription. @@ -9897,79 +10974,352 @@ type ActiveIAMPolicyAssignment struct { } // String returns the string representation -func (s ActiveIAMPolicyAssignment) String() string { +func (s ActiveIAMPolicyAssignment) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ActiveIAMPolicyAssignment) GoString() string { + return s.String() +} + +// SetAssignmentName sets the AssignmentName field's value. +func (s *ActiveIAMPolicyAssignment) SetAssignmentName(v string) *ActiveIAMPolicyAssignment { + s.AssignmentName = &v + return s +} + +// SetPolicyArn sets the PolicyArn field's value. +func (s *ActiveIAMPolicyAssignment) SetPolicyArn(v string) *ActiveIAMPolicyAssignment { + s.PolicyArn = &v + return s +} + +// Ad hoc (one-time) filtering option. +type AdHocFilteringOption struct { + _ struct{} `type:"structure"` + + // Availability status. + AvailabilityStatus *string `type:"string" enum:"DashboardBehavior"` +} + +// String returns the string representation +func (s AdHocFilteringOption) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AdHocFilteringOption) GoString() string { + return s.String() +} + +// SetAvailabilityStatus sets the AvailabilityStatus field's value. +func (s *AdHocFilteringOption) SetAvailabilityStatus(v string) *AdHocFilteringOption { + s.AvailabilityStatus = &v + return s +} + +// Amazon Elasticsearch Service parameters. +type AmazonElasticsearchParameters struct { + _ struct{} `type:"structure"` + + // The Amazon Elasticsearch Service domain. + // + // Domain is a required field + Domain *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s AmazonElasticsearchParameters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AmazonElasticsearchParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AmazonElasticsearchParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AmazonElasticsearchParameters"} + if s.Domain == nil { + invalidParams.Add(request.NewErrParamRequired("Domain")) + } + if s.Domain != nil && len(*s.Domain) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Domain", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomain sets the Domain field's value. +func (s *AmazonElasticsearchParameters) SetDomain(v string) *AmazonElasticsearchParameters { + s.Domain = &v + return s +} + +// Metadata structure for an analysis in Amazon QuickSight +type Analysis struct { + _ struct{} `type:"structure"` + + // The ID of the analysis. + AnalysisId *string `min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of the analysis. + Arn *string `type:"string"` + + // The time that the analysis was created. + CreatedTime *time.Time `type:"timestamp"` + + // The ARNs of the datasets of the analysis. + DataSetArns []*string `type:"list"` + + // Errors associated with the analysis. + Errors []*AnalysisError `min:"1" type:"list"` + + // The time that the analysis was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The descriptive name of the analysis. + Name *string `min:"1" type:"string"` + + // Status associated with the analysis. + Status *string `type:"string" enum:"ResourceStatus"` + + // The ARN of the theme of the analysis. + ThemeArn *string `type:"string"` +} + +// String returns the string representation +func (s Analysis) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Analysis) GoString() string { + return s.String() +} + +// SetAnalysisId sets the AnalysisId field's value. +func (s *Analysis) SetAnalysisId(v string) *Analysis { + s.AnalysisId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *Analysis) SetArn(v string) *Analysis { + s.Arn = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *Analysis) SetCreatedTime(v time.Time) *Analysis { + s.CreatedTime = &v + return s +} + +// SetDataSetArns sets the DataSetArns field's value. +func (s *Analysis) SetDataSetArns(v []*string) *Analysis { + s.DataSetArns = v + return s +} + +// SetErrors sets the Errors field's value. +func (s *Analysis) SetErrors(v []*AnalysisError) *Analysis { + s.Errors = v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *Analysis) SetLastUpdatedTime(v time.Time) *Analysis { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *Analysis) SetName(v string) *Analysis { + s.Name = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *Analysis) SetStatus(v string) *Analysis { + s.Status = &v + return s +} + +// SetThemeArn sets the ThemeArn field's value. +func (s *Analysis) SetThemeArn(v string) *Analysis { + s.ThemeArn = &v + return s +} + +// A metadata error structure for an analysis. +type AnalysisError struct { + _ struct{} `type:"structure"` + + // The message associated with the analysis error. + Message *string `type:"string"` + + // The type of the analysis error. + Type *string `type:"string" enum:"AnalysisErrorType"` +} + +// String returns the string representation +func (s AnalysisError) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AnalysisError) GoString() string { + return s.String() +} + +// SetMessage sets the Message field's value. +func (s *AnalysisError) SetMessage(v string) *AnalysisError { + s.Message = &v + return s +} + +// SetType sets the Type field's value. +func (s *AnalysisError) SetType(v string) *AnalysisError { + s.Type = &v + return s +} + +// A filter that you apply when searching for one or more analyses. +type AnalysisSearchFilter struct { + _ struct{} `type:"structure"` + + // The name of the value that you want to use as a filter, for example "Name": + // "QUICKSIGHT_USER". + Name *string `type:"string" enum:"AnalysisFilterAttribute"` + + // The comparison operator that you want to use as a filter, for example "Operator": + // "StringEquals". + Operator *string `type:"string" enum:"FilterOperator"` + + // The value of the named item, in this case QUICKSIGHT_USER, that you want + // to use as a filter, for example "Value". An example is "arn:aws:quicksight:us-east-1:1:user/default/UserName1". + Value *string `type:"string"` +} + +// String returns the string representation +func (s AnalysisSearchFilter) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ActiveIAMPolicyAssignment) GoString() string { +func (s AnalysisSearchFilter) GoString() string { return s.String() } -// SetAssignmentName sets the AssignmentName field's value. -func (s *ActiveIAMPolicyAssignment) SetAssignmentName(v string) *ActiveIAMPolicyAssignment { - s.AssignmentName = &v +// SetName sets the Name field's value. +func (s *AnalysisSearchFilter) SetName(v string) *AnalysisSearchFilter { + s.Name = &v return s } -// SetPolicyArn sets the PolicyArn field's value. -func (s *ActiveIAMPolicyAssignment) SetPolicyArn(v string) *ActiveIAMPolicyAssignment { - s.PolicyArn = &v +// SetOperator sets the Operator field's value. +func (s *AnalysisSearchFilter) SetOperator(v string) *AnalysisSearchFilter { + s.Operator = &v return s } -// Ad hoc (one-time) filtering option. -type AdHocFilteringOption struct { +// SetValue sets the Value field's value. +func (s *AnalysisSearchFilter) SetValue(v string) *AnalysisSearchFilter { + s.Value = &v + return s +} + +// The source entity of an analysis. +type AnalysisSourceEntity struct { _ struct{} `type:"structure"` - // Availability status. - AvailabilityStatus *string `type:"string" enum:"DashboardBehavior"` + // The source template for the source entity of the analysis. + SourceTemplate *AnalysisSourceTemplate `type:"structure"` } // String returns the string representation -func (s AdHocFilteringOption) String() string { +func (s AnalysisSourceEntity) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s AdHocFilteringOption) GoString() string { +func (s AnalysisSourceEntity) GoString() string { return s.String() } -// SetAvailabilityStatus sets the AvailabilityStatus field's value. -func (s *AdHocFilteringOption) SetAvailabilityStatus(v string) *AdHocFilteringOption { - s.AvailabilityStatus = &v +// Validate inspects the fields of the type to determine if they are valid. +func (s *AnalysisSourceEntity) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AnalysisSourceEntity"} + if s.SourceTemplate != nil { + if err := s.SourceTemplate.Validate(); err != nil { + invalidParams.AddNested("SourceTemplate", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetSourceTemplate sets the SourceTemplate field's value. +func (s *AnalysisSourceEntity) SetSourceTemplate(v *AnalysisSourceTemplate) *AnalysisSourceEntity { + s.SourceTemplate = v return s } -// Amazon Elasticsearch Service parameters. -type AmazonElasticsearchParameters struct { +// The source template of an analysis. +type AnalysisSourceTemplate struct { _ struct{} `type:"structure"` - // The Amazon Elasticsearch Service domain. + // The Amazon Resource Name (ARN) of the source template of an analysis. // - // Domain is a required field - Domain *string `min:"1" type:"string" required:"true"` + // Arn is a required field + Arn *string `type:"string" required:"true"` + + // The dataset references of the source template of an analysis. + // + // DataSetReferences is a required field + DataSetReferences []*DataSetReference `min:"1" type:"list" required:"true"` } // String returns the string representation -func (s AmazonElasticsearchParameters) String() string { +func (s AnalysisSourceTemplate) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s AmazonElasticsearchParameters) GoString() string { +func (s AnalysisSourceTemplate) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *AmazonElasticsearchParameters) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "AmazonElasticsearchParameters"} - if s.Domain == nil { - invalidParams.Add(request.NewErrParamRequired("Domain")) +func (s *AnalysisSourceTemplate) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AnalysisSourceTemplate"} + if s.Arn == nil { + invalidParams.Add(request.NewErrParamRequired("Arn")) } - if s.Domain != nil && len(*s.Domain) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Domain", 1)) + if s.DataSetReferences == nil { + invalidParams.Add(request.NewErrParamRequired("DataSetReferences")) + } + if s.DataSetReferences != nil && len(s.DataSetReferences) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DataSetReferences", 1)) + } + if s.DataSetReferences != nil { + for i, v := range s.DataSetReferences { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "DataSetReferences", i), err.(request.ErrInvalidParams)) + } + } } if invalidParams.Len() > 0 { @@ -9978,9 +11328,84 @@ func (s *AmazonElasticsearchParameters) Validate() error { return nil } -// SetDomain sets the Domain field's value. -func (s *AmazonElasticsearchParameters) SetDomain(v string) *AmazonElasticsearchParameters { - s.Domain = &v +// SetArn sets the Arn field's value. +func (s *AnalysisSourceTemplate) SetArn(v string) *AnalysisSourceTemplate { + s.Arn = &v + return s +} + +// SetDataSetReferences sets the DataSetReferences field's value. +func (s *AnalysisSourceTemplate) SetDataSetReferences(v []*DataSetReference) *AnalysisSourceTemplate { + s.DataSetReferences = v + return s +} + +// The summary metadata that describes an analysis. +type AnalysisSummary struct { + _ struct{} `type:"structure"` + + // The ID of the analysis. This ID displays in the URL. + AnalysisId *string `min:"1" type:"string"` + + // The Amazon Resource Name (ARN) for the analysis. + Arn *string `type:"string"` + + // The time that the analysis was created. + CreatedTime *time.Time `type:"timestamp"` + + // The time that the analysis was last updated. + LastUpdatedTime *time.Time `type:"timestamp"` + + // The name of the analysis. This name is displayed in the QuickSight console. + Name *string `min:"1" type:"string"` + + // The last known status for the analysis. + Status *string `type:"string" enum:"ResourceStatus"` +} + +// String returns the string representation +func (s AnalysisSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AnalysisSummary) GoString() string { + return s.String() +} + +// SetAnalysisId sets the AnalysisId field's value. +func (s *AnalysisSummary) SetAnalysisId(v string) *AnalysisSummary { + s.AnalysisId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *AnalysisSummary) SetArn(v string) *AnalysisSummary { + s.Arn = &v + return s +} + +// SetCreatedTime sets the CreatedTime field's value. +func (s *AnalysisSummary) SetCreatedTime(v time.Time) *AnalysisSummary { + s.CreatedTime = &v + return s +} + +// SetLastUpdatedTime sets the LastUpdatedTime field's value. +func (s *AnalysisSummary) SetLastUpdatedTime(v time.Time) *AnalysisSummary { + s.LastUpdatedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *AnalysisSummary) SetName(v string) *AnalysisSummary { + s.Name = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *AnalysisSummary) SetStatus(v string) *AnalysisSummary { + s.Status = &v return s } @@ -10674,8 +12099,8 @@ func (s *ColumnTag) SetColumnGeographicRole(v string) *ColumnTag { return s } -// A resource is already in a state that indicates an action is happening that -// must complete before a new update can be applied. +// A resource is already in a state that indicates an operation is happening +// that must complete before a new update can be applied. type ConcurrentUpdatingException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -10765,68 +12190,229 @@ func (s *ConflictException) Code() string { return "ConflictException" } -// Message returns the exception's message. -func (s *ConflictException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" +// Message returns the exception's message. +func (s *ConflictException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ConflictException) OrigErr() error { + return nil +} + +func (s *ConflictException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ConflictException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ConflictException) RequestID() string { + return s.RespMetadata.RequestID +} + +type CreateAccountCustomizationInput struct { + _ struct{} `type:"structure"` + + // The QuickSight customizations you're adding in the current AWS Region. You + // can add these to an AWS account and a QuickSight namespace. + // + // For example, you could add a default theme by setting AccountCustomization + // to the midnight theme: "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" + // }. . Or, you could add a custom theme by specifying "AccountCustomization": + // { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" + // }. + // + // AccountCustomization is a required field + AccountCustomization *AccountCustomization `type:"structure" required:"true"` + + // The ID for the AWS account that you want to customize QuickSight for. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The QuickSight namespace that you want to add customizations to. + Namespace *string `location:"querystring" locationName:"namespace" type:"string"` +} + +// String returns the string representation +func (s CreateAccountCustomizationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateAccountCustomizationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateAccountCustomizationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateAccountCustomizationInput"} + if s.AccountCustomization == nil { + invalidParams.Add(request.NewErrParamRequired("AccountCustomization")) + } + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAccountCustomization sets the AccountCustomization field's value. +func (s *CreateAccountCustomizationInput) SetAccountCustomization(v *AccountCustomization) *CreateAccountCustomizationInput { + s.AccountCustomization = v + return s +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *CreateAccountCustomizationInput) SetAwsAccountId(v string) *CreateAccountCustomizationInput { + s.AwsAccountId = &v + return s +} + +// SetNamespace sets the Namespace field's value. +func (s *CreateAccountCustomizationInput) SetNamespace(v string) *CreateAccountCustomizationInput { + s.Namespace = &v + return s +} + +type CreateAccountCustomizationOutput struct { + _ struct{} `type:"structure"` + + // The QuickSight customizations you're adding in the current AWS Region. + AccountCustomization *AccountCustomization `type:"structure"` + + // The ID for the AWS account that you want to customize QuickSight for. + AwsAccountId *string `min:"12" type:"string"` + + // The namespace associated with the customization you're creating. + Namespace *string `type:"string"` + + // The AWS request ID for this operation. + RequestId *string `type:"string"` + + // The HTTP status of the request. + Status *int64 `location:"statusCode" type:"integer"` +} + +// String returns the string representation +func (s CreateAccountCustomizationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateAccountCustomizationOutput) GoString() string { + return s.String() +} + +// SetAccountCustomization sets the AccountCustomization field's value. +func (s *CreateAccountCustomizationOutput) SetAccountCustomization(v *AccountCustomization) *CreateAccountCustomizationOutput { + s.AccountCustomization = v + return s } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *ConflictException) OrigErr() error { - return nil +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *CreateAccountCustomizationOutput) SetAwsAccountId(v string) *CreateAccountCustomizationOutput { + s.AwsAccountId = &v + return s } -func (s *ConflictException) Error() string { - return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +// SetNamespace sets the Namespace field's value. +func (s *CreateAccountCustomizationOutput) SetNamespace(v string) *CreateAccountCustomizationOutput { + s.Namespace = &v + return s } -// Status code returns the HTTP status code for the request's response error. -func (s *ConflictException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetRequestId sets the RequestId field's value. +func (s *CreateAccountCustomizationOutput) SetRequestId(v string) *CreateAccountCustomizationOutput { + s.RequestId = &v + return s } -// RequestID returns the service's response RequestID for request. -func (s *ConflictException) RequestID() string { - return s.RespMetadata.RequestID +// SetStatus sets the Status field's value. +func (s *CreateAccountCustomizationOutput) SetStatus(v int64) *CreateAccountCustomizationOutput { + s.Status = &v + return s } -type CreateAccountCustomizationInput struct { +type CreateAnalysisInput struct { _ struct{} `type:"structure"` - // The customizations you're adding to the QuickSight subscription for the AWS - // account. For example, you could add a default theme by setting AccountCustomization - // to the midnight theme (DefaultTheme="arn:aws:quicksight::aws:theme/MIDNIGHT") - // or to a custom theme (DefaultTheme="arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"). + // The ID for the analysis that you're creating. This ID displays in the URL + // of the analysis. // - // AccountCustomization is a required field - AccountCustomization *AccountCustomization `type:"structure" required:"true"` + // AnalysisId is a required field + AnalysisId *string `location:"uri" locationName:"AnalysisId" min:"1" type:"string" required:"true"` - // The ID for the AWS account that you want to customize QuickSight for. + // The ID of the AWS account where you are creating an analysis. // // AwsAccountId is a required field AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` - // The namespace associated with the customization that you're creating. - Namespace *string `location:"querystring" locationName:"namespace" type:"string"` + // A descriptive name for the analysis that you're creating. This name displays + // for the analysis in the QuickSight console. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // The parameter names and override values that you want to use. An analysis + // can have any parameter type, and some parameters might accept multiple values. + Parameters *Parameters `type:"structure"` + + // A structure that describes the principals and the resource-level permissions + // on an analysis. You can use the Permissions structure to grant permissions + // by providing a list of AWS Identity and Access Management (IAM) action information + // for each principal listed by Amazon Resource Name (ARN). + // + // To specify no permissions, omit Permissions. + Permissions []*ResourcePermission `min:"1" type:"list"` + + // A source entity to use for the analysis that you're creating. This metadata + // structure contains details that describe a source template and one or more + // datasets. + // + // SourceEntity is a required field + SourceEntity *AnalysisSourceEntity `type:"structure" required:"true"` + + // Contains a map of the key-value pairs for the resource tag or tags assigned + // to the analysis. + Tags []*Tag `min:"1" type:"list"` + + // The ARN for the theme to apply to the analysis that you're creating. To see + // the theme in the QuickSight console, make sure that you have access to it. + ThemeArn *string `type:"string"` } // String returns the string representation -func (s CreateAccountCustomizationInput) String() string { +func (s CreateAnalysisInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateAccountCustomizationInput) GoString() string { +func (s CreateAnalysisInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateAccountCustomizationInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateAccountCustomizationInput"} - if s.AccountCustomization == nil { - invalidParams.Add(request.NewErrParamRequired("AccountCustomization")) +func (s *CreateAnalysisInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateAnalysisInput"} + if s.AnalysisId == nil { + invalidParams.Add(request.NewErrParamRequired("AnalysisId")) + } + if s.AnalysisId != nil && len(*s.AnalysisId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AnalysisId", 1)) } if s.AwsAccountId == nil { invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) @@ -10834,6 +12420,51 @@ func (s *CreateAccountCustomizationInput) Validate() error { if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.Permissions != nil && len(s.Permissions) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Permissions", 1)) + } + if s.SourceEntity == nil { + invalidParams.Add(request.NewErrParamRequired("SourceEntity")) + } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.Parameters != nil { + if err := s.Parameters.Validate(); err != nil { + invalidParams.AddNested("Parameters", err.(request.ErrInvalidParams)) + } + } + if s.Permissions != nil { + for i, v := range s.Permissions { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Permissions", i), err.(request.ErrInvalidParams)) + } + } + } + if s.SourceEntity != nil { + if err := s.SourceEntity.Validate(); err != nil { + invalidParams.AddNested("SourceEntity", err.(request.ErrInvalidParams)) + } + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -10841,36 +12472,65 @@ func (s *CreateAccountCustomizationInput) Validate() error { return nil } -// SetAccountCustomization sets the AccountCustomization field's value. -func (s *CreateAccountCustomizationInput) SetAccountCustomization(v *AccountCustomization) *CreateAccountCustomizationInput { - s.AccountCustomization = v +// SetAnalysisId sets the AnalysisId field's value. +func (s *CreateAnalysisInput) SetAnalysisId(v string) *CreateAnalysisInput { + s.AnalysisId = &v return s } // SetAwsAccountId sets the AwsAccountId field's value. -func (s *CreateAccountCustomizationInput) SetAwsAccountId(v string) *CreateAccountCustomizationInput { +func (s *CreateAnalysisInput) SetAwsAccountId(v string) *CreateAnalysisInput { s.AwsAccountId = &v return s } -// SetNamespace sets the Namespace field's value. -func (s *CreateAccountCustomizationInput) SetNamespace(v string) *CreateAccountCustomizationInput { - s.Namespace = &v +// SetName sets the Name field's value. +func (s *CreateAnalysisInput) SetName(v string) *CreateAnalysisInput { + s.Name = &v return s } -type CreateAccountCustomizationOutput struct { +// SetParameters sets the Parameters field's value. +func (s *CreateAnalysisInput) SetParameters(v *Parameters) *CreateAnalysisInput { + s.Parameters = v + return s +} + +// SetPermissions sets the Permissions field's value. +func (s *CreateAnalysisInput) SetPermissions(v []*ResourcePermission) *CreateAnalysisInput { + s.Permissions = v + return s +} + +// SetSourceEntity sets the SourceEntity field's value. +func (s *CreateAnalysisInput) SetSourceEntity(v *AnalysisSourceEntity) *CreateAnalysisInput { + s.SourceEntity = v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateAnalysisInput) SetTags(v []*Tag) *CreateAnalysisInput { + s.Tags = v + return s +} + +// SetThemeArn sets the ThemeArn field's value. +func (s *CreateAnalysisInput) SetThemeArn(v string) *CreateAnalysisInput { + s.ThemeArn = &v + return s +} + +type CreateAnalysisOutput struct { _ struct{} `type:"structure"` - // The customizations you're adding to the QuickSight subscription for the AWS - // account. - AccountCustomization *AccountCustomization `type:"structure"` + // The ID of the analysis. + AnalysisId *string `min:"1" type:"string"` - // The ID for the AWS account that you want to customize QuickSight for. - AwsAccountId *string `min:"12" type:"string"` + // The ARN for the analysis. + Arn *string `type:"string"` - // The namespace associated with the customization you're creating. - Namespace *string `type:"string"` + // The status of the creation of the analysis. + CreationStatus *string `type:"string" enum:"ResourceStatus"` // The AWS request ID for this operation. RequestId *string `type:"string"` @@ -10880,41 +12540,41 @@ type CreateAccountCustomizationOutput struct { } // String returns the string representation -func (s CreateAccountCustomizationOutput) String() string { +func (s CreateAnalysisOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateAccountCustomizationOutput) GoString() string { +func (s CreateAnalysisOutput) GoString() string { return s.String() } -// SetAccountCustomization sets the AccountCustomization field's value. -func (s *CreateAccountCustomizationOutput) SetAccountCustomization(v *AccountCustomization) *CreateAccountCustomizationOutput { - s.AccountCustomization = v +// SetAnalysisId sets the AnalysisId field's value. +func (s *CreateAnalysisOutput) SetAnalysisId(v string) *CreateAnalysisOutput { + s.AnalysisId = &v return s } -// SetAwsAccountId sets the AwsAccountId field's value. -func (s *CreateAccountCustomizationOutput) SetAwsAccountId(v string) *CreateAccountCustomizationOutput { - s.AwsAccountId = &v +// SetArn sets the Arn field's value. +func (s *CreateAnalysisOutput) SetArn(v string) *CreateAnalysisOutput { + s.Arn = &v return s } -// SetNamespace sets the Namespace field's value. -func (s *CreateAccountCustomizationOutput) SetNamespace(v string) *CreateAccountCustomizationOutput { - s.Namespace = &v +// SetCreationStatus sets the CreationStatus field's value. +func (s *CreateAnalysisOutput) SetCreationStatus(v string) *CreateAnalysisOutput { + s.CreationStatus = &v return s } // SetRequestId sets the RequestId field's value. -func (s *CreateAccountCustomizationOutput) SetRequestId(v string) *CreateAccountCustomizationOutput { +func (s *CreateAnalysisOutput) SetRequestId(v string) *CreateAnalysisOutput { s.RequestId = &v return s } // SetStatus sets the Status field's value. -func (s *CreateAccountCustomizationOutput) SetStatus(v int64) *CreateAccountCustomizationOutput { +func (s *CreateAnalysisOutput) SetStatus(v int64) *CreateAnalysisOutput { s.Status = &v return s } @@ -10993,7 +12653,7 @@ type CreateDashboardInput struct { // ad hoc (one-time) filtering. This option is ENABLED by default. // // * AvailabilityStatus for ExportToCSVOption - This status can be either - // ENABLED or DISABLED. The visual option to export data to .csv format isn't + // ENABLED or DISABLED. The visual option to export data to .CSV format isn't // enabled when this is set to DISABLED. This option is ENABLED by default. // // * VisibilityState for SheetControlsOption - This visibility state can @@ -11011,7 +12671,10 @@ type CreateDashboardInput struct { Parameters *Parameters `type:"structure"` // A structure that contains the permissions of the dashboard. You can use this - // structure for granting permissions with principal and action information. + // structure for granting permissions by providing a list of IAM action information + // for each principal ARN. + // + // To specify no permissions, omit the permissions list. Permissions []*ResourcePermission `min:"1" type:"list"` // The entity that you are using as a source when you create the dashboard. @@ -12501,7 +14164,7 @@ type CreateNamespaceOutput struct { // The status of the creation of the namespace. This is an asynchronous process. // A status of CREATED means that your namespace is ready to use. If an error // occurs, it indicates if the process is retryable or non-retryable. In the - // case of a non-retryable error, refer to the error message for follow-up actions. + // case of a non-retryable error, refer to the error message for follow-up tasks. CreationStatus *string `type:"string" enum:"NamespaceStatus"` // Specifies the type of your user identity directory. Currently, this supports @@ -13315,12 +14978,12 @@ type CredentialPair struct { // A set of alternate data source parameters that you want to share for these // credentials. The credentials are applied in tandem with the data source parameters // when you copy a data source by using a create or update request. The API - // compares the DataSourceParameters structure that's in the request with the - // structures in the AlternateDataSourceParameters allowlist. If the structures - // are an exact match, the request is allowed to use the new data source with - // the existing credentials. If the AlternateDataSourceParameters list is null, - // the DataSourceParameters originally used with these Credentials is automatically - // allowed. + // operation compares the DataSourceParameters structure that's in the request + // with the structures in the AlternateDataSourceParameters allowlist. If the + // structures are an exact match, the request is allowed to use the new data + // source with the existing credentials. If the AlternateDataSourceParameters + // list is null, the DataSourceParameters originally used with these Credentials + // is automatically allowed. AlternateDataSourceParameters []*DataSourceParameters `min:"1" type:"list"` // Password. @@ -13899,13 +15562,13 @@ type DashboardVersion struct { CreatedTime *time.Time `type:"timestamp"` // The Amazon Resource Numbers (ARNs) for the datasets that are associated with - // a version of the dashboard. + // this version of the dashboard. DataSetArns []*string `type:"list"` // Description. Description *string `min:"1" type:"string"` - // Errors. + // Errors associated with this dashboard version. Errors []*DashboardError `min:"1" type:"list"` // Source entity ARN. @@ -13914,7 +15577,10 @@ type DashboardVersion struct { // The HTTP status of the request. Status *string `type:"string" enum:"ResourceStatus"` - // Version number. + // The ARN of the theme associated with a version of the dashboard. + ThemeArn *string `type:"string"` + + // Version number for this version of the dashboard. VersionNumber *int64 `min:"1" type:"long"` } @@ -13970,6 +15636,12 @@ func (s *DashboardVersion) SetStatus(v string) *DashboardVersion { return s } +// SetThemeArn sets the ThemeArn field's value. +func (s *DashboardVersion) SetThemeArn(v string) *DashboardVersion { + s.ThemeArn = &v + return s +} + // SetVersionNumber sets the VersionNumber field's value. func (s *DashboardVersion) SetVersionNumber(v int64) *DashboardVersion { s.VersionNumber = &v @@ -14421,8 +16093,8 @@ type DataSource struct { // A set of alternate data source parameters that you want to share for the // credentials stored with this data source. The credentials are applied in // tandem with the data source parameters when you copy a data source by using - // a create or update request. The API compares the DataSourceParameters structure - // that's in the request with the structures in the AlternateDataSourceParameters + // a create or update request. The API operation compares the DataSourceParameters + // structure that's in the request with the structures in the AlternateDataSourceParameters // allowlist. If the structures are an exact match, the request is allowed to // use the credentials from this existing data source. If the AlternateDataSourceParameters // list is null, the Credentials originally used with this DataSourceParameters @@ -14930,16 +16602,16 @@ func (s *DataSourceParameters) SetTwitterParameters(v *TwitterParameters) *DataS return s } -// Date time parameter. +// A date-time parameter. type DateTimeParameter struct { _ struct{} `type:"structure"` - // A display name for the dataset. + // A display name for the date-time parameter. // // Name is a required field Name *string `type:"string" required:"true"` - // Values. + // The values for the date-time parameter. // // Values is a required field Values []*time.Time `type:"list" required:"true"` @@ -14983,16 +16655,16 @@ func (s *DateTimeParameter) SetValues(v []*time.Time) *DateTimeParameter { return s } -// Decimal parameter. +// A decimal parameter. type DecimalParameter struct { _ struct{} `type:"structure"` - // A display name for the dataset. + // A display name for the decimal parameter. // // Name is a required field Name *string `type:"string" required:"true"` - // Values. + // The values for the decimal parameter. // // Values is a required field Values []*float64 `type:"list" required:"true"` @@ -15018,56 +16690,159 @@ func (s *DecimalParameter) Validate() error { invalidParams.Add(request.NewErrParamRequired("Values")) } - if invalidParams.Len() > 0 { - return invalidParams - } - return nil + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *DecimalParameter) SetName(v string) *DecimalParameter { + s.Name = &v + return s +} + +// SetValues sets the Values field's value. +func (s *DecimalParameter) SetValues(v []*float64) *DecimalParameter { + s.Values = v + return s +} + +type DeleteAccountCustomizationInput struct { + _ struct{} `type:"structure"` + + // The ID for the AWS account that you want to delete QuickSight customizations + // from in this AWS Region. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The QuickSight namespace that you're deleting the customizations from. + Namespace *string `location:"querystring" locationName:"namespace" type:"string"` +} + +// String returns the string representation +func (s DeleteAccountCustomizationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteAccountCustomizationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteAccountCustomizationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteAccountCustomizationInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *DeleteAccountCustomizationInput) SetAwsAccountId(v string) *DeleteAccountCustomizationInput { + s.AwsAccountId = &v + return s +} + +// SetNamespace sets the Namespace field's value. +func (s *DeleteAccountCustomizationInput) SetNamespace(v string) *DeleteAccountCustomizationInput { + s.Namespace = &v + return s +} + +type DeleteAccountCustomizationOutput struct { + _ struct{} `type:"structure"` + + // The AWS request ID for this operation. + RequestId *string `type:"string"` + + // The HTTP status of the request. + Status *int64 `location:"statusCode" type:"integer"` +} + +// String returns the string representation +func (s DeleteAccountCustomizationOutput) String() string { + return awsutil.Prettify(s) } -// SetName sets the Name field's value. -func (s *DecimalParameter) SetName(v string) *DecimalParameter { - s.Name = &v +// GoString returns the string representation +func (s DeleteAccountCustomizationOutput) GoString() string { + return s.String() +} + +// SetRequestId sets the RequestId field's value. +func (s *DeleteAccountCustomizationOutput) SetRequestId(v string) *DeleteAccountCustomizationOutput { + s.RequestId = &v return s } -// SetValues sets the Values field's value. -func (s *DecimalParameter) SetValues(v []*float64) *DecimalParameter { - s.Values = v +// SetStatus sets the Status field's value. +func (s *DeleteAccountCustomizationOutput) SetStatus(v int64) *DeleteAccountCustomizationOutput { + s.Status = &v return s } -type DeleteAccountCustomizationInput struct { +type DeleteAnalysisInput struct { _ struct{} `type:"structure"` - // The ID for the AWS account that you want to delete QuickSight customizations - // from. + // The ID of the analysis that you're deleting. + // + // AnalysisId is a required field + AnalysisId *string `location:"uri" locationName:"AnalysisId" min:"1" type:"string" required:"true"` + + // The ID of the AWS account where you want to delete an analysis. // // AwsAccountId is a required field AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` - // The namespace associated with the customization that you're deleting. - Namespace *string `location:"querystring" locationName:"namespace" type:"string"` + // This option defaults to the value NoForceDeleteWithoutRecovery. To immediately + // delete the analysis, add the ForceDeleteWithoutRecovery option. You can't + // restore an analysis after it's deleted. + ForceDeleteWithoutRecovery *bool `location:"querystring" locationName:"force-delete-without-recovery" type:"boolean"` + + // A value that specifies the number of days that QuickSight waits before it + // deletes the analysis. You can't use this parameter with the ForceDeleteWithoutRecovery + // option in the same API call. The default value is 30. + RecoveryWindowInDays *int64 `location:"querystring" locationName:"recovery-window-in-days" min:"7" type:"long"` } // String returns the string representation -func (s DeleteAccountCustomizationInput) String() string { +func (s DeleteAnalysisInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DeleteAccountCustomizationInput) GoString() string { +func (s DeleteAnalysisInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteAccountCustomizationInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteAccountCustomizationInput"} +func (s *DeleteAnalysisInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteAnalysisInput"} + if s.AnalysisId == nil { + invalidParams.Add(request.NewErrParamRequired("AnalysisId")) + } + if s.AnalysisId != nil && len(*s.AnalysisId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AnalysisId", 1)) + } if s.AwsAccountId == nil { invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) } if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) } + if s.RecoveryWindowInDays != nil && *s.RecoveryWindowInDays < 7 { + invalidParams.Add(request.NewErrParamMinValue("RecoveryWindowInDays", 7)) + } if invalidParams.Len() > 0 { return invalidParams @@ -15075,21 +16850,42 @@ func (s *DeleteAccountCustomizationInput) Validate() error { return nil } +// SetAnalysisId sets the AnalysisId field's value. +func (s *DeleteAnalysisInput) SetAnalysisId(v string) *DeleteAnalysisInput { + s.AnalysisId = &v + return s +} + // SetAwsAccountId sets the AwsAccountId field's value. -func (s *DeleteAccountCustomizationInput) SetAwsAccountId(v string) *DeleteAccountCustomizationInput { +func (s *DeleteAnalysisInput) SetAwsAccountId(v string) *DeleteAnalysisInput { s.AwsAccountId = &v return s } -// SetNamespace sets the Namespace field's value. -func (s *DeleteAccountCustomizationInput) SetNamespace(v string) *DeleteAccountCustomizationInput { - s.Namespace = &v +// SetForceDeleteWithoutRecovery sets the ForceDeleteWithoutRecovery field's value. +func (s *DeleteAnalysisInput) SetForceDeleteWithoutRecovery(v bool) *DeleteAnalysisInput { + s.ForceDeleteWithoutRecovery = &v return s } -type DeleteAccountCustomizationOutput struct { +// SetRecoveryWindowInDays sets the RecoveryWindowInDays field's value. +func (s *DeleteAnalysisInput) SetRecoveryWindowInDays(v int64) *DeleteAnalysisInput { + s.RecoveryWindowInDays = &v + return s +} + +type DeleteAnalysisOutput struct { _ struct{} `type:"structure"` + // The ID of the deleted analysis. + AnalysisId *string `min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of the deleted analysis. + Arn *string `type:"string"` + + // The date and time that the analysis is scheduled to be deleted. + DeletionTime *time.Time `type:"timestamp"` + // The AWS request ID for this operation. RequestId *string `type:"string"` @@ -15098,23 +16894,41 @@ type DeleteAccountCustomizationOutput struct { } // String returns the string representation -func (s DeleteAccountCustomizationOutput) String() string { +func (s DeleteAnalysisOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DeleteAccountCustomizationOutput) GoString() string { +func (s DeleteAnalysisOutput) GoString() string { return s.String() } +// SetAnalysisId sets the AnalysisId field's value. +func (s *DeleteAnalysisOutput) SetAnalysisId(v string) *DeleteAnalysisOutput { + s.AnalysisId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *DeleteAnalysisOutput) SetArn(v string) *DeleteAnalysisOutput { + s.Arn = &v + return s +} + +// SetDeletionTime sets the DeletionTime field's value. +func (s *DeleteAnalysisOutput) SetDeletionTime(v time.Time) *DeleteAnalysisOutput { + s.DeletionTime = &v + return s +} + // SetRequestId sets the RequestId field's value. -func (s *DeleteAccountCustomizationOutput) SetRequestId(v string) *DeleteAccountCustomizationOutput { +func (s *DeleteAnalysisOutput) SetRequestId(v string) *DeleteAnalysisOutput { s.RequestId = &v return s } // SetStatus sets the Status field's value. -func (s *DeleteAccountCustomizationOutput) SetStatus(v int64) *DeleteAccountCustomizationOutput { +func (s *DeleteAnalysisOutput) SetStatus(v int64) *DeleteAnalysisOutput { s.Status = &v return s } @@ -16593,15 +18407,222 @@ func (s *DeleteUserInput) SetNamespace(v string) *DeleteUserInput { return s } -// SetUserName sets the UserName field's value. -func (s *DeleteUserInput) SetUserName(v string) *DeleteUserInput { - s.UserName = &v +// SetUserName sets the UserName field's value. +func (s *DeleteUserInput) SetUserName(v string) *DeleteUserInput { + s.UserName = &v + return s +} + +type DeleteUserOutput struct { + _ struct{} `type:"structure"` + + // The AWS request ID for this operation. + RequestId *string `type:"string"` + + // The HTTP status of the request. + Status *int64 `location:"statusCode" type:"integer"` +} + +// String returns the string representation +func (s DeleteUserOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteUserOutput) GoString() string { + return s.String() +} + +// SetRequestId sets the RequestId field's value. +func (s *DeleteUserOutput) SetRequestId(v string) *DeleteUserOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DeleteUserOutput) SetStatus(v int64) *DeleteUserOutput { + s.Status = &v + return s +} + +type DescribeAccountCustomizationInput struct { + _ struct{} `type:"structure"` + + // The ID for the AWS account that you want to describe QuickSight customizations + // for. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The QuickSight namespace that you want to describe QuickSight customizations + // for. + Namespace *string `location:"querystring" locationName:"namespace" type:"string"` + + // The Resolved flag works with the other parameters to determine which view + // of QuickSight customizations is returned. You can add this flag to your command + // to use the same view that QuickSight uses to identify which customizations + // to apply to the console. Omit this flag, or set it to no-resolved, to reveal + // customizations that are configured at different levels. + Resolved *bool `location:"querystring" locationName:"resolved" type:"boolean"` +} + +// String returns the string representation +func (s DescribeAccountCustomizationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeAccountCustomizationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeAccountCustomizationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeAccountCustomizationInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *DescribeAccountCustomizationInput) SetAwsAccountId(v string) *DescribeAccountCustomizationInput { + s.AwsAccountId = &v + return s +} + +// SetNamespace sets the Namespace field's value. +func (s *DescribeAccountCustomizationInput) SetNamespace(v string) *DescribeAccountCustomizationInput { + s.Namespace = &v + return s +} + +// SetResolved sets the Resolved field's value. +func (s *DescribeAccountCustomizationInput) SetResolved(v bool) *DescribeAccountCustomizationInput { + s.Resolved = &v + return s +} + +type DescribeAccountCustomizationOutput struct { + _ struct{} `type:"structure"` + + // The QuickSight customizations that exist in the current AWS Region. + AccountCustomization *AccountCustomization `type:"structure"` + + // The ID for the AWS account that you're describing. + AwsAccountId *string `min:"12" type:"string"` + + // The QuickSight namespace that you're describing. + Namespace *string `type:"string"` + + // The AWS request ID for this operation. + RequestId *string `type:"string"` + + // The HTTP status of the request. + Status *int64 `location:"statusCode" type:"integer"` +} + +// String returns the string representation +func (s DescribeAccountCustomizationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeAccountCustomizationOutput) GoString() string { + return s.String() +} + +// SetAccountCustomization sets the AccountCustomization field's value. +func (s *DescribeAccountCustomizationOutput) SetAccountCustomization(v *AccountCustomization) *DescribeAccountCustomizationOutput { + s.AccountCustomization = v + return s +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *DescribeAccountCustomizationOutput) SetAwsAccountId(v string) *DescribeAccountCustomizationOutput { + s.AwsAccountId = &v + return s +} + +// SetNamespace sets the Namespace field's value. +func (s *DescribeAccountCustomizationOutput) SetNamespace(v string) *DescribeAccountCustomizationOutput { + s.Namespace = &v + return s +} + +// SetRequestId sets the RequestId field's value. +func (s *DescribeAccountCustomizationOutput) SetRequestId(v string) *DescribeAccountCustomizationOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeAccountCustomizationOutput) SetStatus(v int64) *DescribeAccountCustomizationOutput { + s.Status = &v + return s +} + +type DescribeAccountSettingsInput struct { + _ struct{} `type:"structure"` + + // The ID for the AWS account that contains the settings that you want to list. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` +} + +// String returns the string representation +func (s DescribeAccountSettingsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeAccountSettingsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeAccountSettingsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeAccountSettingsInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *DescribeAccountSettingsInput) SetAwsAccountId(v string) *DescribeAccountSettingsInput { + s.AwsAccountId = &v return s } -type DeleteUserOutput struct { +type DescribeAccountSettingsOutput struct { _ struct{} `type:"structure"` + // The QuickSight settings for this AWS account. This information includes the + // edition of Amazon QuickSight that you subscribed to (Standard or Enterprise) + // and the notification email for the QuickSight subscription. The QuickSight + // console, the QuickSight subscription is sometimes referred to as a QuickSight + // "account" even though it's technically not an account by itself. Instead, + // it's a subscription to the QuickSight service for your AWS account. The edition + // that you subscribe to applies to QuickSight in every AWS Region where you + // use it. + AccountSettings *AccountSettings `type:"structure"` + // The AWS request ID for this operation. RequestId *string `type:"string"` @@ -16610,57 +18631,68 @@ type DeleteUserOutput struct { } // String returns the string representation -func (s DeleteUserOutput) String() string { +func (s DescribeAccountSettingsOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DeleteUserOutput) GoString() string { +func (s DescribeAccountSettingsOutput) GoString() string { return s.String() } +// SetAccountSettings sets the AccountSettings field's value. +func (s *DescribeAccountSettingsOutput) SetAccountSettings(v *AccountSettings) *DescribeAccountSettingsOutput { + s.AccountSettings = v + return s +} + // SetRequestId sets the RequestId field's value. -func (s *DeleteUserOutput) SetRequestId(v string) *DeleteUserOutput { +func (s *DescribeAccountSettingsOutput) SetRequestId(v string) *DescribeAccountSettingsOutput { s.RequestId = &v return s } // SetStatus sets the Status field's value. -func (s *DeleteUserOutput) SetStatus(v int64) *DeleteUserOutput { +func (s *DescribeAccountSettingsOutput) SetStatus(v int64) *DescribeAccountSettingsOutput { s.Status = &v return s } -type DescribeAccountCustomizationInput struct { +type DescribeAnalysisInput struct { _ struct{} `type:"structure"` - // The ID for the AWS account that you want to describe QuickSight customizations - // for. + // The ID of the analysis that you're describing. The ID is part of the URL + // of the analysis. + // + // AnalysisId is a required field + AnalysisId *string `location:"uri" locationName:"AnalysisId" min:"1" type:"string" required:"true"` + + // The ID of the AWS account that contains the analysis. You must be using the + // AWS account that the analysis is in. // // AwsAccountId is a required field AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` - - // The namespace associated with the customization that you're describing. - Namespace *string `location:"querystring" locationName:"namespace" type:"string"` - - // The status of the creation of the customization. This is an asynchronous - // process. A status of CREATED means that your customization is ready to use. - Resolved *bool `location:"querystring" locationName:"resolved" type:"boolean"` } // String returns the string representation -func (s DescribeAccountCustomizationInput) String() string { +func (s DescribeAnalysisInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DescribeAccountCustomizationInput) GoString() string { +func (s DescribeAnalysisInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeAccountCustomizationInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeAccountCustomizationInput"} +func (s *DescribeAnalysisInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeAnalysisInput"} + if s.AnalysisId == nil { + invalidParams.Add(request.NewErrParamRequired("AnalysisId")) + } + if s.AnalysisId != nil && len(*s.AnalysisId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AnalysisId", 1)) + } if s.AwsAccountId == nil { invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) } @@ -16674,36 +18706,24 @@ func (s *DescribeAccountCustomizationInput) Validate() error { return nil } -// SetAwsAccountId sets the AwsAccountId field's value. -func (s *DescribeAccountCustomizationInput) SetAwsAccountId(v string) *DescribeAccountCustomizationInput { - s.AwsAccountId = &v - return s -} - -// SetNamespace sets the Namespace field's value. -func (s *DescribeAccountCustomizationInput) SetNamespace(v string) *DescribeAccountCustomizationInput { - s.Namespace = &v +// SetAnalysisId sets the AnalysisId field's value. +func (s *DescribeAnalysisInput) SetAnalysisId(v string) *DescribeAnalysisInput { + s.AnalysisId = &v return s } -// SetResolved sets the Resolved field's value. -func (s *DescribeAccountCustomizationInput) SetResolved(v bool) *DescribeAccountCustomizationInput { - s.Resolved = &v +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *DescribeAnalysisInput) SetAwsAccountId(v string) *DescribeAnalysisInput { + s.AwsAccountId = &v return s } -type DescribeAccountCustomizationOutput struct { +type DescribeAnalysisOutput struct { _ struct{} `type:"structure"` - // The customizations associated with QuickSight. - AccountCustomization *AccountCustomization `type:"structure"` - - // The ID for the AWS account that you want to describe QuickSight customizations - // for. - AwsAccountId *string `min:"12" type:"string"` - - // The namespace associated with the customization that you're describing. - Namespace *string `type:"string"` + // A metadata structure that contains summary information for the analysis that + // you're describing. + Analysis *Analysis `type:"structure"` // The AWS request ID for this operation. RequestId *string `type:"string"` @@ -16713,68 +18733,68 @@ type DescribeAccountCustomizationOutput struct { } // String returns the string representation -func (s DescribeAccountCustomizationOutput) String() string { +func (s DescribeAnalysisOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DescribeAccountCustomizationOutput) GoString() string { +func (s DescribeAnalysisOutput) GoString() string { return s.String() } -// SetAccountCustomization sets the AccountCustomization field's value. -func (s *DescribeAccountCustomizationOutput) SetAccountCustomization(v *AccountCustomization) *DescribeAccountCustomizationOutput { - s.AccountCustomization = v - return s -} - -// SetAwsAccountId sets the AwsAccountId field's value. -func (s *DescribeAccountCustomizationOutput) SetAwsAccountId(v string) *DescribeAccountCustomizationOutput { - s.AwsAccountId = &v - return s -} - -// SetNamespace sets the Namespace field's value. -func (s *DescribeAccountCustomizationOutput) SetNamespace(v string) *DescribeAccountCustomizationOutput { - s.Namespace = &v +// SetAnalysis sets the Analysis field's value. +func (s *DescribeAnalysisOutput) SetAnalysis(v *Analysis) *DescribeAnalysisOutput { + s.Analysis = v return s } // SetRequestId sets the RequestId field's value. -func (s *DescribeAccountCustomizationOutput) SetRequestId(v string) *DescribeAccountCustomizationOutput { +func (s *DescribeAnalysisOutput) SetRequestId(v string) *DescribeAnalysisOutput { s.RequestId = &v return s } // SetStatus sets the Status field's value. -func (s *DescribeAccountCustomizationOutput) SetStatus(v int64) *DescribeAccountCustomizationOutput { +func (s *DescribeAnalysisOutput) SetStatus(v int64) *DescribeAnalysisOutput { s.Status = &v return s } -type DescribeAccountSettingsInput struct { +type DescribeAnalysisPermissionsInput struct { _ struct{} `type:"structure"` - // The ID for the AWS account that contains the QuickSight namespaces that you - // want to list. + // The ID of the analysis whose permissions you're describing. The ID is part + // of the analysis URL. + // + // AnalysisId is a required field + AnalysisId *string `location:"uri" locationName:"AnalysisId" min:"1" type:"string" required:"true"` + + // The ID of the AWS account that contains the analysis whose permissions you're + // describing. You must be using the AWS account that the analysis is in. // // AwsAccountId is a required field AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` } // String returns the string representation -func (s DescribeAccountSettingsInput) String() string { +func (s DescribeAnalysisPermissionsInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DescribeAccountSettingsInput) GoString() string { +func (s DescribeAnalysisPermissionsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeAccountSettingsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeAccountSettingsInput"} +func (s *DescribeAnalysisPermissionsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeAnalysisPermissionsInput"} + if s.AnalysisId == nil { + invalidParams.Add(request.NewErrParamRequired("AnalysisId")) + } + if s.AnalysisId != nil && len(*s.AnalysisId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AnalysisId", 1)) + } if s.AwsAccountId == nil { invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) } @@ -16788,22 +18808,30 @@ func (s *DescribeAccountSettingsInput) Validate() error { return nil } +// SetAnalysisId sets the AnalysisId field's value. +func (s *DescribeAnalysisPermissionsInput) SetAnalysisId(v string) *DescribeAnalysisPermissionsInput { + s.AnalysisId = &v + return s +} + // SetAwsAccountId sets the AwsAccountId field's value. -func (s *DescribeAccountSettingsInput) SetAwsAccountId(v string) *DescribeAccountSettingsInput { +func (s *DescribeAnalysisPermissionsInput) SetAwsAccountId(v string) *DescribeAnalysisPermissionsInput { s.AwsAccountId = &v return s } -type DescribeAccountSettingsOutput struct { +type DescribeAnalysisPermissionsOutput struct { _ struct{} `type:"structure"` - // The settings associated with the QuickSight subscription associated with - // this AWS account. This information includes the edition of Amazon QuickSight - // that you subscribed to (Standard or Enterprise) and the notification email - // for the QuickSight subscription. The QuickSight console, the QuickSight subscription - // is sometimes referred to as a QuickSight "account" even though it is technically - // not an account, but a subscription in your AWS account. - AccountSettings *AccountSettings `type:"structure"` + // The Amazon Resource Name (ARN) of the analysis whose permissions you're describing. + AnalysisArn *string `type:"string"` + + // The ID of the analysis whose permissions you're describing. + AnalysisId *string `min:"1" type:"string"` + + // A structure that describes the principals and the resource-level permissions + // on an analysis. + Permissions []*ResourcePermission `min:"1" type:"list"` // The AWS request ID for this operation. RequestId *string `type:"string"` @@ -16813,29 +18841,41 @@ type DescribeAccountSettingsOutput struct { } // String returns the string representation -func (s DescribeAccountSettingsOutput) String() string { +func (s DescribeAnalysisPermissionsOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DescribeAccountSettingsOutput) GoString() string { +func (s DescribeAnalysisPermissionsOutput) GoString() string { return s.String() } -// SetAccountSettings sets the AccountSettings field's value. -func (s *DescribeAccountSettingsOutput) SetAccountSettings(v *AccountSettings) *DescribeAccountSettingsOutput { - s.AccountSettings = v +// SetAnalysisArn sets the AnalysisArn field's value. +func (s *DescribeAnalysisPermissionsOutput) SetAnalysisArn(v string) *DescribeAnalysisPermissionsOutput { + s.AnalysisArn = &v + return s +} + +// SetAnalysisId sets the AnalysisId field's value. +func (s *DescribeAnalysisPermissionsOutput) SetAnalysisId(v string) *DescribeAnalysisPermissionsOutput { + s.AnalysisId = &v + return s +} + +// SetPermissions sets the Permissions field's value. +func (s *DescribeAnalysisPermissionsOutput) SetPermissions(v []*ResourcePermission) *DescribeAnalysisPermissionsOutput { + s.Permissions = v return s } // SetRequestId sets the RequestId field's value. -func (s *DescribeAccountSettingsOutput) SetRequestId(v string) *DescribeAccountSettingsOutput { +func (s *DescribeAnalysisPermissionsOutput) SetRequestId(v string) *DescribeAnalysisPermissionsOutput { s.RequestId = &v return s } // SetStatus sets the Status field's value. -func (s *DescribeAccountSettingsOutput) SetStatus(v int64) *DescribeAccountSettingsOutput { +func (s *DescribeAnalysisPermissionsOutput) SetStatus(v int64) *DescribeAnalysisPermissionsOutput { s.Status = &v return s } @@ -17934,8 +19974,8 @@ type DescribeNamespaceOutput struct { // The information about the namespace that you're describing. The response // includes the namespace ARN, name, AWS Region, creation status, and identity // store. DescribeNamespace also works for namespaces that are in the process - // of being created. For incomplete namespaces, this API lists the namespace - // error types and messages associated with the creation process. + // of being created. For incomplete namespaces, this API operation lists the + // namespace error types and messages associated with the creation process. Namespace *NamespaceInfoV2 `type:"structure"` // The AWS request ID for this operation. @@ -19086,6 +21126,9 @@ type GetDashboardEmbedUrlInput struct { // // * IAM users and IAM role-based sessions authenticated through Federated // Single Sign-On using SAML, OpenID Connect, or IAM federation. + // + // Omit this parameter for users in the third group – IAM users and IAM role-based + // sessions. UserArn *string `location:"querystring" locationName:"user-arn" type:"string"` } @@ -19173,9 +21216,9 @@ type GetDashboardEmbedUrlOutput struct { _ struct{} `type:"structure"` // A single-use URL that you can put into your server-side webpage to embed - // your dashboard. This URL is valid for 5 minutes. The API provides the URL - // with an auth_code value that enables one (and only one) sign-on to a user - // session that is valid for 10 hours. + // your dashboard. This URL is valid for 5 minutes. The API operation provides + // the URL with an auth_code value that enables one (and only one) sign-on to + // a user session that is valid for 10 hours. EmbedUrl *string `type:"string" sensitive:"true"` // The AWS request ID for this operation. @@ -19216,13 +21259,27 @@ func (s *GetDashboardEmbedUrlOutput) SetStatus(v int64) *GetDashboardEmbedUrlOut type GetSessionEmbedUrlInput struct { _ struct{} `type:"structure"` - // The ID for the AWS account that contains the QuickSight session that you're - // embedding. + // The ID for the AWS account associated with your QuickSight subscription. // // AwsAccountId is a required field AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` - // The entry point for the embedded session. + // The URL you use to access the embedded session. The entry point URL is constrained + // to the following paths: + // + // * /start + // + // * /start/analyses + // + // * /start/dashboards + // + // * /start/favorites + // + // * /dashboards/DashboardId - where DashboardId is the actual ID key from + // the QuickSight console URL of the dashboard + // + // * /analyses/AnalysisId - where AnalysisId is the actual ID key from the + // QuickSight console URL of the analysis EntryPoint *string `location:"querystring" locationName:"entry-point" min:"1" type:"string"` // How many minutes the session is valid. The session lifetime must be 15-600 @@ -19230,15 +21287,19 @@ type GetSessionEmbedUrlInput struct { SessionLifetimeInMinutes *int64 `location:"querystring" locationName:"session-lifetime" min:"15" type:"long"` // The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT - // identity type. You can use this for any Amazon QuickSight users in your account - // (readers, authors, or admins) authenticated as one of the following: + // identity type. You can use this for any type of Amazon QuickSight users in + // your account (readers, authors, or admins). They need to be authenticated + // as one of the following: // - // * Active Directory (AD) users or group members + // Active Directory (AD) users or group members // - // * Invited nonfederated users + // Invited nonfederated users // - // * IAM users and IAM role-based sessions authenticated through Federated - // Single Sign-On using SAML, OpenID Connect, or IAM federation. + // IAM users and IAM role-based sessions authenticated through Federated Single + // Sign-On using SAML, OpenID Connect, or IAM federation + // + // Omit this parameter for users in the third group – IAM users and IAM role-based + // sessions. UserArn *string `location:"querystring" locationName:"user-arn" type:"string"` } @@ -19302,9 +21363,9 @@ type GetSessionEmbedUrlOutput struct { _ struct{} `type:"structure"` // A single-use URL that you can put into your server-side web page to embed - // your QuickSight session. This URL is valid for 5 minutes. The API provides - // the URL with an auth_code value that enables one (and only one) sign-on to - // a user session that is valid for 10 hours. + // your QuickSight session. This URL is valid for 5 minutes. The API operation + // provides the URL with an auth_code value that enables one (and only one) + // sign-on to a user session that is valid for 10 hours. EmbedUrl *string `type:"string" sensitive:"true"` // The AWS request ID for this operation. @@ -19343,8 +21404,7 @@ func (s *GetSessionEmbedUrlOutput) SetStatus(v int64) *GetSessionEmbedUrlOutput } // A group in Amazon QuickSight consists of a set of users. You can use groups -// to make it easier to manage access and security. Currently, an Amazon QuickSight -// subscription can't contain more than 500 Amazon QuickSight groups. +// to make it easier to manage access and security. type Group struct { _ struct{} `type:"structure"` @@ -19792,16 +21852,16 @@ func (s *InputColumn) SetType(v string) *InputColumn { return s } -// Integer parameter. +// An integer parameter. type IntegerParameter struct { _ struct{} `type:"structure"` - // A display name for the dataset. + // The name of the integer parameter. // // Name is a required field Name *string `type:"string" required:"true"` - // Values. + // The values for the integer parameter. // // Values is a required field Values []*int64 `type:"list" required:"true"` @@ -20120,8 +22180,138 @@ func (s *JoinInstruction) Validate() error { if s.RightOperand != nil && len(*s.RightOperand) < 1 { invalidParams.Add(request.NewErrParamMinLen("RightOperand", 1)) } - if s.Type == nil { - invalidParams.Add(request.NewErrParamRequired("Type")) + if s.Type == nil { + invalidParams.Add(request.NewErrParamRequired("Type")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLeftOperand sets the LeftOperand field's value. +func (s *JoinInstruction) SetLeftOperand(v string) *JoinInstruction { + s.LeftOperand = &v + return s +} + +// SetOnClause sets the OnClause field's value. +func (s *JoinInstruction) SetOnClause(v string) *JoinInstruction { + s.OnClause = &v + return s +} + +// SetRightOperand sets the RightOperand field's value. +func (s *JoinInstruction) SetRightOperand(v string) *JoinInstruction { + s.RightOperand = &v + return s +} + +// SetType sets the Type field's value. +func (s *JoinInstruction) SetType(v string) *JoinInstruction { + s.Type = &v + return s +} + +// A limit is exceeded. +type LimitExceededException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` + + // The AWS request ID for this request. + RequestId *string `type:"string"` + + // Limit exceeded. + ResourceType *string `type:"string" enum:"ExceptionResourceType"` +} + +// String returns the string representation +func (s LimitExceededException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s LimitExceededException) GoString() string { + return s.String() +} + +func newErrorLimitExceededException(v protocol.ResponseMetadata) error { + return &LimitExceededException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *LimitExceededException) Code() string { + return "LimitExceededException" +} + +// Message returns the exception's message. +func (s *LimitExceededException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *LimitExceededException) OrigErr() error { + return nil +} + +func (s *LimitExceededException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *LimitExceededException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *LimitExceededException) RequestID() string { + return s.RespMetadata.RequestID +} + +type ListAnalysesInput struct { + _ struct{} `type:"structure"` + + // The ID of the AWS account that contains the analyses. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The maximum number of results to return. + MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` + + // A pagination token that can be used in a subsequent request. + NextToken *string `location:"querystring" locationName:"next-token" type:"string"` +} + +// String returns the string representation +func (s ListAnalysesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListAnalysesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListAnalysesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAnalysesInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } if invalidParams.Len() > 0 { @@ -20130,90 +22320,72 @@ func (s *JoinInstruction) Validate() error { return nil } -// SetLeftOperand sets the LeftOperand field's value. -func (s *JoinInstruction) SetLeftOperand(v string) *JoinInstruction { - s.LeftOperand = &v +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *ListAnalysesInput) SetAwsAccountId(v string) *ListAnalysesInput { + s.AwsAccountId = &v return s } -// SetOnClause sets the OnClause field's value. -func (s *JoinInstruction) SetOnClause(v string) *JoinInstruction { - s.OnClause = &v +// SetMaxResults sets the MaxResults field's value. +func (s *ListAnalysesInput) SetMaxResults(v int64) *ListAnalysesInput { + s.MaxResults = &v return s } -// SetRightOperand sets the RightOperand field's value. -func (s *JoinInstruction) SetRightOperand(v string) *JoinInstruction { - s.RightOperand = &v +// SetNextToken sets the NextToken field's value. +func (s *ListAnalysesInput) SetNextToken(v string) *ListAnalysesInput { + s.NextToken = &v return s } -// SetType sets the Type field's value. -func (s *JoinInstruction) SetType(v string) *JoinInstruction { - s.Type = &v - return s -} +type ListAnalysesOutput struct { + _ struct{} `type:"structure"` -// A limit is exceeded. -type LimitExceededException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + // Metadata describing each of the analyses that are listed. + AnalysisSummaryList []*AnalysisSummary `type:"list"` - Message_ *string `locationName:"Message" type:"string"` + // A pagination token that can be used in a subsequent request. + NextToken *string `type:"string"` - // The AWS request ID for this request. + // The AWS request ID for this operation. RequestId *string `type:"string"` - // Limit exceeded. - ResourceType *string `type:"string" enum:"ExceptionResourceType"` + // The HTTP status of the request. + Status *int64 `location:"statusCode" type:"integer"` } // String returns the string representation -func (s LimitExceededException) String() string { +func (s ListAnalysesOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s LimitExceededException) GoString() string { +func (s ListAnalysesOutput) GoString() string { return s.String() } -func newErrorLimitExceededException(v protocol.ResponseMetadata) error { - return &LimitExceededException{ - RespMetadata: v, - } -} - -// Code returns the exception type name. -func (s *LimitExceededException) Code() string { - return "LimitExceededException" -} - -// Message returns the exception's message. -func (s *LimitExceededException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" -} - -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *LimitExceededException) OrigErr() error { - return nil +// SetAnalysisSummaryList sets the AnalysisSummaryList field's value. +func (s *ListAnalysesOutput) SetAnalysisSummaryList(v []*AnalysisSummary) *ListAnalysesOutput { + s.AnalysisSummaryList = v + return s } -func (s *LimitExceededException) Error() string { - return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +// SetNextToken sets the NextToken field's value. +func (s *ListAnalysesOutput) SetNextToken(v string) *ListAnalysesOutput { + s.NextToken = &v + return s } -// Status code returns the HTTP status code for the request's response error. -func (s *LimitExceededException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetRequestId sets the RequestId field's value. +func (s *ListAnalysesOutput) SetRequestId(v string) *ListAnalysesOutput { + s.RequestId = &v + return s } -// RequestID returns the service's response RequestID for request. -func (s *LimitExceededException) RequestID() string { - return s.RespMetadata.RequestID +// SetStatus sets the Status field's value. +func (s *ListAnalysesOutput) SetStatus(v int64) *ListAnalysesOutput { + s.Status = &v + return s } type ListDashboardVersionsInput struct { @@ -23030,7 +25202,7 @@ type NamespaceInfoV2 struct { // The name of the error. Name *string `type:"string"` - // An error that occured when the namespace was created. + // An error that occurred when the namespace was created. NamespaceError *NamespaceError `type:"structure"` } @@ -23113,11 +25285,11 @@ func (s *OutputColumn) SetType(v string) *OutputColumn { return s } -// Parameters. +// A list of QuickSight parameters and the list's override values. type Parameters struct { _ struct{} `type:"structure"` - // DateTime parameters. + // Date-time parameters. DateTimeParameters []*DateTimeParameter `type:"list"` // Decimal parameters. @@ -23718,24 +25890,27 @@ type RegisterUserInput struct { AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` // (Enterprise edition only) The name of the custom permissions profile that - // you want to assign to this user. Currently, custom permissions profile names - // are assigned to permissions profiles in the QuickSight console. You use this - // API to assign the named set of permissions to a QuickSight user. + // you want to assign to this user. Customized permissions allows you to control + // a user's access by restricting access the following operations: + // + // * Create and update data sources // - // Customizing permissions in the QuickSight UI allows you to control a user's - // access to the following operations: + // * Create and update datasets // - // * + // * Create and update email reports // - // * + // * Subscribe to email reports // - // * + // To add custom permissions to an existing user, use UpdateUser instead. // - // * + // A set of custom permissions includes any combination of these restrictions. + // Currently, you need to create the profile names for custom permission sets + // by using the QuickSight console. Then, you use the RegisterUser API operation + // to assign the named set of permissions to a QuickSight user. // // QuickSight custom permissions are applied through IAM policies. Therefore, // they override the permissions typically granted by assigning QuickSight users - // to one of the default security cohorts (admin, author, reader) in QuickSight. + // to one of the default security cohorts in QuickSight (admin, author, reader). // // This feature is available only to QuickSight Enterprise edition subscriptions // that use SAML 2.0-Based Federation for Single Sign-On (SSO). @@ -23910,7 +26085,7 @@ type RegisterUserOutput struct { // The HTTP status of the request. Status *int64 `location:"statusCode" type:"integer"` - // The user name. + // The user's user name. User *User `type:"structure"` // The URL the user visits to complete registration and provide a password. @@ -24231,7 +26406,7 @@ func (s *ResourceNotFoundException) RequestID() string { type ResourcePermission struct { _ struct{} `type:"structure"` - // The action to grant or revoke permissions on, for example "quicksight:DescribeDashboard". + // The IAM action to grant or revoke permissions on, for example "quicksight:DescribeDashboard". // // Actions is a required field Actions []*string `min:"1" type:"list" required:"true"` @@ -24355,6 +26530,114 @@ func (s *ResourceUnavailableException) RequestID() string { return s.RespMetadata.RequestID } +type RestoreAnalysisInput struct { + _ struct{} `type:"structure"` + + // The ID of the analysis that you're restoring. + // + // AnalysisId is a required field + AnalysisId *string `location:"uri" locationName:"AnalysisId" min:"1" type:"string" required:"true"` + + // The ID of the AWS account that contains the analysis. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` +} + +// String returns the string representation +func (s RestoreAnalysisInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s RestoreAnalysisInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RestoreAnalysisInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RestoreAnalysisInput"} + if s.AnalysisId == nil { + invalidParams.Add(request.NewErrParamRequired("AnalysisId")) + } + if s.AnalysisId != nil && len(*s.AnalysisId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AnalysisId", 1)) + } + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAnalysisId sets the AnalysisId field's value. +func (s *RestoreAnalysisInput) SetAnalysisId(v string) *RestoreAnalysisInput { + s.AnalysisId = &v + return s +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *RestoreAnalysisInput) SetAwsAccountId(v string) *RestoreAnalysisInput { + s.AwsAccountId = &v + return s +} + +type RestoreAnalysisOutput struct { + _ struct{} `type:"structure"` + + // The ID of the analysis that you're restoring. + AnalysisId *string `min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of the analysis that you're restoring. + Arn *string `type:"string"` + + // The AWS request ID for this operation. + RequestId *string `type:"string"` + + // The HTTP status of the request. + Status *int64 `location:"statusCode" type:"integer"` +} + +// String returns the string representation +func (s RestoreAnalysisOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s RestoreAnalysisOutput) GoString() string { + return s.String() +} + +// SetAnalysisId sets the AnalysisId field's value. +func (s *RestoreAnalysisOutput) SetAnalysisId(v string) *RestoreAnalysisOutput { + s.AnalysisId = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *RestoreAnalysisOutput) SetArn(v string) *RestoreAnalysisOutput { + s.Arn = &v + return s +} + +// SetRequestId sets the RequestId field's value. +func (s *RestoreAnalysisOutput) SetRequestId(v string) *RestoreAnalysisOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *RestoreAnalysisOutput) SetStatus(v int64) *RestoreAnalysisOutput { + s.Status = &v + return s +} + // Information about rows for a data set SPICE ingestion. type RowInfo struct { _ struct{} `type:"structure"` @@ -24551,27 +26834,154 @@ func (s *S3Source) Validate() error { } } - if invalidParams.Len() > 0 { - return invalidParams - } - return nil + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDataSourceArn sets the DataSourceArn field's value. +func (s *S3Source) SetDataSourceArn(v string) *S3Source { + s.DataSourceArn = &v + return s +} + +// SetInputColumns sets the InputColumns field's value. +func (s *S3Source) SetInputColumns(v []*InputColumn) *S3Source { + s.InputColumns = v + return s +} + +// SetUploadSettings sets the UploadSettings field's value. +func (s *S3Source) SetUploadSettings(v *UploadSettings) *S3Source { + s.UploadSettings = v + return s +} + +type SearchAnalysesInput struct { + _ struct{} `type:"structure"` + + // The ID of the AWS account that contains the analyses that you're searching + // for. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The structure for the search filters that you want to apply to your search. + // + // Filters is a required field + Filters []*AnalysisSearchFilter `type:"list" required:"true"` + + // The maximum number of results to return. + MaxResults *int64 `min:"1" type:"integer"` + + // A pagination token that can be used in a subsequent request. + NextToken *string `type:"string"` +} + +// String returns the string representation +func (s SearchAnalysesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s SearchAnalysesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SearchAnalysesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SearchAnalysesInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + if s.Filters == nil { + invalidParams.Add(request.NewErrParamRequired("Filters")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *SearchAnalysesInput) SetAwsAccountId(v string) *SearchAnalysesInput { + s.AwsAccountId = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *SearchAnalysesInput) SetFilters(v []*AnalysisSearchFilter) *SearchAnalysesInput { + s.Filters = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *SearchAnalysesInput) SetMaxResults(v int64) *SearchAnalysesInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchAnalysesInput) SetNextToken(v string) *SearchAnalysesInput { + s.NextToken = &v + return s +} + +type SearchAnalysesOutput struct { + _ struct{} `type:"structure"` + + // Metadata describing the analyses that you searched for. + AnalysisSummaryList []*AnalysisSummary `type:"list"` + + // A pagination token that can be used in a subsequent request. + NextToken *string `type:"string"` + + // The AWS request ID for this operation. + RequestId *string `type:"string"` + + // The HTTP status of the request. + Status *int64 `location:"statusCode" type:"integer"` } -// SetDataSourceArn sets the DataSourceArn field's value. -func (s *S3Source) SetDataSourceArn(v string) *S3Source { - s.DataSourceArn = &v +// String returns the string representation +func (s SearchAnalysesOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s SearchAnalysesOutput) GoString() string { + return s.String() +} + +// SetAnalysisSummaryList sets the AnalysisSummaryList field's value. +func (s *SearchAnalysesOutput) SetAnalysisSummaryList(v []*AnalysisSummary) *SearchAnalysesOutput { + s.AnalysisSummaryList = v return s } -// SetInputColumns sets the InputColumns field's value. -func (s *S3Source) SetInputColumns(v []*InputColumn) *S3Source { - s.InputColumns = v +// SetNextToken sets the NextToken field's value. +func (s *SearchAnalysesOutput) SetNextToken(v string) *SearchAnalysesOutput { + s.NextToken = &v return s } -// SetUploadSettings sets the UploadSettings field's value. -func (s *S3Source) SetUploadSettings(v *UploadSettings) *S3Source { - s.UploadSettings = v +// SetRequestId sets the RequestId field's value. +func (s *SearchAnalysesOutput) SetRequestId(v string) *SearchAnalysesOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *SearchAnalysesOutput) SetStatus(v int64) *SearchAnalysesOutput { + s.Status = &v return s } @@ -25107,16 +27517,16 @@ func (s *SslProperties) SetDisableSsl(v bool) *SslProperties { return s } -// String parameter. +// A string parameter. type StringParameter struct { _ struct{} `type:"structure"` - // A display name for the dataset. + // A display name for a string parameter. // // Name is a required field Name *string `type:"string" required:"true"` - // Values. + // The values of a string parameter. // // Values is a required field Values []*string `type:"list" required:"true"` @@ -25385,7 +27795,7 @@ func (s *TagResourceOutput) SetStatus(v int64) *TagResourceOutput { // A template object. A template is an entity in QuickSight that encapsulates // the metadata required to create an analysis and that you can use to create // a dashboard. A template adds a layer of abstraction by using placeholders -// to replace the dataset associated with the analysis. You can use templates +// to replace the dataset associated with an analysis. You can use templates // to create dashboards by replacing dataset placeholders with datasets that // follow the same schema that was used to create the source analysis and template. // @@ -25769,25 +28179,28 @@ type TemplateVersion struct { // The time that this template version was created. CreatedTime *time.Time `type:"timestamp"` - // Schema of the dataset identified by the placeholder. The idea is that any - // dashboard created from the template should be bound to new datasets matching - // the same schema described through this API. . + // Schema of the dataset identified by the placeholder. Any dashboard created + // from this template should be bound to new datasets matching the same schema + // described through this API operation. DataSetConfigurations []*DataSetConfiguration `type:"list"` // The description of the template. Description *string `min:"1" type:"string"` - // Errors associated with the template. + // Errors associated with this template version. Errors []*TemplateError `min:"1" type:"list"` - // The Amazon Resource Name (ARN) of the analysis or template which was used - // to create this template. + // The Amazon Resource Name (ARN) of an analysis or template that was used to + // create this template. SourceEntityArn *string `type:"string"` // The HTTP status of the request. Status *string `type:"string" enum:"ResourceStatus"` - // The version number of the template. + // The ARN of the theme associated with this version of the template. + ThemeArn *string `type:"string"` + + // The version number of the template version. VersionNumber *int64 `min:"1" type:"long"` } @@ -25837,6 +28250,12 @@ func (s *TemplateVersion) SetStatus(v string) *TemplateVersion { return s } +// SetThemeArn sets the ThemeArn field's value. +func (s *TemplateVersion) SetThemeArn(v string) *TemplateVersion { + s.ThemeArn = &v + return s +} + // SetVersionNumber sets the VersionNumber field's value. func (s *TemplateVersion) SetVersionNumber(v int64) *TemplateVersion { s.VersionNumber = &v @@ -25979,6 +28398,7 @@ func (s *TeradataParameters) SetPort(v int64) *TeradataParameters { return s } +// Summary information about a theme. type Theme struct { _ struct{} `type:"structure"` @@ -26949,11 +29369,230 @@ func (s *UntagResourceInput) Validate() error { if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) } - if s.TagKeys == nil { - invalidParams.Add(request.NewErrParamRequired("TagKeys")) + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + if s.TagKeys != nil && len(s.TagKeys) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TagKeys", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` + + // The AWS request ID for this operation. + RequestId *string `type:"string"` + + // The HTTP status of the request. + Status *int64 `location:"statusCode" type:"integer"` +} + +// String returns the string representation +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UntagResourceOutput) GoString() string { + return s.String() +} + +// SetRequestId sets the RequestId field's value. +func (s *UntagResourceOutput) SetRequestId(v string) *UntagResourceOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *UntagResourceOutput) SetStatus(v int64) *UntagResourceOutput { + s.Status = &v + return s +} + +type UpdateAccountCustomizationInput struct { + _ struct{} `type:"structure"` + + // The QuickSight customizations you're updating in the current AWS Region. + // + // AccountCustomization is a required field + AccountCustomization *AccountCustomization `type:"structure" required:"true"` + + // The ID for the AWS account that you want to update QuickSight customizations + // for. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The namespace that you want to update QuickSight customizations for. + Namespace *string `location:"querystring" locationName:"namespace" type:"string"` +} + +// String returns the string representation +func (s UpdateAccountCustomizationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateAccountCustomizationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateAccountCustomizationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateAccountCustomizationInput"} + if s.AccountCustomization == nil { + invalidParams.Add(request.NewErrParamRequired("AccountCustomization")) + } + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAccountCustomization sets the AccountCustomization field's value. +func (s *UpdateAccountCustomizationInput) SetAccountCustomization(v *AccountCustomization) *UpdateAccountCustomizationInput { + s.AccountCustomization = v + return s +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *UpdateAccountCustomizationInput) SetAwsAccountId(v string) *UpdateAccountCustomizationInput { + s.AwsAccountId = &v + return s +} + +// SetNamespace sets the Namespace field's value. +func (s *UpdateAccountCustomizationInput) SetNamespace(v string) *UpdateAccountCustomizationInput { + s.Namespace = &v + return s +} + +type UpdateAccountCustomizationOutput struct { + _ struct{} `type:"structure"` + + // The QuickSight customizations you're updating in the current AWS Region. + AccountCustomization *AccountCustomization `type:"structure"` + + // The ID for the AWS account that you want to update QuickSight customizations + // for. + AwsAccountId *string `min:"12" type:"string"` + + // The namespace associated with the customization that you're updating. + Namespace *string `type:"string"` + + // The AWS request ID for this operation. + RequestId *string `type:"string"` + + // The HTTP status of the request. + Status *int64 `location:"statusCode" type:"integer"` +} + +// String returns the string representation +func (s UpdateAccountCustomizationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateAccountCustomizationOutput) GoString() string { + return s.String() +} + +// SetAccountCustomization sets the AccountCustomization field's value. +func (s *UpdateAccountCustomizationOutput) SetAccountCustomization(v *AccountCustomization) *UpdateAccountCustomizationOutput { + s.AccountCustomization = v + return s +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *UpdateAccountCustomizationOutput) SetAwsAccountId(v string) *UpdateAccountCustomizationOutput { + s.AwsAccountId = &v + return s +} + +// SetNamespace sets the Namespace field's value. +func (s *UpdateAccountCustomizationOutput) SetNamespace(v string) *UpdateAccountCustomizationOutput { + s.Namespace = &v + return s +} + +// SetRequestId sets the RequestId field's value. +func (s *UpdateAccountCustomizationOutput) SetRequestId(v string) *UpdateAccountCustomizationOutput { + s.RequestId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *UpdateAccountCustomizationOutput) SetStatus(v int64) *UpdateAccountCustomizationOutput { + s.Status = &v + return s +} + +type UpdateAccountSettingsInput struct { + _ struct{} `type:"structure"` + + // The ID for the AWS account that contains the QuickSight settings that you + // want to list. + // + // AwsAccountId is a required field + AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` + + // The default namespace for this AWS Account. Currently, the default is default. + // IAM users who register for the first time with QuickSight provide an email + // that becomes associated with the default namespace. + // + // DefaultNamespace is a required field + DefaultNamespace *string `type:"string" required:"true"` + + // The email address that you want QuickSight to send notifications to regarding + // your AWS account or QuickSight subscription. + NotificationEmail *string `type:"string"` +} + +// String returns the string representation +func (s UpdateAccountSettingsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateAccountSettingsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateAccountSettingsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateAccountSettingsInput"} + if s.AwsAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) + } + if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) } - if s.TagKeys != nil && len(s.TagKeys) < 1 { - invalidParams.Add(request.NewErrParamMinLen("TagKeys", 1)) + if s.DefaultNamespace == nil { + invalidParams.Add(request.NewErrParamRequired("DefaultNamespace")) } if invalidParams.Len() > 0 { @@ -26962,19 +29601,25 @@ func (s *UntagResourceInput) Validate() error { return nil } -// SetResourceArn sets the ResourceArn field's value. -func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { - s.ResourceArn = &v +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *UpdateAccountSettingsInput) SetAwsAccountId(v string) *UpdateAccountSettingsInput { + s.AwsAccountId = &v return s } -// SetTagKeys sets the TagKeys field's value. -func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { - s.TagKeys = v +// SetDefaultNamespace sets the DefaultNamespace field's value. +func (s *UpdateAccountSettingsInput) SetDefaultNamespace(v string) *UpdateAccountSettingsInput { + s.DefaultNamespace = &v return s } -type UntagResourceOutput struct { +// SetNotificationEmail sets the NotificationEmail field's value. +func (s *UpdateAccountSettingsInput) SetNotificationEmail(v string) *UpdateAccountSettingsInput { + s.NotificationEmail = &v + return s +} + +type UpdateAccountSettingsOutput struct { _ struct{} `type:"structure"` // The AWS request ID for this operation. @@ -26985,60 +29630,82 @@ type UntagResourceOutput struct { } // String returns the string representation -func (s UntagResourceOutput) String() string { +func (s UpdateAccountSettingsOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s UntagResourceOutput) GoString() string { +func (s UpdateAccountSettingsOutput) GoString() string { return s.String() } // SetRequestId sets the RequestId field's value. -func (s *UntagResourceOutput) SetRequestId(v string) *UntagResourceOutput { +func (s *UpdateAccountSettingsOutput) SetRequestId(v string) *UpdateAccountSettingsOutput { s.RequestId = &v return s } // SetStatus sets the Status field's value. -func (s *UntagResourceOutput) SetStatus(v int64) *UntagResourceOutput { +func (s *UpdateAccountSettingsOutput) SetStatus(v int64) *UpdateAccountSettingsOutput { s.Status = &v return s } -type UpdateAccountCustomizationInput struct { +type UpdateAnalysisInput struct { _ struct{} `type:"structure"` - // The customizations you want to update in QuickSight. + // The ID for the analysis that you're updating. This ID displays in the URL + // of the analysis. // - // AccountCustomization is a required field - AccountCustomization *AccountCustomization `type:"structure" required:"true"` + // AnalysisId is a required field + AnalysisId *string `location:"uri" locationName:"AnalysisId" min:"1" type:"string" required:"true"` - // The ID for the AWS account that you want to update QuickSight customizations - // for. + // The ID of the AWS account that contains the analysis that you're updating. // // AwsAccountId is a required field AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` - // The namespace associated with the customization that you're updating. - Namespace *string `location:"querystring" locationName:"namespace" type:"string"` + // A descriptive name for the analysis that you're updating. This name displays + // for the analysis in the QuickSight console. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // The parameter names and override values that you want to use. An analysis + // can have any parameter type, and some parameters might accept multiple values. + Parameters *Parameters `type:"structure"` + + // A source entity to use for the analysis that you're updating. This metadata + // structure contains details that describe a source template and one or more + // datasets. + // + // SourceEntity is a required field + SourceEntity *AnalysisSourceEntity `type:"structure" required:"true"` + + // The Amazon Resource Name (ARN) for the theme to apply to the analysis that + // you're creating. To see the theme in the QuickSight console, make sure that + // you have access to it. + ThemeArn *string `type:"string"` } // String returns the string representation -func (s UpdateAccountCustomizationInput) String() string { +func (s UpdateAnalysisInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s UpdateAccountCustomizationInput) GoString() string { +func (s UpdateAnalysisInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *UpdateAccountCustomizationInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "UpdateAccountCustomizationInput"} - if s.AccountCustomization == nil { - invalidParams.Add(request.NewErrParamRequired("AccountCustomization")) +func (s *UpdateAnalysisInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateAnalysisInput"} + if s.AnalysisId == nil { + invalidParams.Add(request.NewErrParamRequired("AnalysisId")) + } + if s.AnalysisId != nil && len(*s.AnalysisId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AnalysisId", 1)) } if s.AwsAccountId == nil { invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) @@ -27046,6 +29713,25 @@ func (s *UpdateAccountCustomizationInput) Validate() error { if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.SourceEntity == nil { + invalidParams.Add(request.NewErrParamRequired("SourceEntity")) + } + if s.Parameters != nil { + if err := s.Parameters.Validate(); err != nil { + invalidParams.AddNested("Parameters", err.(request.ErrInvalidParams)) + } + } + if s.SourceEntity != nil { + if err := s.SourceEntity.Validate(); err != nil { + invalidParams.AddNested("SourceEntity", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -27053,125 +29739,169 @@ func (s *UpdateAccountCustomizationInput) Validate() error { return nil } -// SetAccountCustomization sets the AccountCustomization field's value. -func (s *UpdateAccountCustomizationInput) SetAccountCustomization(v *AccountCustomization) *UpdateAccountCustomizationInput { - s.AccountCustomization = v +// SetAnalysisId sets the AnalysisId field's value. +func (s *UpdateAnalysisInput) SetAnalysisId(v string) *UpdateAnalysisInput { + s.AnalysisId = &v return s } // SetAwsAccountId sets the AwsAccountId field's value. -func (s *UpdateAccountCustomizationInput) SetAwsAccountId(v string) *UpdateAccountCustomizationInput { +func (s *UpdateAnalysisInput) SetAwsAccountId(v string) *UpdateAnalysisInput { s.AwsAccountId = &v return s } -// SetNamespace sets the Namespace field's value. -func (s *UpdateAccountCustomizationInput) SetNamespace(v string) *UpdateAccountCustomizationInput { - s.Namespace = &v +// SetName sets the Name field's value. +func (s *UpdateAnalysisInput) SetName(v string) *UpdateAnalysisInput { + s.Name = &v return s } -type UpdateAccountCustomizationOutput struct { - _ struct{} `type:"structure"` +// SetParameters sets the Parameters field's value. +func (s *UpdateAnalysisInput) SetParameters(v *Parameters) *UpdateAnalysisInput { + s.Parameters = v + return s +} - // The customizations associated with your QuickSight subscription. - AccountCustomization *AccountCustomization `type:"structure"` +// SetSourceEntity sets the SourceEntity field's value. +func (s *UpdateAnalysisInput) SetSourceEntity(v *AnalysisSourceEntity) *UpdateAnalysisInput { + s.SourceEntity = v + return s +} - // The ID for the AWS account that you want to update QuickSight customizations - // for. - AwsAccountId *string `min:"12" type:"string"` +// SetThemeArn sets the ThemeArn field's value. +func (s *UpdateAnalysisInput) SetThemeArn(v string) *UpdateAnalysisInput { + s.ThemeArn = &v + return s +} - // The namespace associated with the customization that you're updating. - Namespace *string `type:"string"` +type UpdateAnalysisOutput struct { + _ struct{} `type:"structure"` + + // The ID of the analysis. + AnalysisId *string `min:"1" type:"string"` + + // The ARN of the analysis that you're updating. + Arn *string `type:"string"` // The AWS request ID for this operation. RequestId *string `type:"string"` // The HTTP status of the request. Status *int64 `location:"statusCode" type:"integer"` + + // The update status of the last update that was made to the analysis. + UpdateStatus *string `type:"string" enum:"ResourceStatus"` } // String returns the string representation -func (s UpdateAccountCustomizationOutput) String() string { +func (s UpdateAnalysisOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s UpdateAccountCustomizationOutput) GoString() string { +func (s UpdateAnalysisOutput) GoString() string { return s.String() } -// SetAccountCustomization sets the AccountCustomization field's value. -func (s *UpdateAccountCustomizationOutput) SetAccountCustomization(v *AccountCustomization) *UpdateAccountCustomizationOutput { - s.AccountCustomization = v - return s -} - -// SetAwsAccountId sets the AwsAccountId field's value. -func (s *UpdateAccountCustomizationOutput) SetAwsAccountId(v string) *UpdateAccountCustomizationOutput { - s.AwsAccountId = &v +// SetAnalysisId sets the AnalysisId field's value. +func (s *UpdateAnalysisOutput) SetAnalysisId(v string) *UpdateAnalysisOutput { + s.AnalysisId = &v return s } -// SetNamespace sets the Namespace field's value. -func (s *UpdateAccountCustomizationOutput) SetNamespace(v string) *UpdateAccountCustomizationOutput { - s.Namespace = &v +// SetArn sets the Arn field's value. +func (s *UpdateAnalysisOutput) SetArn(v string) *UpdateAnalysisOutput { + s.Arn = &v return s } // SetRequestId sets the RequestId field's value. -func (s *UpdateAccountCustomizationOutput) SetRequestId(v string) *UpdateAccountCustomizationOutput { +func (s *UpdateAnalysisOutput) SetRequestId(v string) *UpdateAnalysisOutput { s.RequestId = &v return s } // SetStatus sets the Status field's value. -func (s *UpdateAccountCustomizationOutput) SetStatus(v int64) *UpdateAccountCustomizationOutput { +func (s *UpdateAnalysisOutput) SetStatus(v int64) *UpdateAnalysisOutput { s.Status = &v return s } -type UpdateAccountSettingsInput struct { +// SetUpdateStatus sets the UpdateStatus field's value. +func (s *UpdateAnalysisOutput) SetUpdateStatus(v string) *UpdateAnalysisOutput { + s.UpdateStatus = &v + return s +} + +type UpdateAnalysisPermissionsInput struct { _ struct{} `type:"structure"` - // The ID for the AWS account that contains the QuickSight namespaces that you - // want to list. + // The ID of the analysis whose permissions you're updating. The ID is part + // of the analysis URL. + // + // AnalysisId is a required field + AnalysisId *string `location:"uri" locationName:"AnalysisId" min:"1" type:"string" required:"true"` + + // The ID of the AWS account that contains the analysis whose permissions you're + // updating. You must be using the AWS account that the analysis is in. // // AwsAccountId is a required field AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` - // The default namespace for this AWS Account. Currently, the default is default. - // IAM users who register for the first time with QuickSight provide an email - // that becomes associated with the default namespace. - // - // DefaultNamespace is a required field - DefaultNamespace *string `type:"string" required:"true"` + // A structure that describes the permissions to add and the principal to add + // them to. + GrantPermissions []*ResourcePermission `type:"list"` - // Email address used to send notifications regarding administration of QuickSight. - NotificationEmail *string `type:"string"` + // A structure that describes the permissions to remove and the principal to + // remove them from. + RevokePermissions []*ResourcePermission `type:"list"` } // String returns the string representation -func (s UpdateAccountSettingsInput) String() string { +func (s UpdateAnalysisPermissionsInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s UpdateAccountSettingsInput) GoString() string { +func (s UpdateAnalysisPermissionsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *UpdateAccountSettingsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "UpdateAccountSettingsInput"} +func (s *UpdateAnalysisPermissionsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateAnalysisPermissionsInput"} + if s.AnalysisId == nil { + invalidParams.Add(request.NewErrParamRequired("AnalysisId")) + } + if s.AnalysisId != nil && len(*s.AnalysisId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AnalysisId", 1)) + } if s.AwsAccountId == nil { invalidParams.Add(request.NewErrParamRequired("AwsAccountId")) } if s.AwsAccountId != nil && len(*s.AwsAccountId) < 12 { invalidParams.Add(request.NewErrParamMinLen("AwsAccountId", 12)) } - if s.DefaultNamespace == nil { - invalidParams.Add(request.NewErrParamRequired("DefaultNamespace")) + if s.GrantPermissions != nil { + for i, v := range s.GrantPermissions { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "GrantPermissions", i), err.(request.ErrInvalidParams)) + } + } + } + if s.RevokePermissions != nil { + for i, v := range s.RevokePermissions { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "RevokePermissions", i), err.(request.ErrInvalidParams)) + } + } } if invalidParams.Len() > 0 { @@ -27180,27 +29910,43 @@ func (s *UpdateAccountSettingsInput) Validate() error { return nil } +// SetAnalysisId sets the AnalysisId field's value. +func (s *UpdateAnalysisPermissionsInput) SetAnalysisId(v string) *UpdateAnalysisPermissionsInput { + s.AnalysisId = &v + return s +} + // SetAwsAccountId sets the AwsAccountId field's value. -func (s *UpdateAccountSettingsInput) SetAwsAccountId(v string) *UpdateAccountSettingsInput { +func (s *UpdateAnalysisPermissionsInput) SetAwsAccountId(v string) *UpdateAnalysisPermissionsInput { s.AwsAccountId = &v return s } -// SetDefaultNamespace sets the DefaultNamespace field's value. -func (s *UpdateAccountSettingsInput) SetDefaultNamespace(v string) *UpdateAccountSettingsInput { - s.DefaultNamespace = &v +// SetGrantPermissions sets the GrantPermissions field's value. +func (s *UpdateAnalysisPermissionsInput) SetGrantPermissions(v []*ResourcePermission) *UpdateAnalysisPermissionsInput { + s.GrantPermissions = v return s } -// SetNotificationEmail sets the NotificationEmail field's value. -func (s *UpdateAccountSettingsInput) SetNotificationEmail(v string) *UpdateAccountSettingsInput { - s.NotificationEmail = &v +// SetRevokePermissions sets the RevokePermissions field's value. +func (s *UpdateAnalysisPermissionsInput) SetRevokePermissions(v []*ResourcePermission) *UpdateAnalysisPermissionsInput { + s.RevokePermissions = v return s } -type UpdateAccountSettingsOutput struct { +type UpdateAnalysisPermissionsOutput struct { _ struct{} `type:"structure"` + // The Amazon Resource Name (ARN) of the analysis that you updated. + AnalysisArn *string `type:"string"` + + // The ID of the analysis that you updated permissions for. + AnalysisId *string `min:"1" type:"string"` + + // A structure that describes the principals and the resource-level permissions + // on an analysis. + Permissions []*ResourcePermission `min:"1" type:"list"` + // The AWS request ID for this operation. RequestId *string `type:"string"` @@ -27209,23 +29955,41 @@ type UpdateAccountSettingsOutput struct { } // String returns the string representation -func (s UpdateAccountSettingsOutput) String() string { +func (s UpdateAnalysisPermissionsOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s UpdateAccountSettingsOutput) GoString() string { +func (s UpdateAnalysisPermissionsOutput) GoString() string { return s.String() } +// SetAnalysisArn sets the AnalysisArn field's value. +func (s *UpdateAnalysisPermissionsOutput) SetAnalysisArn(v string) *UpdateAnalysisPermissionsOutput { + s.AnalysisArn = &v + return s +} + +// SetAnalysisId sets the AnalysisId field's value. +func (s *UpdateAnalysisPermissionsOutput) SetAnalysisId(v string) *UpdateAnalysisPermissionsOutput { + s.AnalysisId = &v + return s +} + +// SetPermissions sets the Permissions field's value. +func (s *UpdateAnalysisPermissionsOutput) SetPermissions(v []*ResourcePermission) *UpdateAnalysisPermissionsOutput { + s.Permissions = v + return s +} + // SetRequestId sets the RequestId field's value. -func (s *UpdateAccountSettingsOutput) SetRequestId(v string) *UpdateAccountSettingsOutput { +func (s *UpdateAnalysisPermissionsOutput) SetRequestId(v string) *UpdateAnalysisPermissionsOutput { s.RequestId = &v return s } // SetStatus sets the Status field's value. -func (s *UpdateAccountSettingsOutput) SetStatus(v int64) *UpdateAccountSettingsOutput { +func (s *UpdateAnalysisPermissionsOutput) SetStatus(v int64) *UpdateAnalysisPermissionsOutput { s.Status = &v return s } @@ -27251,7 +30015,7 @@ type UpdateDashboardInput struct { // ad hoc (one-time) filtering. This option is ENABLED by default. // // * AvailabilityStatus for ExportToCSVOption - This status can be either - // ENABLED or DISABLED. The visual option to export data to .csv format isn't + // ENABLED or DISABLED. The visual option to export data to .CSV format isn't // enabled when this is set to DISABLED. This option is ENABLED by default. // // * VisibilityState for SheetControlsOption - This visibility state can @@ -29768,10 +32532,29 @@ type UpdateUserInput struct { // AwsAccountId is a required field AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` - // The name of the custom permissions profile that you want to assign to this - // user. Currently, custom permissions profile names are assigned to permissions - // profiles in the QuickSight console. You use this API to assign the named - // set of permissions to a QuickSight user. + // (Enterprise edition only) The name of the custom permissions profile that + // you want to assign to this user. Customized permissions allows you to control + // a user's access by restricting access the following operations: + // + // * Create and update data sources + // + // * Create and update datasets + // + // * Create and update email reports + // + // * Subscribe to email reports + // + // A set of custom permissions includes any combination of these restrictions. + // Currently, you need to create the profile names for custom permission sets + // by using the QuickSight console. Then, you use the RegisterUser API operation + // to assign the named set of permissions to a QuickSight user. + // + // QuickSight custom permissions are applied through IAM policies. Therefore, + // they override the permissions typically granted by assigning QuickSight users + // to one of the default security cohorts in QuickSight (admin, author, reader). + // + // This feature is available only to QuickSight Enterprise edition subscriptions + // that use SAML 2.0-Based Federation for Single Sign-On (SSO). CustomPermissionsName *string `min:"1" type:"string"` // The email address of the user that you want to update. @@ -29784,7 +32567,8 @@ type UpdateUserInput struct { // Namespace is a required field Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"` - // The Amazon QuickSight role of the user. The user role can be one of the following: + // The Amazon QuickSight role of the user. The role can be one of the following + // default security cohorts: // // * READER: A user who has read-only access to dashboards. // @@ -29794,6 +32578,9 @@ type UpdateUserInput struct { // * ADMIN: A user who is an author, who can also manage Amazon QuickSight // settings. // + // The name of the QuickSight role is invisible to the user except for the console + // screens dealing with permissions. + // // Role is a required field Role *string `type:"string" required:"true" enum:"UserRole"` @@ -30015,8 +32802,7 @@ func (s *UploadSettings) SetTextQualifier(v string) *UploadSettings { return s } -// A registered user of Amazon QuickSight. Currently, an Amazon QuickSight subscription -// can't contain more than 20 million users. +// A registered user of Amazon QuickSight. type User struct { _ struct{} `type:"structure"` @@ -30218,6 +33004,66 @@ func (s *VpcConnectionProperties) SetVpcConnectionArn(v string) *VpcConnectionPr return s } +const ( + // AnalysisErrorTypeAccessDenied is a AnalysisErrorType enum value + AnalysisErrorTypeAccessDenied = "ACCESS_DENIED" + + // AnalysisErrorTypeSourceNotFound is a AnalysisErrorType enum value + AnalysisErrorTypeSourceNotFound = "SOURCE_NOT_FOUND" + + // AnalysisErrorTypeDataSetNotFound is a AnalysisErrorType enum value + AnalysisErrorTypeDataSetNotFound = "DATA_SET_NOT_FOUND" + + // AnalysisErrorTypeInternalFailure is a AnalysisErrorType enum value + AnalysisErrorTypeInternalFailure = "INTERNAL_FAILURE" + + // AnalysisErrorTypeParameterValueIncompatible is a AnalysisErrorType enum value + AnalysisErrorTypeParameterValueIncompatible = "PARAMETER_VALUE_INCOMPATIBLE" + + // AnalysisErrorTypeParameterTypeInvalid is a AnalysisErrorType enum value + AnalysisErrorTypeParameterTypeInvalid = "PARAMETER_TYPE_INVALID" + + // AnalysisErrorTypeParameterNotFound is a AnalysisErrorType enum value + AnalysisErrorTypeParameterNotFound = "PARAMETER_NOT_FOUND" + + // AnalysisErrorTypeColumnTypeMismatch is a AnalysisErrorType enum value + AnalysisErrorTypeColumnTypeMismatch = "COLUMN_TYPE_MISMATCH" + + // AnalysisErrorTypeColumnGeographicRoleMismatch is a AnalysisErrorType enum value + AnalysisErrorTypeColumnGeographicRoleMismatch = "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" + + // AnalysisErrorTypeColumnReplacementMissing is a AnalysisErrorType enum value + AnalysisErrorTypeColumnReplacementMissing = "COLUMN_REPLACEMENT_MISSING" +) + +// AnalysisErrorType_Values returns all elements of the AnalysisErrorType enum +func AnalysisErrorType_Values() []string { + return []string{ + AnalysisErrorTypeAccessDenied, + AnalysisErrorTypeSourceNotFound, + AnalysisErrorTypeDataSetNotFound, + AnalysisErrorTypeInternalFailure, + AnalysisErrorTypeParameterValueIncompatible, + AnalysisErrorTypeParameterTypeInvalid, + AnalysisErrorTypeParameterNotFound, + AnalysisErrorTypeColumnTypeMismatch, + AnalysisErrorTypeColumnGeographicRoleMismatch, + AnalysisErrorTypeColumnReplacementMissing, + } +} + +const ( + // AnalysisFilterAttributeQuicksightUser is a AnalysisFilterAttribute enum value + AnalysisFilterAttributeQuicksightUser = "QUICKSIGHT_USER" +) + +// AnalysisFilterAttribute_Values returns all elements of the AnalysisFilterAttribute enum +func AnalysisFilterAttribute_Values() []string { + return []string{ + AnalysisFilterAttributeQuicksightUser, + } +} + const ( // AssignmentStatusEnabled is a AssignmentStatus enum value AssignmentStatusEnabled = "ENABLED" @@ -31044,6 +33890,9 @@ const ( // ResourceStatusUpdateFailed is a ResourceStatus enum value ResourceStatusUpdateFailed = "UPDATE_FAILED" + + // ResourceStatusDeleted is a ResourceStatus enum value + ResourceStatusDeleted = "DELETED" ) // ResourceStatus_Values returns all elements of the ResourceStatus enum @@ -31055,6 +33904,7 @@ func ResourceStatus_Values() []string { ResourceStatusUpdateInProgress, ResourceStatusUpdateSuccessful, ResourceStatusUpdateFailed, + ResourceStatusDeleted, } } @@ -31083,6 +33933,9 @@ const ( // TemplateErrorTypeInternalFailure is a TemplateErrorType enum value TemplateErrorTypeInternalFailure = "INTERNAL_FAILURE" + + // TemplateErrorTypeAccessDenied is a TemplateErrorType enum value + TemplateErrorTypeAccessDenied = "ACCESS_DENIED" ) // TemplateErrorType_Values returns all elements of the TemplateErrorType enum @@ -31091,6 +33944,7 @@ func TemplateErrorType_Values() []string { TemplateErrorTypeSourceNotFound, TemplateErrorTypeDataSetNotFound, TemplateErrorTypeInternalFailure, + TemplateErrorTypeAccessDenied, } } diff --git a/service/quicksight/errors.go b/service/quicksight/errors.go index 2f6b3e713a..4f8ac36a9e 100644 --- a/service/quicksight/errors.go +++ b/service/quicksight/errors.go @@ -21,8 +21,8 @@ const ( // ErrCodeConcurrentUpdatingException for service response error code // "ConcurrentUpdatingException". // - // A resource is already in a state that indicates an action is happening that - // must complete before a new update can be applied. + // A resource is already in a state that indicates an operation is happening + // that must complete before a new update can be applied. ErrCodeConcurrentUpdatingException = "ConcurrentUpdatingException" // ErrCodeConflictException for service response error code diff --git a/service/quicksight/quicksightiface/interface.go b/service/quicksight/quicksightiface/interface.go index 9998d01bd6..9ac61a75c0 100644 --- a/service/quicksight/quicksightiface/interface.go +++ b/service/quicksight/quicksightiface/interface.go @@ -68,6 +68,10 @@ type QuickSightAPI interface { CreateAccountCustomizationWithContext(aws.Context, *quicksight.CreateAccountCustomizationInput, ...request.Option) (*quicksight.CreateAccountCustomizationOutput, error) CreateAccountCustomizationRequest(*quicksight.CreateAccountCustomizationInput) (*request.Request, *quicksight.CreateAccountCustomizationOutput) + CreateAnalysis(*quicksight.CreateAnalysisInput) (*quicksight.CreateAnalysisOutput, error) + CreateAnalysisWithContext(aws.Context, *quicksight.CreateAnalysisInput, ...request.Option) (*quicksight.CreateAnalysisOutput, error) + CreateAnalysisRequest(*quicksight.CreateAnalysisInput) (*request.Request, *quicksight.CreateAnalysisOutput) + CreateDashboard(*quicksight.CreateDashboardInput) (*quicksight.CreateDashboardOutput, error) CreateDashboardWithContext(aws.Context, *quicksight.CreateDashboardInput, ...request.Option) (*quicksight.CreateDashboardOutput, error) CreateDashboardRequest(*quicksight.CreateDashboardInput) (*request.Request, *quicksight.CreateDashboardOutput) @@ -120,6 +124,10 @@ type QuickSightAPI interface { DeleteAccountCustomizationWithContext(aws.Context, *quicksight.DeleteAccountCustomizationInput, ...request.Option) (*quicksight.DeleteAccountCustomizationOutput, error) DeleteAccountCustomizationRequest(*quicksight.DeleteAccountCustomizationInput) (*request.Request, *quicksight.DeleteAccountCustomizationOutput) + DeleteAnalysis(*quicksight.DeleteAnalysisInput) (*quicksight.DeleteAnalysisOutput, error) + DeleteAnalysisWithContext(aws.Context, *quicksight.DeleteAnalysisInput, ...request.Option) (*quicksight.DeleteAnalysisOutput, error) + DeleteAnalysisRequest(*quicksight.DeleteAnalysisInput) (*request.Request, *quicksight.DeleteAnalysisOutput) + DeleteDashboard(*quicksight.DeleteDashboardInput) (*quicksight.DeleteDashboardOutput, error) DeleteDashboardWithContext(aws.Context, *quicksight.DeleteDashboardInput, ...request.Option) (*quicksight.DeleteDashboardOutput, error) DeleteDashboardRequest(*quicksight.DeleteDashboardInput) (*request.Request, *quicksight.DeleteDashboardOutput) @@ -180,6 +188,14 @@ type QuickSightAPI interface { DescribeAccountSettingsWithContext(aws.Context, *quicksight.DescribeAccountSettingsInput, ...request.Option) (*quicksight.DescribeAccountSettingsOutput, error) DescribeAccountSettingsRequest(*quicksight.DescribeAccountSettingsInput) (*request.Request, *quicksight.DescribeAccountSettingsOutput) + DescribeAnalysis(*quicksight.DescribeAnalysisInput) (*quicksight.DescribeAnalysisOutput, error) + DescribeAnalysisWithContext(aws.Context, *quicksight.DescribeAnalysisInput, ...request.Option) (*quicksight.DescribeAnalysisOutput, error) + DescribeAnalysisRequest(*quicksight.DescribeAnalysisInput) (*request.Request, *quicksight.DescribeAnalysisOutput) + + DescribeAnalysisPermissions(*quicksight.DescribeAnalysisPermissionsInput) (*quicksight.DescribeAnalysisPermissionsOutput, error) + DescribeAnalysisPermissionsWithContext(aws.Context, *quicksight.DescribeAnalysisPermissionsInput, ...request.Option) (*quicksight.DescribeAnalysisPermissionsOutput, error) + DescribeAnalysisPermissionsRequest(*quicksight.DescribeAnalysisPermissionsInput) (*request.Request, *quicksight.DescribeAnalysisPermissionsOutput) + DescribeDashboard(*quicksight.DescribeDashboardInput) (*quicksight.DescribeDashboardOutput, error) DescribeDashboardWithContext(aws.Context, *quicksight.DescribeDashboardInput, ...request.Option) (*quicksight.DescribeDashboardOutput, error) DescribeDashboardRequest(*quicksight.DescribeDashboardInput) (*request.Request, *quicksight.DescribeDashboardOutput) @@ -256,6 +272,13 @@ type QuickSightAPI interface { GetSessionEmbedUrlWithContext(aws.Context, *quicksight.GetSessionEmbedUrlInput, ...request.Option) (*quicksight.GetSessionEmbedUrlOutput, error) GetSessionEmbedUrlRequest(*quicksight.GetSessionEmbedUrlInput) (*request.Request, *quicksight.GetSessionEmbedUrlOutput) + ListAnalyses(*quicksight.ListAnalysesInput) (*quicksight.ListAnalysesOutput, error) + ListAnalysesWithContext(aws.Context, *quicksight.ListAnalysesInput, ...request.Option) (*quicksight.ListAnalysesOutput, error) + ListAnalysesRequest(*quicksight.ListAnalysesInput) (*request.Request, *quicksight.ListAnalysesOutput) + + ListAnalysesPages(*quicksight.ListAnalysesInput, func(*quicksight.ListAnalysesOutput, bool) bool) error + ListAnalysesPagesWithContext(aws.Context, *quicksight.ListAnalysesInput, func(*quicksight.ListAnalysesOutput, bool) bool, ...request.Option) error + ListDashboardVersions(*quicksight.ListDashboardVersionsInput) (*quicksight.ListDashboardVersionsOutput, error) ListDashboardVersionsWithContext(aws.Context, *quicksight.ListDashboardVersionsInput, ...request.Option) (*quicksight.ListDashboardVersionsOutput, error) ListDashboardVersionsRequest(*quicksight.ListDashboardVersionsInput) (*request.Request, *quicksight.ListDashboardVersionsOutput) @@ -363,6 +386,17 @@ type QuickSightAPI interface { RegisterUserWithContext(aws.Context, *quicksight.RegisterUserInput, ...request.Option) (*quicksight.RegisterUserOutput, error) RegisterUserRequest(*quicksight.RegisterUserInput) (*request.Request, *quicksight.RegisterUserOutput) + RestoreAnalysis(*quicksight.RestoreAnalysisInput) (*quicksight.RestoreAnalysisOutput, error) + RestoreAnalysisWithContext(aws.Context, *quicksight.RestoreAnalysisInput, ...request.Option) (*quicksight.RestoreAnalysisOutput, error) + RestoreAnalysisRequest(*quicksight.RestoreAnalysisInput) (*request.Request, *quicksight.RestoreAnalysisOutput) + + SearchAnalyses(*quicksight.SearchAnalysesInput) (*quicksight.SearchAnalysesOutput, error) + SearchAnalysesWithContext(aws.Context, *quicksight.SearchAnalysesInput, ...request.Option) (*quicksight.SearchAnalysesOutput, error) + SearchAnalysesRequest(*quicksight.SearchAnalysesInput) (*request.Request, *quicksight.SearchAnalysesOutput) + + SearchAnalysesPages(*quicksight.SearchAnalysesInput, func(*quicksight.SearchAnalysesOutput, bool) bool) error + SearchAnalysesPagesWithContext(aws.Context, *quicksight.SearchAnalysesInput, func(*quicksight.SearchAnalysesOutput, bool) bool, ...request.Option) error + SearchDashboards(*quicksight.SearchDashboardsInput) (*quicksight.SearchDashboardsOutput, error) SearchDashboardsWithContext(aws.Context, *quicksight.SearchDashboardsInput, ...request.Option) (*quicksight.SearchDashboardsOutput, error) SearchDashboardsRequest(*quicksight.SearchDashboardsInput) (*request.Request, *quicksight.SearchDashboardsOutput) @@ -386,6 +420,14 @@ type QuickSightAPI interface { UpdateAccountSettingsWithContext(aws.Context, *quicksight.UpdateAccountSettingsInput, ...request.Option) (*quicksight.UpdateAccountSettingsOutput, error) UpdateAccountSettingsRequest(*quicksight.UpdateAccountSettingsInput) (*request.Request, *quicksight.UpdateAccountSettingsOutput) + UpdateAnalysis(*quicksight.UpdateAnalysisInput) (*quicksight.UpdateAnalysisOutput, error) + UpdateAnalysisWithContext(aws.Context, *quicksight.UpdateAnalysisInput, ...request.Option) (*quicksight.UpdateAnalysisOutput, error) + UpdateAnalysisRequest(*quicksight.UpdateAnalysisInput) (*request.Request, *quicksight.UpdateAnalysisOutput) + + UpdateAnalysisPermissions(*quicksight.UpdateAnalysisPermissionsInput) (*quicksight.UpdateAnalysisPermissionsOutput, error) + UpdateAnalysisPermissionsWithContext(aws.Context, *quicksight.UpdateAnalysisPermissionsInput, ...request.Option) (*quicksight.UpdateAnalysisPermissionsOutput, error) + UpdateAnalysisPermissionsRequest(*quicksight.UpdateAnalysisPermissionsInput) (*request.Request, *quicksight.UpdateAnalysisPermissionsOutput) + UpdateDashboard(*quicksight.UpdateDashboardInput) (*quicksight.UpdateDashboardOutput, error) UpdateDashboardWithContext(aws.Context, *quicksight.UpdateDashboardInput, ...request.Option) (*quicksight.UpdateDashboardOutput, error) UpdateDashboardRequest(*quicksight.UpdateDashboardInput) (*request.Request, *quicksight.UpdateDashboardOutput) diff --git a/service/robomaker/api.go b/service/robomaker/api.go index 8aaca9d5d3..247c8d9838 100644 --- a/service/robomaker/api.go +++ b/service/robomaker/api.go @@ -13,6 +13,93 @@ import ( "github.com/aws/aws-sdk-go/private/protocol/restjson" ) +const opBatchDeleteWorlds = "BatchDeleteWorlds" + +// BatchDeleteWorldsRequest generates a "aws/request.Request" representing the +// client's request for the BatchDeleteWorlds 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 BatchDeleteWorlds for more information on using the BatchDeleteWorlds +// 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 BatchDeleteWorldsRequest method. +// req, resp := client.BatchDeleteWorldsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/BatchDeleteWorlds +func (c *RoboMaker) BatchDeleteWorldsRequest(input *BatchDeleteWorldsInput) (req *request.Request, output *BatchDeleteWorldsOutput) { + op := &request.Operation{ + Name: opBatchDeleteWorlds, + HTTPMethod: "POST", + HTTPPath: "/batchDeleteWorlds", + } + + if input == nil { + input = &BatchDeleteWorldsInput{} + } + + output = &BatchDeleteWorldsOutput{} + req = c.newRequest(op, input, output) + return +} + +// BatchDeleteWorlds API operation for AWS RoboMaker. +// +// Deletes one or more worlds in a batch operation. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation BatchDeleteWorlds for usage and error information. +// +// Returned Error Types: +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/BatchDeleteWorlds +func (c *RoboMaker) BatchDeleteWorlds(input *BatchDeleteWorldsInput) (*BatchDeleteWorldsOutput, error) { + req, out := c.BatchDeleteWorldsRequest(input) + return out, req.Send() +} + +// BatchDeleteWorldsWithContext is the same as BatchDeleteWorlds with the addition of +// the ability to pass a context and additional request options. +// +// See BatchDeleteWorlds 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 *RoboMaker) BatchDeleteWorldsWithContext(ctx aws.Context, input *BatchDeleteWorldsInput, opts ...request.Option) (*BatchDeleteWorldsOutput, error) { + req, out := c.BatchDeleteWorldsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opBatchDescribeSimulationJob = "BatchDescribeSimulationJob" // BatchDescribeSimulationJobRequest generates a "aws/request.Request" representing the @@ -378,6 +465,188 @@ func (c *RoboMaker) CancelSimulationJobBatchWithContext(ctx aws.Context, input * return out, req.Send() } +const opCancelWorldExportJob = "CancelWorldExportJob" + +// CancelWorldExportJobRequest generates a "aws/request.Request" representing the +// client's request for the CancelWorldExportJob 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 CancelWorldExportJob for more information on using the CancelWorldExportJob +// 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 CancelWorldExportJobRequest method. +// req, resp := client.CancelWorldExportJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CancelWorldExportJob +func (c *RoboMaker) CancelWorldExportJobRequest(input *CancelWorldExportJobInput) (req *request.Request, output *CancelWorldExportJobOutput) { + op := &request.Operation{ + Name: opCancelWorldExportJob, + HTTPMethod: "POST", + HTTPPath: "/cancelWorldExportJob", + } + + if input == nil { + input = &CancelWorldExportJobInput{} + } + + output = &CancelWorldExportJobOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// CancelWorldExportJob API operation for AWS RoboMaker. +// +// Cancels the specified export job. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation CancelWorldExportJob for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource does not exist. +// +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CancelWorldExportJob +func (c *RoboMaker) CancelWorldExportJob(input *CancelWorldExportJobInput) (*CancelWorldExportJobOutput, error) { + req, out := c.CancelWorldExportJobRequest(input) + return out, req.Send() +} + +// CancelWorldExportJobWithContext is the same as CancelWorldExportJob with the addition of +// the ability to pass a context and additional request options. +// +// See CancelWorldExportJob 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 *RoboMaker) CancelWorldExportJobWithContext(ctx aws.Context, input *CancelWorldExportJobInput, opts ...request.Option) (*CancelWorldExportJobOutput, error) { + req, out := c.CancelWorldExportJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCancelWorldGenerationJob = "CancelWorldGenerationJob" + +// CancelWorldGenerationJobRequest generates a "aws/request.Request" representing the +// client's request for the CancelWorldGenerationJob 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 CancelWorldGenerationJob for more information on using the CancelWorldGenerationJob +// 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 CancelWorldGenerationJobRequest method. +// req, resp := client.CancelWorldGenerationJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CancelWorldGenerationJob +func (c *RoboMaker) CancelWorldGenerationJobRequest(input *CancelWorldGenerationJobInput) (req *request.Request, output *CancelWorldGenerationJobOutput) { + op := &request.Operation{ + Name: opCancelWorldGenerationJob, + HTTPMethod: "POST", + HTTPPath: "/cancelWorldGenerationJob", + } + + if input == nil { + input = &CancelWorldGenerationJobInput{} + } + + output = &CancelWorldGenerationJobOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// CancelWorldGenerationJob API operation for AWS RoboMaker. +// +// Cancels the specified world generator job. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation CancelWorldGenerationJob for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource does not exist. +// +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CancelWorldGenerationJob +func (c *RoboMaker) CancelWorldGenerationJob(input *CancelWorldGenerationJobInput) (*CancelWorldGenerationJobOutput, error) { + req, out := c.CancelWorldGenerationJobRequest(input) + return out, req.Send() +} + +// CancelWorldGenerationJobWithContext is the same as CancelWorldGenerationJob with the addition of +// the ability to pass a context and additional request options. +// +// See CancelWorldGenerationJob 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 *RoboMaker) CancelWorldGenerationJobWithContext(ctx aws.Context, input *CancelWorldGenerationJobInput, opts ...request.Option) (*CancelWorldGenerationJobOutput, error) { + req, out := c.CancelWorldGenerationJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateDeploymentJob = "CreateDeploymentJob" // CreateDeploymentJobRequest generates a "aws/request.Request" representing the @@ -1167,61 +1436,63 @@ func (c *RoboMaker) CreateSimulationJobWithContext(ctx aws.Context, input *Creat return out, req.Send() } -const opDeleteFleet = "DeleteFleet" +const opCreateWorldExportJob = "CreateWorldExportJob" -// DeleteFleetRequest generates a "aws/request.Request" representing the -// client's request for the DeleteFleet operation. The "output" return +// CreateWorldExportJobRequest generates a "aws/request.Request" representing the +// client's request for the CreateWorldExportJob 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 DeleteFleet for more information on using the DeleteFleet +// See CreateWorldExportJob for more information on using the CreateWorldExportJob // 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 DeleteFleetRequest method. -// req, resp := client.DeleteFleetRequest(params) +// // Example sending a request using the CreateWorldExportJobRequest method. +// req, resp := client.CreateWorldExportJobRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteFleet -func (c *RoboMaker) DeleteFleetRequest(input *DeleteFleetInput) (req *request.Request, output *DeleteFleetOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateWorldExportJob +func (c *RoboMaker) CreateWorldExportJobRequest(input *CreateWorldExportJobInput) (req *request.Request, output *CreateWorldExportJobOutput) { op := &request.Operation{ - Name: opDeleteFleet, + Name: opCreateWorldExportJob, HTTPMethod: "POST", - HTTPPath: "/deleteFleet", + HTTPPath: "/createWorldExportJob", } if input == nil { - input = &DeleteFleetInput{} + input = &CreateWorldExportJobInput{} } - output = &DeleteFleetOutput{} + output = &CreateWorldExportJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DeleteFleet API operation for AWS RoboMaker. +// CreateWorldExportJob API operation for AWS RoboMaker. // -// Deletes a fleet. +// Creates a world export job. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation DeleteFleet for usage and error information. +// API operation CreateWorldExportJob for usage and error information. // // Returned Error Types: +// * ResourceNotFoundException +// The specified resource does not exist. +// // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. @@ -1233,83 +1504,93 @@ func (c *RoboMaker) DeleteFleetRequest(input *DeleteFleetInput) (req *request.Re // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteFleet -func (c *RoboMaker) DeleteFleet(input *DeleteFleetInput) (*DeleteFleetOutput, error) { - req, out := c.DeleteFleetRequest(input) +// * IdempotentParameterMismatchException +// The request uses the same client token as a previous, but non-identical request. +// Do not reuse a client token with different requests, unless the requests +// are identical. +// +// * ServiceUnavailableException +// The request has failed due to a temporary failure of the server. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateWorldExportJob +func (c *RoboMaker) CreateWorldExportJob(input *CreateWorldExportJobInput) (*CreateWorldExportJobOutput, error) { + req, out := c.CreateWorldExportJobRequest(input) return out, req.Send() } -// DeleteFleetWithContext is the same as DeleteFleet with the addition of +// CreateWorldExportJobWithContext is the same as CreateWorldExportJob with the addition of // the ability to pass a context and additional request options. // -// See DeleteFleet for details on how to use this API operation. +// See CreateWorldExportJob 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 *RoboMaker) DeleteFleetWithContext(ctx aws.Context, input *DeleteFleetInput, opts ...request.Option) (*DeleteFleetOutput, error) { - req, out := c.DeleteFleetRequest(input) +func (c *RoboMaker) CreateWorldExportJobWithContext(ctx aws.Context, input *CreateWorldExportJobInput, opts ...request.Option) (*CreateWorldExportJobOutput, error) { + req, out := c.CreateWorldExportJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDeleteRobot = "DeleteRobot" +const opCreateWorldGenerationJob = "CreateWorldGenerationJob" -// DeleteRobotRequest generates a "aws/request.Request" representing the -// client's request for the DeleteRobot operation. The "output" return +// CreateWorldGenerationJobRequest generates a "aws/request.Request" representing the +// client's request for the CreateWorldGenerationJob 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 DeleteRobot for more information on using the DeleteRobot +// See CreateWorldGenerationJob for more information on using the CreateWorldGenerationJob // 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 DeleteRobotRequest method. -// req, resp := client.DeleteRobotRequest(params) +// // Example sending a request using the CreateWorldGenerationJobRequest method. +// req, resp := client.CreateWorldGenerationJobRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteRobot -func (c *RoboMaker) DeleteRobotRequest(input *DeleteRobotInput) (req *request.Request, output *DeleteRobotOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateWorldGenerationJob +func (c *RoboMaker) CreateWorldGenerationJobRequest(input *CreateWorldGenerationJobInput) (req *request.Request, output *CreateWorldGenerationJobOutput) { op := &request.Operation{ - Name: opDeleteRobot, + Name: opCreateWorldGenerationJob, HTTPMethod: "POST", - HTTPPath: "/deleteRobot", + HTTPPath: "/createWorldGenerationJob", } if input == nil { - input = &DeleteRobotInput{} + input = &CreateWorldGenerationJobInput{} } - output = &DeleteRobotOutput{} + output = &CreateWorldGenerationJobOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DeleteRobot API operation for AWS RoboMaker. +// CreateWorldGenerationJob API operation for AWS RoboMaker. // -// Deletes a robot. +// Creates worlds using the specified template. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation DeleteRobot for usage and error information. +// API operation CreateWorldGenerationJob for usage and error information. // // Returned Error Types: +// * ResourceNotFoundException +// The specified resource does not exist. +// // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. @@ -1321,87 +1602,108 @@ func (c *RoboMaker) DeleteRobotRequest(input *DeleteRobotInput) (req *request.Re // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteRobot -func (c *RoboMaker) DeleteRobot(input *DeleteRobotInput) (*DeleteRobotOutput, error) { - req, out := c.DeleteRobotRequest(input) +// * LimitExceededException +// The requested resource exceeds the maximum number allowed, or the number +// of concurrent stream requests exceeds the maximum number allowed. +// +// * IdempotentParameterMismatchException +// The request uses the same client token as a previous, but non-identical request. +// Do not reuse a client token with different requests, unless the requests +// are identical. +// +// * ServiceUnavailableException +// The request has failed due to a temporary failure of the server. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateWorldGenerationJob +func (c *RoboMaker) CreateWorldGenerationJob(input *CreateWorldGenerationJobInput) (*CreateWorldGenerationJobOutput, error) { + req, out := c.CreateWorldGenerationJobRequest(input) return out, req.Send() } -// DeleteRobotWithContext is the same as DeleteRobot with the addition of +// CreateWorldGenerationJobWithContext is the same as CreateWorldGenerationJob with the addition of // the ability to pass a context and additional request options. // -// See DeleteRobot for details on how to use this API operation. +// See CreateWorldGenerationJob 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 *RoboMaker) DeleteRobotWithContext(ctx aws.Context, input *DeleteRobotInput, opts ...request.Option) (*DeleteRobotOutput, error) { - req, out := c.DeleteRobotRequest(input) +func (c *RoboMaker) CreateWorldGenerationJobWithContext(ctx aws.Context, input *CreateWorldGenerationJobInput, opts ...request.Option) (*CreateWorldGenerationJobOutput, error) { + req, out := c.CreateWorldGenerationJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDeleteRobotApplication = "DeleteRobotApplication" +const opCreateWorldTemplate = "CreateWorldTemplate" -// DeleteRobotApplicationRequest generates a "aws/request.Request" representing the -// client's request for the DeleteRobotApplication operation. The "output" return +// CreateWorldTemplateRequest generates a "aws/request.Request" representing the +// client's request for the CreateWorldTemplate 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 DeleteRobotApplication for more information on using the DeleteRobotApplication +// See CreateWorldTemplate for more information on using the CreateWorldTemplate // 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 DeleteRobotApplicationRequest method. -// req, resp := client.DeleteRobotApplicationRequest(params) +// // Example sending a request using the CreateWorldTemplateRequest method. +// req, resp := client.CreateWorldTemplateRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteRobotApplication -func (c *RoboMaker) DeleteRobotApplicationRequest(input *DeleteRobotApplicationInput) (req *request.Request, output *DeleteRobotApplicationOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateWorldTemplate +func (c *RoboMaker) CreateWorldTemplateRequest(input *CreateWorldTemplateInput) (req *request.Request, output *CreateWorldTemplateOutput) { op := &request.Operation{ - Name: opDeleteRobotApplication, + Name: opCreateWorldTemplate, HTTPMethod: "POST", - HTTPPath: "/deleteRobotApplication", + HTTPPath: "/createWorldTemplate", } if input == nil { - input = &DeleteRobotApplicationInput{} + input = &CreateWorldTemplateInput{} } - output = &DeleteRobotApplicationOutput{} + output = &CreateWorldTemplateOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DeleteRobotApplication API operation for AWS RoboMaker. +// CreateWorldTemplate API operation for AWS RoboMaker. // -// Deletes a robot application. +// Creates a world template. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation DeleteRobotApplication for usage and error information. +// API operation CreateWorldTemplate for usage and error information. // // Returned Error Types: // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // +// * ResourceAlreadyExistsException +// The specified resource already exists. +// +// * ResourceNotFoundException +// The specified resource does not exist. +// +// * LimitExceededException +// The requested resource exceeds the maximum number allowed, or the number +// of concurrent stream requests exceeds the maximum number allowed. +// // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. @@ -1409,168 +1711,169 @@ func (c *RoboMaker) DeleteRobotApplicationRequest(input *DeleteRobotApplicationI // * InternalServerException // AWS RoboMaker experienced a service issue. Try your call again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteRobotApplication -func (c *RoboMaker) DeleteRobotApplication(input *DeleteRobotApplicationInput) (*DeleteRobotApplicationOutput, error) { - req, out := c.DeleteRobotApplicationRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateWorldTemplate +func (c *RoboMaker) CreateWorldTemplate(input *CreateWorldTemplateInput) (*CreateWorldTemplateOutput, error) { + req, out := c.CreateWorldTemplateRequest(input) return out, req.Send() } -// DeleteRobotApplicationWithContext is the same as DeleteRobotApplication with the addition of +// CreateWorldTemplateWithContext is the same as CreateWorldTemplate with the addition of // the ability to pass a context and additional request options. // -// See DeleteRobotApplication for details on how to use this API operation. +// See CreateWorldTemplate 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 *RoboMaker) DeleteRobotApplicationWithContext(ctx aws.Context, input *DeleteRobotApplicationInput, opts ...request.Option) (*DeleteRobotApplicationOutput, error) { - req, out := c.DeleteRobotApplicationRequest(input) +func (c *RoboMaker) CreateWorldTemplateWithContext(ctx aws.Context, input *CreateWorldTemplateInput, opts ...request.Option) (*CreateWorldTemplateOutput, error) { + req, out := c.CreateWorldTemplateRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDeleteSimulationApplication = "DeleteSimulationApplication" +const opDeleteFleet = "DeleteFleet" -// DeleteSimulationApplicationRequest generates a "aws/request.Request" representing the -// client's request for the DeleteSimulationApplication operation. The "output" return +// DeleteFleetRequest generates a "aws/request.Request" representing the +// client's request for the DeleteFleet 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 DeleteSimulationApplication for more information on using the DeleteSimulationApplication +// See DeleteFleet for more information on using the DeleteFleet // 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 DeleteSimulationApplicationRequest method. -// req, resp := client.DeleteSimulationApplicationRequest(params) +// // Example sending a request using the DeleteFleetRequest method. +// req, resp := client.DeleteFleetRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteSimulationApplication -func (c *RoboMaker) DeleteSimulationApplicationRequest(input *DeleteSimulationApplicationInput) (req *request.Request, output *DeleteSimulationApplicationOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteFleet +func (c *RoboMaker) DeleteFleetRequest(input *DeleteFleetInput) (req *request.Request, output *DeleteFleetOutput) { op := &request.Operation{ - Name: opDeleteSimulationApplication, + Name: opDeleteFleet, HTTPMethod: "POST", - HTTPPath: "/deleteSimulationApplication", + HTTPPath: "/deleteFleet", } if input == nil { - input = &DeleteSimulationApplicationInput{} + input = &DeleteFleetInput{} } - output = &DeleteSimulationApplicationOutput{} + output = &DeleteFleetOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DeleteSimulationApplication API operation for AWS RoboMaker. +// DeleteFleet API operation for AWS RoboMaker. // -// Deletes a simulation application. +// Deletes a fleet. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation DeleteSimulationApplication for usage and error information. +// API operation DeleteFleet for usage and error information. // // Returned Error Types: // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// * InternalServerException -// AWS RoboMaker experienced a service issue. Try your call again. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteSimulationApplication -func (c *RoboMaker) DeleteSimulationApplication(input *DeleteSimulationApplicationInput) (*DeleteSimulationApplicationOutput, error) { - req, out := c.DeleteSimulationApplicationRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteFleet +func (c *RoboMaker) DeleteFleet(input *DeleteFleetInput) (*DeleteFleetOutput, error) { + req, out := c.DeleteFleetRequest(input) return out, req.Send() } -// DeleteSimulationApplicationWithContext is the same as DeleteSimulationApplication with the addition of +// DeleteFleetWithContext is the same as DeleteFleet with the addition of // the ability to pass a context and additional request options. // -// See DeleteSimulationApplication for details on how to use this API operation. +// See DeleteFleet 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 *RoboMaker) DeleteSimulationApplicationWithContext(ctx aws.Context, input *DeleteSimulationApplicationInput, opts ...request.Option) (*DeleteSimulationApplicationOutput, error) { - req, out := c.DeleteSimulationApplicationRequest(input) +func (c *RoboMaker) DeleteFleetWithContext(ctx aws.Context, input *DeleteFleetInput, opts ...request.Option) (*DeleteFleetOutput, error) { + req, out := c.DeleteFleetRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDeregisterRobot = "DeregisterRobot" +const opDeleteRobot = "DeleteRobot" -// DeregisterRobotRequest generates a "aws/request.Request" representing the -// client's request for the DeregisterRobot operation. The "output" return +// DeleteRobotRequest generates a "aws/request.Request" representing the +// client's request for the DeleteRobot 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 DeregisterRobot for more information on using the DeregisterRobot +// See DeleteRobot for more information on using the DeleteRobot // 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 DeregisterRobotRequest method. -// req, resp := client.DeregisterRobotRequest(params) +// // Example sending a request using the DeleteRobotRequest method. +// req, resp := client.DeleteRobotRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeregisterRobot -func (c *RoboMaker) DeregisterRobotRequest(input *DeregisterRobotInput) (req *request.Request, output *DeregisterRobotOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteRobot +func (c *RoboMaker) DeleteRobotRequest(input *DeleteRobotInput) (req *request.Request, output *DeleteRobotOutput) { op := &request.Operation{ - Name: opDeregisterRobot, + Name: opDeleteRobot, HTTPMethod: "POST", - HTTPPath: "/deregisterRobot", + HTTPPath: "/deleteRobot", } if input == nil { - input = &DeregisterRobotInput{} + input = &DeleteRobotInput{} } - output = &DeregisterRobotOutput{} + output = &DeleteRobotOutput{} req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DeregisterRobot API operation for AWS RoboMaker. +// DeleteRobot API operation for AWS RoboMaker. // -// Deregisters a robot. +// Deletes a robot. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation DeregisterRobot for usage and error information. +// API operation DeleteRobot for usage and error information. // // Returned Error Types: // * InvalidParameterException @@ -1584,533 +1887,527 @@ func (c *RoboMaker) DeregisterRobotRequest(input *DeregisterRobotInput) (req *re // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// * ResourceNotFoundException -// The specified resource does not exist. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeregisterRobot -func (c *RoboMaker) DeregisterRobot(input *DeregisterRobotInput) (*DeregisterRobotOutput, error) { - req, out := c.DeregisterRobotRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteRobot +func (c *RoboMaker) DeleteRobot(input *DeleteRobotInput) (*DeleteRobotOutput, error) { + req, out := c.DeleteRobotRequest(input) return out, req.Send() } -// DeregisterRobotWithContext is the same as DeregisterRobot with the addition of +// DeleteRobotWithContext is the same as DeleteRobot with the addition of // the ability to pass a context and additional request options. // -// See DeregisterRobot for details on how to use this API operation. +// See DeleteRobot 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 *RoboMaker) DeregisterRobotWithContext(ctx aws.Context, input *DeregisterRobotInput, opts ...request.Option) (*DeregisterRobotOutput, error) { - req, out := c.DeregisterRobotRequest(input) +func (c *RoboMaker) DeleteRobotWithContext(ctx aws.Context, input *DeleteRobotInput, opts ...request.Option) (*DeleteRobotOutput, error) { + req, out := c.DeleteRobotRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeDeploymentJob = "DescribeDeploymentJob" +const opDeleteRobotApplication = "DeleteRobotApplication" -// DescribeDeploymentJobRequest generates a "aws/request.Request" representing the -// client's request for the DescribeDeploymentJob operation. The "output" return +// DeleteRobotApplicationRequest generates a "aws/request.Request" representing the +// client's request for the DeleteRobotApplication 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 DescribeDeploymentJob for more information on using the DescribeDeploymentJob +// See DeleteRobotApplication for more information on using the DeleteRobotApplication // 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 DescribeDeploymentJobRequest method. -// req, resp := client.DescribeDeploymentJobRequest(params) +// // Example sending a request using the DeleteRobotApplicationRequest method. +// req, resp := client.DeleteRobotApplicationRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeDeploymentJob -func (c *RoboMaker) DescribeDeploymentJobRequest(input *DescribeDeploymentJobInput) (req *request.Request, output *DescribeDeploymentJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteRobotApplication +func (c *RoboMaker) DeleteRobotApplicationRequest(input *DeleteRobotApplicationInput) (req *request.Request, output *DeleteRobotApplicationOutput) { op := &request.Operation{ - Name: opDescribeDeploymentJob, + Name: opDeleteRobotApplication, HTTPMethod: "POST", - HTTPPath: "/describeDeploymentJob", + HTTPPath: "/deleteRobotApplication", } if input == nil { - input = &DescribeDeploymentJobInput{} + input = &DeleteRobotApplicationInput{} } - output = &DescribeDeploymentJobOutput{} + output = &DeleteRobotApplicationOutput{} req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DescribeDeploymentJob API operation for AWS RoboMaker. +// DeleteRobotApplication API operation for AWS RoboMaker. // -// Describes a deployment job. +// Deletes a robot application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation DescribeDeploymentJob for usage and error information. +// API operation DeleteRobotApplication for usage and error information. // // Returned Error Types: -// * ResourceNotFoundException -// The specified resource does not exist. -// // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // -// * InternalServerException -// AWS RoboMaker experienced a service issue. Try your call again. -// // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeDeploymentJob -func (c *RoboMaker) DescribeDeploymentJob(input *DescribeDeploymentJobInput) (*DescribeDeploymentJobOutput, error) { - req, out := c.DescribeDeploymentJobRequest(input) +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteRobotApplication +func (c *RoboMaker) DeleteRobotApplication(input *DeleteRobotApplicationInput) (*DeleteRobotApplicationOutput, error) { + req, out := c.DeleteRobotApplicationRequest(input) return out, req.Send() } -// DescribeDeploymentJobWithContext is the same as DescribeDeploymentJob with the addition of +// DeleteRobotApplicationWithContext is the same as DeleteRobotApplication with the addition of // the ability to pass a context and additional request options. // -// See DescribeDeploymentJob for details on how to use this API operation. +// See DeleteRobotApplication 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 *RoboMaker) DescribeDeploymentJobWithContext(ctx aws.Context, input *DescribeDeploymentJobInput, opts ...request.Option) (*DescribeDeploymentJobOutput, error) { - req, out := c.DescribeDeploymentJobRequest(input) +func (c *RoboMaker) DeleteRobotApplicationWithContext(ctx aws.Context, input *DeleteRobotApplicationInput, opts ...request.Option) (*DeleteRobotApplicationOutput, error) { + req, out := c.DeleteRobotApplicationRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeFleet = "DescribeFleet" +const opDeleteSimulationApplication = "DeleteSimulationApplication" -// DescribeFleetRequest generates a "aws/request.Request" representing the -// client's request for the DescribeFleet operation. The "output" return +// DeleteSimulationApplicationRequest generates a "aws/request.Request" representing the +// client's request for the DeleteSimulationApplication 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 DescribeFleet for more information on using the DescribeFleet +// See DeleteSimulationApplication for more information on using the DeleteSimulationApplication // 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 DescribeFleetRequest method. -// req, resp := client.DescribeFleetRequest(params) +// // Example sending a request using the DeleteSimulationApplicationRequest method. +// req, resp := client.DeleteSimulationApplicationRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeFleet -func (c *RoboMaker) DescribeFleetRequest(input *DescribeFleetInput) (req *request.Request, output *DescribeFleetOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteSimulationApplication +func (c *RoboMaker) DeleteSimulationApplicationRequest(input *DeleteSimulationApplicationInput) (req *request.Request, output *DeleteSimulationApplicationOutput) { op := &request.Operation{ - Name: opDescribeFleet, + Name: opDeleteSimulationApplication, HTTPMethod: "POST", - HTTPPath: "/describeFleet", + HTTPPath: "/deleteSimulationApplication", } if input == nil { - input = &DescribeFleetInput{} + input = &DeleteSimulationApplicationInput{} } - output = &DescribeFleetOutput{} + output = &DeleteSimulationApplicationOutput{} req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DescribeFleet API operation for AWS RoboMaker. +// DeleteSimulationApplication API operation for AWS RoboMaker. // -// Describes a fleet. +// Deletes a simulation application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation DescribeFleet for usage and error information. +// API operation DeleteSimulationApplication for usage and error information. // // Returned Error Types: -// * ResourceNotFoundException -// The specified resource does not exist. -// // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // -// * InternalServerException -// AWS RoboMaker experienced a service issue. Try your call again. -// // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeFleet -func (c *RoboMaker) DescribeFleet(input *DescribeFleetInput) (*DescribeFleetOutput, error) { - req, out := c.DescribeFleetRequest(input) +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteSimulationApplication +func (c *RoboMaker) DeleteSimulationApplication(input *DeleteSimulationApplicationInput) (*DeleteSimulationApplicationOutput, error) { + req, out := c.DeleteSimulationApplicationRequest(input) return out, req.Send() } -// DescribeFleetWithContext is the same as DescribeFleet with the addition of +// DeleteSimulationApplicationWithContext is the same as DeleteSimulationApplication with the addition of // the ability to pass a context and additional request options. // -// See DescribeFleet for details on how to use this API operation. +// See DeleteSimulationApplication 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 *RoboMaker) DescribeFleetWithContext(ctx aws.Context, input *DescribeFleetInput, opts ...request.Option) (*DescribeFleetOutput, error) { - req, out := c.DescribeFleetRequest(input) +func (c *RoboMaker) DeleteSimulationApplicationWithContext(ctx aws.Context, input *DeleteSimulationApplicationInput, opts ...request.Option) (*DeleteSimulationApplicationOutput, error) { + req, out := c.DeleteSimulationApplicationRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeRobot = "DescribeRobot" +const opDeleteWorldTemplate = "DeleteWorldTemplate" -// DescribeRobotRequest generates a "aws/request.Request" representing the -// client's request for the DescribeRobot operation. The "output" return +// DeleteWorldTemplateRequest generates a "aws/request.Request" representing the +// client's request for the DeleteWorldTemplate 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 DescribeRobot for more information on using the DescribeRobot +// See DeleteWorldTemplate for more information on using the DeleteWorldTemplate // 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 DescribeRobotRequest method. -// req, resp := client.DescribeRobotRequest(params) +// // Example sending a request using the DeleteWorldTemplateRequest method. +// req, resp := client.DeleteWorldTemplateRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeRobot -func (c *RoboMaker) DescribeRobotRequest(input *DescribeRobotInput) (req *request.Request, output *DescribeRobotOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteWorldTemplate +func (c *RoboMaker) DeleteWorldTemplateRequest(input *DeleteWorldTemplateInput) (req *request.Request, output *DeleteWorldTemplateOutput) { op := &request.Operation{ - Name: opDescribeRobot, + Name: opDeleteWorldTemplate, HTTPMethod: "POST", - HTTPPath: "/describeRobot", + HTTPPath: "/deleteWorldTemplate", } if input == nil { - input = &DescribeRobotInput{} + input = &DeleteWorldTemplateInput{} } - output = &DescribeRobotOutput{} + output = &DeleteWorldTemplateOutput{} req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DescribeRobot API operation for AWS RoboMaker. +// DeleteWorldTemplate API operation for AWS RoboMaker. // -// Describes a robot. +// Deletes a world template. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation DescribeRobot for usage and error information. +// API operation DeleteWorldTemplate for usage and error information. // // Returned Error Types: -// * ResourceNotFoundException -// The specified resource does not exist. -// // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // -// * InternalServerException -// AWS RoboMaker experienced a service issue. Try your call again. +// * ResourceNotFoundException +// The specified resource does not exist. // // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeRobot -func (c *RoboMaker) DescribeRobot(input *DescribeRobotInput) (*DescribeRobotOutput, error) { - req, out := c.DescribeRobotRequest(input) +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteWorldTemplate +func (c *RoboMaker) DeleteWorldTemplate(input *DeleteWorldTemplateInput) (*DeleteWorldTemplateOutput, error) { + req, out := c.DeleteWorldTemplateRequest(input) return out, req.Send() } -// DescribeRobotWithContext is the same as DescribeRobot with the addition of +// DeleteWorldTemplateWithContext is the same as DeleteWorldTemplate with the addition of // the ability to pass a context and additional request options. // -// See DescribeRobot for details on how to use this API operation. +// See DeleteWorldTemplate 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 *RoboMaker) DescribeRobotWithContext(ctx aws.Context, input *DescribeRobotInput, opts ...request.Option) (*DescribeRobotOutput, error) { - req, out := c.DescribeRobotRequest(input) +func (c *RoboMaker) DeleteWorldTemplateWithContext(ctx aws.Context, input *DeleteWorldTemplateInput, opts ...request.Option) (*DeleteWorldTemplateOutput, error) { + req, out := c.DeleteWorldTemplateRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeRobotApplication = "DescribeRobotApplication" +const opDeregisterRobot = "DeregisterRobot" -// DescribeRobotApplicationRequest generates a "aws/request.Request" representing the -// client's request for the DescribeRobotApplication operation. The "output" return +// DeregisterRobotRequest generates a "aws/request.Request" representing the +// client's request for the DeregisterRobot 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 DescribeRobotApplication for more information on using the DescribeRobotApplication +// See DeregisterRobot for more information on using the DeregisterRobot // 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 DescribeRobotApplicationRequest method. -// req, resp := client.DescribeRobotApplicationRequest(params) +// // Example sending a request using the DeregisterRobotRequest method. +// req, resp := client.DeregisterRobotRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeRobotApplication -func (c *RoboMaker) DescribeRobotApplicationRequest(input *DescribeRobotApplicationInput) (req *request.Request, output *DescribeRobotApplicationOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeregisterRobot +func (c *RoboMaker) DeregisterRobotRequest(input *DeregisterRobotInput) (req *request.Request, output *DeregisterRobotOutput) { op := &request.Operation{ - Name: opDescribeRobotApplication, + Name: opDeregisterRobot, HTTPMethod: "POST", - HTTPPath: "/describeRobotApplication", + HTTPPath: "/deregisterRobot", } if input == nil { - input = &DescribeRobotApplicationInput{} + input = &DeregisterRobotInput{} } - output = &DescribeRobotApplicationOutput{} + output = &DeregisterRobotOutput{} req = c.newRequest(op, input, output) return } -// DescribeRobotApplication API operation for AWS RoboMaker. +// DeregisterRobot API operation for AWS RoboMaker. // -// Describes a robot application. +// Deregisters a robot. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation DescribeRobotApplication for usage and error information. +// API operation DeregisterRobot for usage and error information. // // Returned Error Types: // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // -// * ResourceNotFoundException -// The specified resource does not exist. +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. // // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// * InternalServerException -// AWS RoboMaker experienced a service issue. Try your call again. +// * ResourceNotFoundException +// The specified resource does not exist. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeRobotApplication -func (c *RoboMaker) DescribeRobotApplication(input *DescribeRobotApplicationInput) (*DescribeRobotApplicationOutput, error) { - req, out := c.DescribeRobotApplicationRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeregisterRobot +func (c *RoboMaker) DeregisterRobot(input *DeregisterRobotInput) (*DeregisterRobotOutput, error) { + req, out := c.DeregisterRobotRequest(input) return out, req.Send() } -// DescribeRobotApplicationWithContext is the same as DescribeRobotApplication with the addition of +// DeregisterRobotWithContext is the same as DeregisterRobot with the addition of // the ability to pass a context and additional request options. // -// See DescribeRobotApplication for details on how to use this API operation. +// See DeregisterRobot 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 *RoboMaker) DescribeRobotApplicationWithContext(ctx aws.Context, input *DescribeRobotApplicationInput, opts ...request.Option) (*DescribeRobotApplicationOutput, error) { - req, out := c.DescribeRobotApplicationRequest(input) +func (c *RoboMaker) DeregisterRobotWithContext(ctx aws.Context, input *DeregisterRobotInput, opts ...request.Option) (*DeregisterRobotOutput, error) { + req, out := c.DeregisterRobotRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeSimulationApplication = "DescribeSimulationApplication" +const opDescribeDeploymentJob = "DescribeDeploymentJob" -// DescribeSimulationApplicationRequest generates a "aws/request.Request" representing the -// client's request for the DescribeSimulationApplication operation. The "output" return +// DescribeDeploymentJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribeDeploymentJob 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 DescribeSimulationApplication for more information on using the DescribeSimulationApplication +// See DescribeDeploymentJob for more information on using the DescribeDeploymentJob // 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 DescribeSimulationApplicationRequest method. -// req, resp := client.DescribeSimulationApplicationRequest(params) +// // Example sending a request using the DescribeDeploymentJobRequest method. +// req, resp := client.DescribeDeploymentJobRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationApplication -func (c *RoboMaker) DescribeSimulationApplicationRequest(input *DescribeSimulationApplicationInput) (req *request.Request, output *DescribeSimulationApplicationOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeDeploymentJob +func (c *RoboMaker) DescribeDeploymentJobRequest(input *DescribeDeploymentJobInput) (req *request.Request, output *DescribeDeploymentJobOutput) { op := &request.Operation{ - Name: opDescribeSimulationApplication, + Name: opDescribeDeploymentJob, HTTPMethod: "POST", - HTTPPath: "/describeSimulationApplication", + HTTPPath: "/describeDeploymentJob", } if input == nil { - input = &DescribeSimulationApplicationInput{} + input = &DescribeDeploymentJobInput{} } - output = &DescribeSimulationApplicationOutput{} + output = &DescribeDeploymentJobOutput{} req = c.newRequest(op, input, output) return } -// DescribeSimulationApplication API operation for AWS RoboMaker. +// DescribeDeploymentJob API operation for AWS RoboMaker. // -// Describes a simulation application. +// Describes a deployment job. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation DescribeSimulationApplication for usage and error information. +// API operation DescribeDeploymentJob for usage and error information. // // Returned Error Types: +// * ResourceNotFoundException +// The specified resource does not exist. +// // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // -// * ResourceNotFoundException -// The specified resource does not exist. +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. // // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// * InternalServerException -// AWS RoboMaker experienced a service issue. Try your call again. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationApplication -func (c *RoboMaker) DescribeSimulationApplication(input *DescribeSimulationApplicationInput) (*DescribeSimulationApplicationOutput, error) { - req, out := c.DescribeSimulationApplicationRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeDeploymentJob +func (c *RoboMaker) DescribeDeploymentJob(input *DescribeDeploymentJobInput) (*DescribeDeploymentJobOutput, error) { + req, out := c.DescribeDeploymentJobRequest(input) return out, req.Send() } -// DescribeSimulationApplicationWithContext is the same as DescribeSimulationApplication with the addition of +// DescribeDeploymentJobWithContext is the same as DescribeDeploymentJob with the addition of // the ability to pass a context and additional request options. // -// See DescribeSimulationApplication for details on how to use this API operation. +// See DescribeDeploymentJob 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 *RoboMaker) DescribeSimulationApplicationWithContext(ctx aws.Context, input *DescribeSimulationApplicationInput, opts ...request.Option) (*DescribeSimulationApplicationOutput, error) { - req, out := c.DescribeSimulationApplicationRequest(input) +func (c *RoboMaker) DescribeDeploymentJobWithContext(ctx aws.Context, input *DescribeDeploymentJobInput, opts ...request.Option) (*DescribeDeploymentJobOutput, error) { + req, out := c.DescribeDeploymentJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeSimulationJob = "DescribeSimulationJob" +const opDescribeFleet = "DescribeFleet" -// DescribeSimulationJobRequest generates a "aws/request.Request" representing the -// client's request for the DescribeSimulationJob operation. The "output" return +// DescribeFleetRequest generates a "aws/request.Request" representing the +// client's request for the DescribeFleet 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 DescribeSimulationJob for more information on using the DescribeSimulationJob +// See DescribeFleet for more information on using the DescribeFleet // 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 DescribeSimulationJobRequest method. -// req, resp := client.DescribeSimulationJobRequest(params) +// // Example sending a request using the DescribeFleetRequest method. +// req, resp := client.DescribeFleetRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationJob -func (c *RoboMaker) DescribeSimulationJobRequest(input *DescribeSimulationJobInput) (req *request.Request, output *DescribeSimulationJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeFleet +func (c *RoboMaker) DescribeFleetRequest(input *DescribeFleetInput) (req *request.Request, output *DescribeFleetOutput) { op := &request.Operation{ - Name: opDescribeSimulationJob, + Name: opDescribeFleet, HTTPMethod: "POST", - HTTPPath: "/describeSimulationJob", + HTTPPath: "/describeFleet", } if input == nil { - input = &DescribeSimulationJobInput{} + input = &DescribeFleetInput{} } - output = &DescribeSimulationJobOutput{} + output = &DescribeFleetOutput{} req = c.newRequest(op, input, output) return } -// DescribeSimulationJob API operation for AWS RoboMaker. +// DescribeFleet API operation for AWS RoboMaker. // -// Describes a simulation job. +// Describes a fleet. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation DescribeSimulationJob for usage and error information. +// API operation DescribeFleet for usage and error information. // // Returned Error Types: // * ResourceNotFoundException @@ -2127,80 +2424,80 @@ func (c *RoboMaker) DescribeSimulationJobRequest(input *DescribeSimulationJobInp // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationJob -func (c *RoboMaker) DescribeSimulationJob(input *DescribeSimulationJobInput) (*DescribeSimulationJobOutput, error) { - req, out := c.DescribeSimulationJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeFleet +func (c *RoboMaker) DescribeFleet(input *DescribeFleetInput) (*DescribeFleetOutput, error) { + req, out := c.DescribeFleetRequest(input) return out, req.Send() } -// DescribeSimulationJobWithContext is the same as DescribeSimulationJob with the addition of +// DescribeFleetWithContext is the same as DescribeFleet with the addition of // the ability to pass a context and additional request options. // -// See DescribeSimulationJob for details on how to use this API operation. +// See DescribeFleet 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 *RoboMaker) DescribeSimulationJobWithContext(ctx aws.Context, input *DescribeSimulationJobInput, opts ...request.Option) (*DescribeSimulationJobOutput, error) { - req, out := c.DescribeSimulationJobRequest(input) +func (c *RoboMaker) DescribeFleetWithContext(ctx aws.Context, input *DescribeFleetInput, opts ...request.Option) (*DescribeFleetOutput, error) { + req, out := c.DescribeFleetRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opDescribeSimulationJobBatch = "DescribeSimulationJobBatch" +const opDescribeRobot = "DescribeRobot" -// DescribeSimulationJobBatchRequest generates a "aws/request.Request" representing the -// client's request for the DescribeSimulationJobBatch operation. The "output" return +// DescribeRobotRequest generates a "aws/request.Request" representing the +// client's request for the DescribeRobot 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 DescribeSimulationJobBatch for more information on using the DescribeSimulationJobBatch +// See DescribeRobot for more information on using the DescribeRobot // 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 DescribeSimulationJobBatchRequest method. -// req, resp := client.DescribeSimulationJobBatchRequest(params) +// // Example sending a request using the DescribeRobotRequest method. +// req, resp := client.DescribeRobotRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationJobBatch -func (c *RoboMaker) DescribeSimulationJobBatchRequest(input *DescribeSimulationJobBatchInput) (req *request.Request, output *DescribeSimulationJobBatchOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeRobot +func (c *RoboMaker) DescribeRobotRequest(input *DescribeRobotInput) (req *request.Request, output *DescribeRobotOutput) { op := &request.Operation{ - Name: opDescribeSimulationJobBatch, + Name: opDescribeRobot, HTTPMethod: "POST", - HTTPPath: "/describeSimulationJobBatch", + HTTPPath: "/describeRobot", } if input == nil { - input = &DescribeSimulationJobBatchInput{} + input = &DescribeRobotInput{} } - output = &DescribeSimulationJobBatchOutput{} + output = &DescribeRobotOutput{} req = c.newRequest(op, input, output) return } -// DescribeSimulationJobBatch API operation for AWS RoboMaker. +// DescribeRobot API operation for AWS RoboMaker. // -// Describes a simulation job batch. +// Describes a robot. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation DescribeSimulationJobBatch for usage and error information. +// API operation DescribeRobot for usage and error information. // // Returned Error Types: // * ResourceNotFoundException @@ -2213,531 +2510,354 @@ func (c *RoboMaker) DescribeSimulationJobBatchRequest(input *DescribeSimulationJ // * InternalServerException // AWS RoboMaker experienced a service issue. Try your call again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationJobBatch -func (c *RoboMaker) DescribeSimulationJobBatch(input *DescribeSimulationJobBatchInput) (*DescribeSimulationJobBatchOutput, error) { - req, out := c.DescribeSimulationJobBatchRequest(input) +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeRobot +func (c *RoboMaker) DescribeRobot(input *DescribeRobotInput) (*DescribeRobotOutput, error) { + req, out := c.DescribeRobotRequest(input) return out, req.Send() } -// DescribeSimulationJobBatchWithContext is the same as DescribeSimulationJobBatch with the addition of +// DescribeRobotWithContext is the same as DescribeRobot with the addition of // the ability to pass a context and additional request options. // -// See DescribeSimulationJobBatch for details on how to use this API operation. +// See DescribeRobot 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 *RoboMaker) DescribeSimulationJobBatchWithContext(ctx aws.Context, input *DescribeSimulationJobBatchInput, opts ...request.Option) (*DescribeSimulationJobBatchOutput, error) { - req, out := c.DescribeSimulationJobBatchRequest(input) +func (c *RoboMaker) DescribeRobotWithContext(ctx aws.Context, input *DescribeRobotInput, opts ...request.Option) (*DescribeRobotOutput, error) { + req, out := c.DescribeRobotRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opListDeploymentJobs = "ListDeploymentJobs" +const opDescribeRobotApplication = "DescribeRobotApplication" -// ListDeploymentJobsRequest generates a "aws/request.Request" representing the -// client's request for the ListDeploymentJobs operation. The "output" return +// DescribeRobotApplicationRequest generates a "aws/request.Request" representing the +// client's request for the DescribeRobotApplication 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 ListDeploymentJobs for more information on using the ListDeploymentJobs +// See DescribeRobotApplication for more information on using the DescribeRobotApplication // 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 ListDeploymentJobsRequest method. -// req, resp := client.ListDeploymentJobsRequest(params) +// // Example sending a request using the DescribeRobotApplicationRequest method. +// req, resp := client.DescribeRobotApplicationRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListDeploymentJobs -func (c *RoboMaker) ListDeploymentJobsRequest(input *ListDeploymentJobsInput) (req *request.Request, output *ListDeploymentJobsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeRobotApplication +func (c *RoboMaker) DescribeRobotApplicationRequest(input *DescribeRobotApplicationInput) (req *request.Request, output *DescribeRobotApplicationOutput) { op := &request.Operation{ - Name: opListDeploymentJobs, + Name: opDescribeRobotApplication, HTTPMethod: "POST", - HTTPPath: "/listDeploymentJobs", - Paginator: &request.Paginator{ - InputTokens: []string{"nextToken"}, - OutputTokens: []string{"nextToken"}, - LimitToken: "maxResults", - TruncationToken: "", - }, + HTTPPath: "/describeRobotApplication", } if input == nil { - input = &ListDeploymentJobsInput{} + input = &DescribeRobotApplicationInput{} } - output = &ListDeploymentJobsOutput{} + output = &DescribeRobotApplicationOutput{} req = c.newRequest(op, input, output) return } -// ListDeploymentJobs API operation for AWS RoboMaker. +// DescribeRobotApplication API operation for AWS RoboMaker. // -// Returns a list of deployment jobs for a fleet. You can optionally provide -// filters to retrieve specific deployment jobs. +// Describes a robot application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation ListDeploymentJobs for usage and error information. +// API operation DescribeRobotApplication for usage and error information. // // Returned Error Types: -// * ResourceNotFoundException -// The specified resource does not exist. -// // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // -// * InternalServerException -// AWS RoboMaker experienced a service issue. Try your call again. +// * ResourceNotFoundException +// The specified resource does not exist. // // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListDeploymentJobs -func (c *RoboMaker) ListDeploymentJobs(input *ListDeploymentJobsInput) (*ListDeploymentJobsOutput, error) { - req, out := c.ListDeploymentJobsRequest(input) +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeRobotApplication +func (c *RoboMaker) DescribeRobotApplication(input *DescribeRobotApplicationInput) (*DescribeRobotApplicationOutput, error) { + req, out := c.DescribeRobotApplicationRequest(input) return out, req.Send() } -// ListDeploymentJobsWithContext is the same as ListDeploymentJobs with the addition of +// DescribeRobotApplicationWithContext is the same as DescribeRobotApplication with the addition of // the ability to pass a context and additional request options. // -// See ListDeploymentJobs for details on how to use this API operation. +// See DescribeRobotApplication 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 *RoboMaker) ListDeploymentJobsWithContext(ctx aws.Context, input *ListDeploymentJobsInput, opts ...request.Option) (*ListDeploymentJobsOutput, error) { - req, out := c.ListDeploymentJobsRequest(input) +func (c *RoboMaker) DescribeRobotApplicationWithContext(ctx aws.Context, input *DescribeRobotApplicationInput, opts ...request.Option) (*DescribeRobotApplicationOutput, error) { + req, out := c.DescribeRobotApplicationRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListDeploymentJobsPages iterates over the pages of a ListDeploymentJobs operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. -// -// See ListDeploymentJobs 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 ListDeploymentJobs operation. -// pageNum := 0 -// err := client.ListDeploymentJobsPages(params, -// func(page *robomaker.ListDeploymentJobsOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) -// -func (c *RoboMaker) ListDeploymentJobsPages(input *ListDeploymentJobsInput, fn func(*ListDeploymentJobsOutput, bool) bool) error { - return c.ListDeploymentJobsPagesWithContext(aws.BackgroundContext(), input, fn) -} - -// ListDeploymentJobsPagesWithContext same as ListDeploymentJobsPages 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 *RoboMaker) ListDeploymentJobsPagesWithContext(ctx aws.Context, input *ListDeploymentJobsInput, fn func(*ListDeploymentJobsOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *ListDeploymentJobsInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.ListDeploymentJobsRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*ListDeploymentJobsOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() -} - -const opListFleets = "ListFleets" +const opDescribeSimulationApplication = "DescribeSimulationApplication" -// ListFleetsRequest generates a "aws/request.Request" representing the -// client's request for the ListFleets operation. The "output" return +// DescribeSimulationApplicationRequest generates a "aws/request.Request" representing the +// client's request for the DescribeSimulationApplication 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 ListFleets for more information on using the ListFleets +// See DescribeSimulationApplication for more information on using the DescribeSimulationApplication // 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 ListFleetsRequest method. -// req, resp := client.ListFleetsRequest(params) +// // Example sending a request using the DescribeSimulationApplicationRequest method. +// req, resp := client.DescribeSimulationApplicationRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListFleets -func (c *RoboMaker) ListFleetsRequest(input *ListFleetsInput) (req *request.Request, output *ListFleetsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationApplication +func (c *RoboMaker) DescribeSimulationApplicationRequest(input *DescribeSimulationApplicationInput) (req *request.Request, output *DescribeSimulationApplicationOutput) { op := &request.Operation{ - Name: opListFleets, + Name: opDescribeSimulationApplication, HTTPMethod: "POST", - HTTPPath: "/listFleets", - Paginator: &request.Paginator{ - InputTokens: []string{"nextToken"}, - OutputTokens: []string{"nextToken"}, - LimitToken: "maxResults", - TruncationToken: "", - }, + HTTPPath: "/describeSimulationApplication", } if input == nil { - input = &ListFleetsInput{} + input = &DescribeSimulationApplicationInput{} } - output = &ListFleetsOutput{} + output = &DescribeSimulationApplicationOutput{} req = c.newRequest(op, input, output) return } -// ListFleets API operation for AWS RoboMaker. +// DescribeSimulationApplication API operation for AWS RoboMaker. // -// Returns a list of fleets. You can optionally provide filters to retrieve -// specific fleets. +// Describes a simulation application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation ListFleets for usage and error information. +// API operation DescribeSimulationApplication for usage and error information. // // Returned Error Types: -// * ResourceNotFoundException -// The specified resource does not exist. -// // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // -// * InternalServerException -// AWS RoboMaker experienced a service issue. Try your call again. +// * ResourceNotFoundException +// The specified resource does not exist. // // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListFleets -func (c *RoboMaker) ListFleets(input *ListFleetsInput) (*ListFleetsOutput, error) { - req, out := c.ListFleetsRequest(input) +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationApplication +func (c *RoboMaker) DescribeSimulationApplication(input *DescribeSimulationApplicationInput) (*DescribeSimulationApplicationOutput, error) { + req, out := c.DescribeSimulationApplicationRequest(input) return out, req.Send() } -// ListFleetsWithContext is the same as ListFleets with the addition of +// DescribeSimulationApplicationWithContext is the same as DescribeSimulationApplication with the addition of // the ability to pass a context and additional request options. // -// See ListFleets for details on how to use this API operation. +// See DescribeSimulationApplication 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 *RoboMaker) ListFleetsWithContext(ctx aws.Context, input *ListFleetsInput, opts ...request.Option) (*ListFleetsOutput, error) { - req, out := c.ListFleetsRequest(input) +func (c *RoboMaker) DescribeSimulationApplicationWithContext(ctx aws.Context, input *DescribeSimulationApplicationInput, opts ...request.Option) (*DescribeSimulationApplicationOutput, error) { + req, out := c.DescribeSimulationApplicationRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListFleetsPages iterates over the pages of a ListFleets operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. -// -// See ListFleets 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 ListFleets operation. -// pageNum := 0 -// err := client.ListFleetsPages(params, -// func(page *robomaker.ListFleetsOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) -// -func (c *RoboMaker) ListFleetsPages(input *ListFleetsInput, fn func(*ListFleetsOutput, bool) bool) error { - return c.ListFleetsPagesWithContext(aws.BackgroundContext(), input, fn) -} - -// ListFleetsPagesWithContext same as ListFleetsPages 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 *RoboMaker) ListFleetsPagesWithContext(ctx aws.Context, input *ListFleetsInput, fn func(*ListFleetsOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *ListFleetsInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.ListFleetsRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*ListFleetsOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() -} - -const opListRobotApplications = "ListRobotApplications" +const opDescribeSimulationJob = "DescribeSimulationJob" -// ListRobotApplicationsRequest generates a "aws/request.Request" representing the -// client's request for the ListRobotApplications operation. The "output" return +// DescribeSimulationJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribeSimulationJob 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 ListRobotApplications for more information on using the ListRobotApplications +// See DescribeSimulationJob for more information on using the DescribeSimulationJob // 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 ListRobotApplicationsRequest method. -// req, resp := client.ListRobotApplicationsRequest(params) +// // Example sending a request using the DescribeSimulationJobRequest method. +// req, resp := client.DescribeSimulationJobRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListRobotApplications -func (c *RoboMaker) ListRobotApplicationsRequest(input *ListRobotApplicationsInput) (req *request.Request, output *ListRobotApplicationsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationJob +func (c *RoboMaker) DescribeSimulationJobRequest(input *DescribeSimulationJobInput) (req *request.Request, output *DescribeSimulationJobOutput) { op := &request.Operation{ - Name: opListRobotApplications, + Name: opDescribeSimulationJob, HTTPMethod: "POST", - HTTPPath: "/listRobotApplications", - Paginator: &request.Paginator{ - InputTokens: []string{"nextToken"}, - OutputTokens: []string{"nextToken"}, - LimitToken: "maxResults", - TruncationToken: "", - }, + HTTPPath: "/describeSimulationJob", } if input == nil { - input = &ListRobotApplicationsInput{} + input = &DescribeSimulationJobInput{} } - output = &ListRobotApplicationsOutput{} + output = &DescribeSimulationJobOutput{} req = c.newRequest(op, input, output) return } -// ListRobotApplications API operation for AWS RoboMaker. +// DescribeSimulationJob API operation for AWS RoboMaker. // -// Returns a list of robot application. You can optionally provide filters to -// retrieve specific robot applications. +// Describes a simulation job. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation ListRobotApplications for usage and error information. +// API operation DescribeSimulationJob for usage and error information. // // Returned Error Types: +// * ResourceNotFoundException +// The specified resource does not exist. +// // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// * InternalServerException -// AWS RoboMaker experienced a service issue. Try your call again. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListRobotApplications -func (c *RoboMaker) ListRobotApplications(input *ListRobotApplicationsInput) (*ListRobotApplicationsOutput, error) { - req, out := c.ListRobotApplicationsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationJob +func (c *RoboMaker) DescribeSimulationJob(input *DescribeSimulationJobInput) (*DescribeSimulationJobOutput, error) { + req, out := c.DescribeSimulationJobRequest(input) return out, req.Send() } -// ListRobotApplicationsWithContext is the same as ListRobotApplications with the addition of +// DescribeSimulationJobWithContext is the same as DescribeSimulationJob with the addition of // the ability to pass a context and additional request options. // -// See ListRobotApplications for details on how to use this API operation. +// See DescribeSimulationJob 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 *RoboMaker) ListRobotApplicationsWithContext(ctx aws.Context, input *ListRobotApplicationsInput, opts ...request.Option) (*ListRobotApplicationsOutput, error) { - req, out := c.ListRobotApplicationsRequest(input) +func (c *RoboMaker) DescribeSimulationJobWithContext(ctx aws.Context, input *DescribeSimulationJobInput, opts ...request.Option) (*DescribeSimulationJobOutput, error) { + req, out := c.DescribeSimulationJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListRobotApplicationsPages iterates over the pages of a ListRobotApplications operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. -// -// See ListRobotApplications 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 ListRobotApplications operation. -// pageNum := 0 -// err := client.ListRobotApplicationsPages(params, -// func(page *robomaker.ListRobotApplicationsOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) -// -func (c *RoboMaker) ListRobotApplicationsPages(input *ListRobotApplicationsInput, fn func(*ListRobotApplicationsOutput, bool) bool) error { - return c.ListRobotApplicationsPagesWithContext(aws.BackgroundContext(), input, fn) -} - -// ListRobotApplicationsPagesWithContext same as ListRobotApplicationsPages 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 *RoboMaker) ListRobotApplicationsPagesWithContext(ctx aws.Context, input *ListRobotApplicationsInput, fn func(*ListRobotApplicationsOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *ListRobotApplicationsInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.ListRobotApplicationsRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*ListRobotApplicationsOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() -} - -const opListRobots = "ListRobots" +const opDescribeSimulationJobBatch = "DescribeSimulationJobBatch" -// ListRobotsRequest generates a "aws/request.Request" representing the -// client's request for the ListRobots operation. The "output" return +// DescribeSimulationJobBatchRequest generates a "aws/request.Request" representing the +// client's request for the DescribeSimulationJobBatch 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 ListRobots for more information on using the ListRobots +// See DescribeSimulationJobBatch for more information on using the DescribeSimulationJobBatch // 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 ListRobotsRequest method. -// req, resp := client.ListRobotsRequest(params) +// // Example sending a request using the DescribeSimulationJobBatchRequest method. +// req, resp := client.DescribeSimulationJobBatchRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListRobots -func (c *RoboMaker) ListRobotsRequest(input *ListRobotsInput) (req *request.Request, output *ListRobotsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationJobBatch +func (c *RoboMaker) DescribeSimulationJobBatchRequest(input *DescribeSimulationJobBatchInput) (req *request.Request, output *DescribeSimulationJobBatchOutput) { op := &request.Operation{ - Name: opListRobots, + Name: opDescribeSimulationJobBatch, HTTPMethod: "POST", - HTTPPath: "/listRobots", - Paginator: &request.Paginator{ - InputTokens: []string{"nextToken"}, - OutputTokens: []string{"nextToken"}, - LimitToken: "maxResults", - TruncationToken: "", - }, + HTTPPath: "/describeSimulationJobBatch", } if input == nil { - input = &ListRobotsInput{} + input = &DescribeSimulationJobBatchInput{} } - output = &ListRobotsOutput{} + output = &DescribeSimulationJobBatchOutput{} req = c.newRequest(op, input, output) return } -// ListRobots API operation for AWS RoboMaker. +// DescribeSimulationJobBatch API operation for AWS RoboMaker. // -// Returns a list of robots. You can optionally provide filters to retrieve -// specific robots. +// Describes a simulation job batch. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation ListRobots for usage and error information. +// API operation DescribeSimulationJobBatch for usage and error information. // // Returned Error Types: // * ResourceNotFoundException @@ -2750,149 +2870,89 @@ func (c *RoboMaker) ListRobotsRequest(input *ListRobotsInput) (req *request.Requ // * InternalServerException // AWS RoboMaker experienced a service issue. Try your call again. // -// * ThrottlingException -// AWS RoboMaker is temporarily unable to process the request. Try your call -// again. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListRobots -func (c *RoboMaker) ListRobots(input *ListRobotsInput) (*ListRobotsOutput, error) { - req, out := c.ListRobotsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationJobBatch +func (c *RoboMaker) DescribeSimulationJobBatch(input *DescribeSimulationJobBatchInput) (*DescribeSimulationJobBatchOutput, error) { + req, out := c.DescribeSimulationJobBatchRequest(input) return out, req.Send() } -// ListRobotsWithContext is the same as ListRobots with the addition of +// DescribeSimulationJobBatchWithContext is the same as DescribeSimulationJobBatch with the addition of // the ability to pass a context and additional request options. // -// See ListRobots for details on how to use this API operation. +// See DescribeSimulationJobBatch 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 *RoboMaker) ListRobotsWithContext(ctx aws.Context, input *ListRobotsInput, opts ...request.Option) (*ListRobotsOutput, error) { - req, out := c.ListRobotsRequest(input) +func (c *RoboMaker) DescribeSimulationJobBatchWithContext(ctx aws.Context, input *DescribeSimulationJobBatchInput, opts ...request.Option) (*DescribeSimulationJobBatchOutput, error) { + req, out := c.DescribeSimulationJobBatchRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListRobotsPages iterates over the pages of a ListRobots operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. -// -// See ListRobots 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 ListRobots operation. -// pageNum := 0 -// err := client.ListRobotsPages(params, -// func(page *robomaker.ListRobotsOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) -// -func (c *RoboMaker) ListRobotsPages(input *ListRobotsInput, fn func(*ListRobotsOutput, bool) bool) error { - return c.ListRobotsPagesWithContext(aws.BackgroundContext(), input, fn) -} - -// ListRobotsPagesWithContext same as ListRobotsPages 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 *RoboMaker) ListRobotsPagesWithContext(ctx aws.Context, input *ListRobotsInput, fn func(*ListRobotsOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *ListRobotsInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.ListRobotsRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*ListRobotsOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() -} - -const opListSimulationApplications = "ListSimulationApplications" +const opDescribeWorld = "DescribeWorld" -// ListSimulationApplicationsRequest generates a "aws/request.Request" representing the -// client's request for the ListSimulationApplications operation. The "output" return +// DescribeWorldRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWorld 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 ListSimulationApplications for more information on using the ListSimulationApplications +// See DescribeWorld for more information on using the DescribeWorld // 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 ListSimulationApplicationsRequest method. -// req, resp := client.ListSimulationApplicationsRequest(params) +// // Example sending a request using the DescribeWorldRequest method. +// req, resp := client.DescribeWorldRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationApplications -func (c *RoboMaker) ListSimulationApplicationsRequest(input *ListSimulationApplicationsInput) (req *request.Request, output *ListSimulationApplicationsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeWorld +func (c *RoboMaker) DescribeWorldRequest(input *DescribeWorldInput) (req *request.Request, output *DescribeWorldOutput) { op := &request.Operation{ - Name: opListSimulationApplications, + Name: opDescribeWorld, HTTPMethod: "POST", - HTTPPath: "/listSimulationApplications", - Paginator: &request.Paginator{ - InputTokens: []string{"nextToken"}, - OutputTokens: []string{"nextToken"}, - LimitToken: "maxResults", - TruncationToken: "", - }, + HTTPPath: "/describeWorld", } if input == nil { - input = &ListSimulationApplicationsInput{} + input = &DescribeWorldInput{} } - output = &ListSimulationApplicationsOutput{} + output = &DescribeWorldOutput{} req = c.newRequest(op, input, output) return } -// ListSimulationApplications API operation for AWS RoboMaker. +// DescribeWorld API operation for AWS RoboMaker. // -// Returns a list of simulation applications. You can optionally provide filters -// to retrieve specific simulation applications. +// Describes a world. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation ListSimulationApplications for usage and error information. +// API operation DescribeWorld for usage and error information. // // Returned Error Types: // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // +// * ResourceNotFoundException +// The specified resource does not exist. +// // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. @@ -2900,141 +2960,85 @@ func (c *RoboMaker) ListSimulationApplicationsRequest(input *ListSimulationAppli // * InternalServerException // AWS RoboMaker experienced a service issue. Try your call again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationApplications -func (c *RoboMaker) ListSimulationApplications(input *ListSimulationApplicationsInput) (*ListSimulationApplicationsOutput, error) { - req, out := c.ListSimulationApplicationsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeWorld +func (c *RoboMaker) DescribeWorld(input *DescribeWorldInput) (*DescribeWorldOutput, error) { + req, out := c.DescribeWorldRequest(input) return out, req.Send() } -// ListSimulationApplicationsWithContext is the same as ListSimulationApplications with the addition of +// DescribeWorldWithContext is the same as DescribeWorld with the addition of // the ability to pass a context and additional request options. // -// See ListSimulationApplications for details on how to use this API operation. +// See DescribeWorld 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 *RoboMaker) ListSimulationApplicationsWithContext(ctx aws.Context, input *ListSimulationApplicationsInput, opts ...request.Option) (*ListSimulationApplicationsOutput, error) { - req, out := c.ListSimulationApplicationsRequest(input) +func (c *RoboMaker) DescribeWorldWithContext(ctx aws.Context, input *DescribeWorldInput, opts ...request.Option) (*DescribeWorldOutput, error) { + req, out := c.DescribeWorldRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListSimulationApplicationsPages iterates over the pages of a ListSimulationApplications operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. -// -// See ListSimulationApplications 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 ListSimulationApplications operation. -// pageNum := 0 -// err := client.ListSimulationApplicationsPages(params, -// func(page *robomaker.ListSimulationApplicationsOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) -// -func (c *RoboMaker) ListSimulationApplicationsPages(input *ListSimulationApplicationsInput, fn func(*ListSimulationApplicationsOutput, bool) bool) error { - return c.ListSimulationApplicationsPagesWithContext(aws.BackgroundContext(), input, fn) -} - -// ListSimulationApplicationsPagesWithContext same as ListSimulationApplicationsPages 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 *RoboMaker) ListSimulationApplicationsPagesWithContext(ctx aws.Context, input *ListSimulationApplicationsInput, fn func(*ListSimulationApplicationsOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *ListSimulationApplicationsInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.ListSimulationApplicationsRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*ListSimulationApplicationsOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() -} - -const opListSimulationJobBatches = "ListSimulationJobBatches" +const opDescribeWorldExportJob = "DescribeWorldExportJob" -// ListSimulationJobBatchesRequest generates a "aws/request.Request" representing the -// client's request for the ListSimulationJobBatches operation. The "output" return +// DescribeWorldExportJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWorldExportJob 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 ListSimulationJobBatches for more information on using the ListSimulationJobBatches +// See DescribeWorldExportJob for more information on using the DescribeWorldExportJob // 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 ListSimulationJobBatchesRequest method. -// req, resp := client.ListSimulationJobBatchesRequest(params) +// // Example sending a request using the DescribeWorldExportJobRequest method. +// req, resp := client.DescribeWorldExportJobRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationJobBatches -func (c *RoboMaker) ListSimulationJobBatchesRequest(input *ListSimulationJobBatchesInput) (req *request.Request, output *ListSimulationJobBatchesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeWorldExportJob +func (c *RoboMaker) DescribeWorldExportJobRequest(input *DescribeWorldExportJobInput) (req *request.Request, output *DescribeWorldExportJobOutput) { op := &request.Operation{ - Name: opListSimulationJobBatches, + Name: opDescribeWorldExportJob, HTTPMethod: "POST", - HTTPPath: "/listSimulationJobBatches", - Paginator: &request.Paginator{ - InputTokens: []string{"nextToken"}, - OutputTokens: []string{"nextToken"}, - LimitToken: "maxResults", - TruncationToken: "", - }, + HTTPPath: "/describeWorldExportJob", } if input == nil { - input = &ListSimulationJobBatchesInput{} + input = &DescribeWorldExportJobInput{} } - output = &ListSimulationJobBatchesOutput{} + output = &DescribeWorldExportJobOutput{} req = c.newRequest(op, input, output) return } -// ListSimulationJobBatches API operation for AWS RoboMaker. +// DescribeWorldExportJob API operation for AWS RoboMaker. // -// Returns a list simulation job batches. You can optionally provide filters -// to retrieve specific simulation batch jobs. +// Describes a world export job. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation ListSimulationJobBatches for usage and error information. +// API operation DescribeWorldExportJob for usage and error information. // // Returned Error Types: +// * ResourceNotFoundException +// The specified resource does not exist. +// // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. @@ -3042,141 +3046,89 @@ func (c *RoboMaker) ListSimulationJobBatchesRequest(input *ListSimulationJobBatc // * InternalServerException // AWS RoboMaker experienced a service issue. Try your call again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationJobBatches -func (c *RoboMaker) ListSimulationJobBatches(input *ListSimulationJobBatchesInput) (*ListSimulationJobBatchesOutput, error) { - req, out := c.ListSimulationJobBatchesRequest(input) +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeWorldExportJob +func (c *RoboMaker) DescribeWorldExportJob(input *DescribeWorldExportJobInput) (*DescribeWorldExportJobOutput, error) { + req, out := c.DescribeWorldExportJobRequest(input) return out, req.Send() } -// ListSimulationJobBatchesWithContext is the same as ListSimulationJobBatches with the addition of +// DescribeWorldExportJobWithContext is the same as DescribeWorldExportJob with the addition of // the ability to pass a context and additional request options. // -// See ListSimulationJobBatches for details on how to use this API operation. +// See DescribeWorldExportJob 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 *RoboMaker) ListSimulationJobBatchesWithContext(ctx aws.Context, input *ListSimulationJobBatchesInput, opts ...request.Option) (*ListSimulationJobBatchesOutput, error) { - req, out := c.ListSimulationJobBatchesRequest(input) +func (c *RoboMaker) DescribeWorldExportJobWithContext(ctx aws.Context, input *DescribeWorldExportJobInput, opts ...request.Option) (*DescribeWorldExportJobOutput, error) { + req, out := c.DescribeWorldExportJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListSimulationJobBatchesPages iterates over the pages of a ListSimulationJobBatches operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. -// -// See ListSimulationJobBatches 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 ListSimulationJobBatches operation. -// pageNum := 0 -// err := client.ListSimulationJobBatchesPages(params, -// func(page *robomaker.ListSimulationJobBatchesOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) -// -func (c *RoboMaker) ListSimulationJobBatchesPages(input *ListSimulationJobBatchesInput, fn func(*ListSimulationJobBatchesOutput, bool) bool) error { - return c.ListSimulationJobBatchesPagesWithContext(aws.BackgroundContext(), input, fn) -} - -// ListSimulationJobBatchesPagesWithContext same as ListSimulationJobBatchesPages 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 *RoboMaker) ListSimulationJobBatchesPagesWithContext(ctx aws.Context, input *ListSimulationJobBatchesInput, fn func(*ListSimulationJobBatchesOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *ListSimulationJobBatchesInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.ListSimulationJobBatchesRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*ListSimulationJobBatchesOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() -} - -const opListSimulationJobs = "ListSimulationJobs" +const opDescribeWorldGenerationJob = "DescribeWorldGenerationJob" -// ListSimulationJobsRequest generates a "aws/request.Request" representing the -// client's request for the ListSimulationJobs operation. The "output" return +// DescribeWorldGenerationJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWorldGenerationJob 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 ListSimulationJobs for more information on using the ListSimulationJobs +// See DescribeWorldGenerationJob for more information on using the DescribeWorldGenerationJob // 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 ListSimulationJobsRequest method. -// req, resp := client.ListSimulationJobsRequest(params) +// // Example sending a request using the DescribeWorldGenerationJobRequest method. +// req, resp := client.DescribeWorldGenerationJobRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationJobs -func (c *RoboMaker) ListSimulationJobsRequest(input *ListSimulationJobsInput) (req *request.Request, output *ListSimulationJobsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeWorldGenerationJob +func (c *RoboMaker) DescribeWorldGenerationJobRequest(input *DescribeWorldGenerationJobInput) (req *request.Request, output *DescribeWorldGenerationJobOutput) { op := &request.Operation{ - Name: opListSimulationJobs, + Name: opDescribeWorldGenerationJob, HTTPMethod: "POST", - HTTPPath: "/listSimulationJobs", - Paginator: &request.Paginator{ - InputTokens: []string{"nextToken"}, - OutputTokens: []string{"nextToken"}, - LimitToken: "maxResults", - TruncationToken: "", - }, + HTTPPath: "/describeWorldGenerationJob", } if input == nil { - input = &ListSimulationJobsInput{} + input = &DescribeWorldGenerationJobInput{} } - output = &ListSimulationJobsOutput{} + output = &DescribeWorldGenerationJobOutput{} req = c.newRequest(op, input, output) return } -// ListSimulationJobs API operation for AWS RoboMaker. +// DescribeWorldGenerationJob API operation for AWS RoboMaker. // -// Returns a list of simulation jobs. You can optionally provide filters to -// retrieve specific simulation jobs. +// Describes a world generation job. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation ListSimulationJobs for usage and error information. +// API operation DescribeWorldGenerationJob for usage and error information. // // Returned Error Types: +// * ResourceNotFoundException +// The specified resource does not exist. +// // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. @@ -3188,330 +3140,272 @@ func (c *RoboMaker) ListSimulationJobsRequest(input *ListSimulationJobsInput) (r // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationJobs -func (c *RoboMaker) ListSimulationJobs(input *ListSimulationJobsInput) (*ListSimulationJobsOutput, error) { - req, out := c.ListSimulationJobsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeWorldGenerationJob +func (c *RoboMaker) DescribeWorldGenerationJob(input *DescribeWorldGenerationJobInput) (*DescribeWorldGenerationJobOutput, error) { + req, out := c.DescribeWorldGenerationJobRequest(input) return out, req.Send() } -// ListSimulationJobsWithContext is the same as ListSimulationJobs with the addition of +// DescribeWorldGenerationJobWithContext is the same as DescribeWorldGenerationJob with the addition of // the ability to pass a context and additional request options. // -// See ListSimulationJobs for details on how to use this API operation. +// See DescribeWorldGenerationJob 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 *RoboMaker) ListSimulationJobsWithContext(ctx aws.Context, input *ListSimulationJobsInput, opts ...request.Option) (*ListSimulationJobsOutput, error) { - req, out := c.ListSimulationJobsRequest(input) +func (c *RoboMaker) DescribeWorldGenerationJobWithContext(ctx aws.Context, input *DescribeWorldGenerationJobInput, opts ...request.Option) (*DescribeWorldGenerationJobOutput, error) { + req, out := c.DescribeWorldGenerationJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListSimulationJobsPages iterates over the pages of a ListSimulationJobs operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. -// -// See ListSimulationJobs 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 ListSimulationJobs operation. -// pageNum := 0 -// err := client.ListSimulationJobsPages(params, -// func(page *robomaker.ListSimulationJobsOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) -// -func (c *RoboMaker) ListSimulationJobsPages(input *ListSimulationJobsInput, fn func(*ListSimulationJobsOutput, bool) bool) error { - return c.ListSimulationJobsPagesWithContext(aws.BackgroundContext(), input, fn) -} - -// ListSimulationJobsPagesWithContext same as ListSimulationJobsPages 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 *RoboMaker) ListSimulationJobsPagesWithContext(ctx aws.Context, input *ListSimulationJobsInput, fn func(*ListSimulationJobsOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *ListSimulationJobsInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.ListSimulationJobsRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*ListSimulationJobsOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() -} - -const opListTagsForResource = "ListTagsForResource" +const opDescribeWorldTemplate = "DescribeWorldTemplate" -// ListTagsForResourceRequest generates a "aws/request.Request" representing the -// client's request for the ListTagsForResource operation. The "output" return +// DescribeWorldTemplateRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWorldTemplate operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListTagsForResource for more information on using the ListTagsForResource +// See DescribeWorldTemplate for more information on using the DescribeWorldTemplate // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the ListTagsForResourceRequest method. -// req, resp := client.ListTagsForResourceRequest(params) +// // Example sending a request using the DescribeWorldTemplateRequest method. +// req, resp := client.DescribeWorldTemplateRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListTagsForResource -func (c *RoboMaker) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeWorldTemplate +func (c *RoboMaker) DescribeWorldTemplateRequest(input *DescribeWorldTemplateInput) (req *request.Request, output *DescribeWorldTemplateOutput) { op := &request.Operation{ - Name: opListTagsForResource, - HTTPMethod: "GET", - HTTPPath: "/tags/{resourceArn}", + Name: opDescribeWorldTemplate, + HTTPMethod: "POST", + HTTPPath: "/describeWorldTemplate", } if input == nil { - input = &ListTagsForResourceInput{} + input = &DescribeWorldTemplateInput{} } - output = &ListTagsForResourceOutput{} + output = &DescribeWorldTemplateOutput{} req = c.newRequest(op, input, output) return } -// ListTagsForResource API operation for AWS RoboMaker. +// DescribeWorldTemplate API operation for AWS RoboMaker. // -// Lists all tags on a AWS RoboMaker resource. +// Describes a world template. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation ListTagsForResource for usage and error information. +// API operation DescribeWorldTemplate for usage and error information. // // Returned Error Types: -// * InternalServerException -// AWS RoboMaker experienced a service issue. Try your call again. -// -// * ResourceNotFoundException -// The specified resource does not exist. -// // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // +// * ResourceNotFoundException +// The specified resource does not exist. +// // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListTagsForResource -func (c *RoboMaker) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { - req, out := c.ListTagsForResourceRequest(input) +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeWorldTemplate +func (c *RoboMaker) DescribeWorldTemplate(input *DescribeWorldTemplateInput) (*DescribeWorldTemplateOutput, error) { + req, out := c.DescribeWorldTemplateRequest(input) return out, req.Send() } -// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of +// DescribeWorldTemplateWithContext is the same as DescribeWorldTemplate with the addition of // the ability to pass a context and additional request options. // -// See ListTagsForResource for details on how to use this API operation. +// See DescribeWorldTemplate 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 *RoboMaker) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { - req, out := c.ListTagsForResourceRequest(input) +func (c *RoboMaker) DescribeWorldTemplateWithContext(ctx aws.Context, input *DescribeWorldTemplateInput, opts ...request.Option) (*DescribeWorldTemplateOutput, error) { + req, out := c.DescribeWorldTemplateRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opRegisterRobot = "RegisterRobot" +const opGetWorldTemplateBody = "GetWorldTemplateBody" -// RegisterRobotRequest generates a "aws/request.Request" representing the -// client's request for the RegisterRobot operation. The "output" return +// GetWorldTemplateBodyRequest generates a "aws/request.Request" representing the +// client's request for the GetWorldTemplateBody 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 RegisterRobot for more information on using the RegisterRobot +// See GetWorldTemplateBody for more information on using the GetWorldTemplateBody // 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 RegisterRobotRequest method. -// req, resp := client.RegisterRobotRequest(params) +// // Example sending a request using the GetWorldTemplateBodyRequest method. +// req, resp := client.GetWorldTemplateBodyRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RegisterRobot -func (c *RoboMaker) RegisterRobotRequest(input *RegisterRobotInput) (req *request.Request, output *RegisterRobotOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/GetWorldTemplateBody +func (c *RoboMaker) GetWorldTemplateBodyRequest(input *GetWorldTemplateBodyInput) (req *request.Request, output *GetWorldTemplateBodyOutput) { op := &request.Operation{ - Name: opRegisterRobot, + Name: opGetWorldTemplateBody, HTTPMethod: "POST", - HTTPPath: "/registerRobot", + HTTPPath: "/getWorldTemplateBody", } if input == nil { - input = &RegisterRobotInput{} + input = &GetWorldTemplateBodyInput{} } - output = &RegisterRobotOutput{} + output = &GetWorldTemplateBodyOutput{} req = c.newRequest(op, input, output) return } -// RegisterRobot API operation for AWS RoboMaker. +// GetWorldTemplateBody API operation for AWS RoboMaker. // -// Registers a robot with a fleet. +// Gets the world template body. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation RegisterRobot for usage and error information. +// API operation GetWorldTemplateBody for usage and error information. // // Returned Error Types: // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // -// * InternalServerException -// AWS RoboMaker experienced a service issue. Try your call again. +// * ResourceNotFoundException +// The specified resource does not exist. // // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// * LimitExceededException -// The requested resource exceeds the maximum number allowed, or the number -// of concurrent stream requests exceeds the maximum number allowed. -// -// * ResourceNotFoundException -// The specified resource does not exist. +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RegisterRobot -func (c *RoboMaker) RegisterRobot(input *RegisterRobotInput) (*RegisterRobotOutput, error) { - req, out := c.RegisterRobotRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/GetWorldTemplateBody +func (c *RoboMaker) GetWorldTemplateBody(input *GetWorldTemplateBodyInput) (*GetWorldTemplateBodyOutput, error) { + req, out := c.GetWorldTemplateBodyRequest(input) return out, req.Send() } -// RegisterRobotWithContext is the same as RegisterRobot with the addition of +// GetWorldTemplateBodyWithContext is the same as GetWorldTemplateBody with the addition of // the ability to pass a context and additional request options. // -// See RegisterRobot for details on how to use this API operation. +// See GetWorldTemplateBody 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 *RoboMaker) RegisterRobotWithContext(ctx aws.Context, input *RegisterRobotInput, opts ...request.Option) (*RegisterRobotOutput, error) { - req, out := c.RegisterRobotRequest(input) +func (c *RoboMaker) GetWorldTemplateBodyWithContext(ctx aws.Context, input *GetWorldTemplateBodyInput, opts ...request.Option) (*GetWorldTemplateBodyOutput, error) { + req, out := c.GetWorldTemplateBodyRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opRestartSimulationJob = "RestartSimulationJob" +const opListDeploymentJobs = "ListDeploymentJobs" -// RestartSimulationJobRequest generates a "aws/request.Request" representing the -// client's request for the RestartSimulationJob operation. The "output" return +// ListDeploymentJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListDeploymentJobs 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 RestartSimulationJob for more information on using the RestartSimulationJob +// See ListDeploymentJobs for more information on using the ListDeploymentJobs // 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 RestartSimulationJobRequest method. -// req, resp := client.RestartSimulationJobRequest(params) +// // Example sending a request using the ListDeploymentJobsRequest method. +// req, resp := client.ListDeploymentJobsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RestartSimulationJob -func (c *RoboMaker) RestartSimulationJobRequest(input *RestartSimulationJobInput) (req *request.Request, output *RestartSimulationJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListDeploymentJobs +func (c *RoboMaker) ListDeploymentJobsRequest(input *ListDeploymentJobsInput) (req *request.Request, output *ListDeploymentJobsOutput) { op := &request.Operation{ - Name: opRestartSimulationJob, + Name: opListDeploymentJobs, HTTPMethod: "POST", - HTTPPath: "/restartSimulationJob", - } + HTTPPath: "/listDeploymentJobs", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } if input == nil { - input = &RestartSimulationJobInput{} + input = &ListDeploymentJobsInput{} } - output = &RestartSimulationJobOutput{} + output = &ListDeploymentJobsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// RestartSimulationJob API operation for AWS RoboMaker. +// ListDeploymentJobs API operation for AWS RoboMaker. // -// Restarts a running simulation job. +// Returns a list of deployment jobs for a fleet. You can optionally provide +// filters to retrieve specific deployment jobs. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation RestartSimulationJob for usage and error information. +// API operation ListDeploymentJobs for usage and error information. // // Returned Error Types: // * ResourceNotFoundException // The specified resource does not exist. // -// * ThrottlingException -// AWS RoboMaker is temporarily unable to process the request. Try your call -// again. -// -// * LimitExceededException -// The requested resource exceeds the maximum number allowed, or the number -// of concurrent stream requests exceeds the maximum number allowed. -// // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. @@ -3519,293 +3413,440 @@ func (c *RoboMaker) RestartSimulationJobRequest(input *RestartSimulationJobInput // * InternalServerException // AWS RoboMaker experienced a service issue. Try your call again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RestartSimulationJob -func (c *RoboMaker) RestartSimulationJob(input *RestartSimulationJobInput) (*RestartSimulationJobOutput, error) { - req, out := c.RestartSimulationJobRequest(input) +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListDeploymentJobs +func (c *RoboMaker) ListDeploymentJobs(input *ListDeploymentJobsInput) (*ListDeploymentJobsOutput, error) { + req, out := c.ListDeploymentJobsRequest(input) return out, req.Send() } -// RestartSimulationJobWithContext is the same as RestartSimulationJob with the addition of +// ListDeploymentJobsWithContext is the same as ListDeploymentJobs with the addition of // the ability to pass a context and additional request options. // -// See RestartSimulationJob for details on how to use this API operation. +// See ListDeploymentJobs 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 *RoboMaker) RestartSimulationJobWithContext(ctx aws.Context, input *RestartSimulationJobInput, opts ...request.Option) (*RestartSimulationJobOutput, error) { - req, out := c.RestartSimulationJobRequest(input) +func (c *RoboMaker) ListDeploymentJobsWithContext(ctx aws.Context, input *ListDeploymentJobsInput, opts ...request.Option) (*ListDeploymentJobsOutput, error) { + req, out := c.ListDeploymentJobsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStartSimulationJobBatch = "StartSimulationJobBatch" +// ListDeploymentJobsPages iterates over the pages of a ListDeploymentJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListDeploymentJobs 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 ListDeploymentJobs operation. +// pageNum := 0 +// err := client.ListDeploymentJobsPages(params, +// func(page *robomaker.ListDeploymentJobsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RoboMaker) ListDeploymentJobsPages(input *ListDeploymentJobsInput, fn func(*ListDeploymentJobsOutput, bool) bool) error { + return c.ListDeploymentJobsPagesWithContext(aws.BackgroundContext(), input, fn) +} -// StartSimulationJobBatchRequest generates a "aws/request.Request" representing the -// client's request for the StartSimulationJobBatch operation. The "output" return +// ListDeploymentJobsPagesWithContext same as ListDeploymentJobsPages 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 *RoboMaker) ListDeploymentJobsPagesWithContext(ctx aws.Context, input *ListDeploymentJobsInput, fn func(*ListDeploymentJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListDeploymentJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListDeploymentJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListDeploymentJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListFleets = "ListFleets" + +// ListFleetsRequest generates a "aws/request.Request" representing the +// client's request for the ListFleets 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 StartSimulationJobBatch for more information on using the StartSimulationJobBatch +// See ListFleets for more information on using the ListFleets // 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 StartSimulationJobBatchRequest method. -// req, resp := client.StartSimulationJobBatchRequest(params) +// // Example sending a request using the ListFleetsRequest method. +// req, resp := client.ListFleetsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/StartSimulationJobBatch -func (c *RoboMaker) StartSimulationJobBatchRequest(input *StartSimulationJobBatchInput) (req *request.Request, output *StartSimulationJobBatchOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListFleets +func (c *RoboMaker) ListFleetsRequest(input *ListFleetsInput) (req *request.Request, output *ListFleetsOutput) { op := &request.Operation{ - Name: opStartSimulationJobBatch, + Name: opListFleets, HTTPMethod: "POST", - HTTPPath: "/startSimulationJobBatch", + HTTPPath: "/listFleets", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, } if input == nil { - input = &StartSimulationJobBatchInput{} + input = &ListFleetsInput{} } - output = &StartSimulationJobBatchOutput{} + output = &ListFleetsOutput{} req = c.newRequest(op, input, output) return } -// StartSimulationJobBatch API operation for AWS RoboMaker. +// ListFleets API operation for AWS RoboMaker. // -// Starts a new simulation job batch. The batch is defined using one or more -// SimulationJobRequest objects. +// Returns a list of fleets. You can optionally provide filters to retrieve +// specific fleets. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation StartSimulationJobBatch for usage and error information. +// API operation ListFleets for usage and error information. // // Returned Error Types: +// * ResourceNotFoundException +// The specified resource does not exist. +// // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // -// * LimitExceededException -// The requested resource exceeds the maximum number allowed, or the number -// of concurrent stream requests exceeds the maximum number allowed. +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. // // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// * IdempotentParameterMismatchException -// The request uses the same client token as a previous, but non-identical request. -// Do not reuse a client token with different requests, unless the requests -// are identical. -// -// * InternalServerException -// AWS RoboMaker experienced a service issue. Try your call again. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/StartSimulationJobBatch -func (c *RoboMaker) StartSimulationJobBatch(input *StartSimulationJobBatchInput) (*StartSimulationJobBatchOutput, error) { - req, out := c.StartSimulationJobBatchRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListFleets +func (c *RoboMaker) ListFleets(input *ListFleetsInput) (*ListFleetsOutput, error) { + req, out := c.ListFleetsRequest(input) return out, req.Send() } -// StartSimulationJobBatchWithContext is the same as StartSimulationJobBatch with the addition of +// ListFleetsWithContext is the same as ListFleets with the addition of // the ability to pass a context and additional request options. // -// See StartSimulationJobBatch for details on how to use this API operation. +// See ListFleets 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 *RoboMaker) StartSimulationJobBatchWithContext(ctx aws.Context, input *StartSimulationJobBatchInput, opts ...request.Option) (*StartSimulationJobBatchOutput, error) { - req, out := c.StartSimulationJobBatchRequest(input) +func (c *RoboMaker) ListFleetsWithContext(ctx aws.Context, input *ListFleetsInput, opts ...request.Option) (*ListFleetsOutput, error) { + req, out := c.ListFleetsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opSyncDeploymentJob = "SyncDeploymentJob" +// ListFleetsPages iterates over the pages of a ListFleets operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListFleets 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 ListFleets operation. +// pageNum := 0 +// err := client.ListFleetsPages(params, +// func(page *robomaker.ListFleetsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RoboMaker) ListFleetsPages(input *ListFleetsInput, fn func(*ListFleetsOutput, bool) bool) error { + return c.ListFleetsPagesWithContext(aws.BackgroundContext(), input, fn) +} -// SyncDeploymentJobRequest generates a "aws/request.Request" representing the -// client's request for the SyncDeploymentJob operation. The "output" return +// ListFleetsPagesWithContext same as ListFleetsPages 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 *RoboMaker) ListFleetsPagesWithContext(ctx aws.Context, input *ListFleetsInput, fn func(*ListFleetsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListFleetsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListFleetsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListFleetsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListRobotApplications = "ListRobotApplications" + +// ListRobotApplicationsRequest generates a "aws/request.Request" representing the +// client's request for the ListRobotApplications 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 SyncDeploymentJob for more information on using the SyncDeploymentJob +// See ListRobotApplications for more information on using the ListRobotApplications // 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 SyncDeploymentJobRequest method. -// req, resp := client.SyncDeploymentJobRequest(params) +// // Example sending a request using the ListRobotApplicationsRequest method. +// req, resp := client.ListRobotApplicationsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/SyncDeploymentJob -func (c *RoboMaker) SyncDeploymentJobRequest(input *SyncDeploymentJobInput) (req *request.Request, output *SyncDeploymentJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListRobotApplications +func (c *RoboMaker) ListRobotApplicationsRequest(input *ListRobotApplicationsInput) (req *request.Request, output *ListRobotApplicationsOutput) { op := &request.Operation{ - Name: opSyncDeploymentJob, + Name: opListRobotApplications, HTTPMethod: "POST", - HTTPPath: "/syncDeploymentJob", + HTTPPath: "/listRobotApplications", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, } if input == nil { - input = &SyncDeploymentJobInput{} + input = &ListRobotApplicationsInput{} } - output = &SyncDeploymentJobOutput{} + output = &ListRobotApplicationsOutput{} req = c.newRequest(op, input, output) return } -// SyncDeploymentJob API operation for AWS RoboMaker. +// ListRobotApplications API operation for AWS RoboMaker. // -// Syncrhonizes robots in a fleet to the latest deployment. This is helpful -// if robots were added after a deployment. +// Returns a list of robot application. You can optionally provide filters to +// retrieve specific robot applications. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation SyncDeploymentJob for usage and error information. +// API operation ListRobotApplications for usage and error information. // // Returned Error Types: -// * ResourceNotFoundException -// The specified resource does not exist. -// // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // -// * InternalServerException -// AWS RoboMaker experienced a service issue. Try your call again. -// // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// * LimitExceededException -// The requested resource exceeds the maximum number allowed, or the number -// of concurrent stream requests exceeds the maximum number allowed. -// -// * ConcurrentDeploymentException -// The failure percentage threshold percentage was met. -// -// * IdempotentParameterMismatchException -// The request uses the same client token as a previous, but non-identical request. -// Do not reuse a client token with different requests, unless the requests -// are identical. +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/SyncDeploymentJob -func (c *RoboMaker) SyncDeploymentJob(input *SyncDeploymentJobInput) (*SyncDeploymentJobOutput, error) { - req, out := c.SyncDeploymentJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListRobotApplications +func (c *RoboMaker) ListRobotApplications(input *ListRobotApplicationsInput) (*ListRobotApplicationsOutput, error) { + req, out := c.ListRobotApplicationsRequest(input) return out, req.Send() } -// SyncDeploymentJobWithContext is the same as SyncDeploymentJob with the addition of +// ListRobotApplicationsWithContext is the same as ListRobotApplications with the addition of // the ability to pass a context and additional request options. // -// See SyncDeploymentJob for details on how to use this API operation. +// See ListRobotApplications 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 *RoboMaker) SyncDeploymentJobWithContext(ctx aws.Context, input *SyncDeploymentJobInput, opts ...request.Option) (*SyncDeploymentJobOutput, error) { - req, out := c.SyncDeploymentJobRequest(input) +func (c *RoboMaker) ListRobotApplicationsWithContext(ctx aws.Context, input *ListRobotApplicationsInput, opts ...request.Option) (*ListRobotApplicationsOutput, error) { + req, out := c.ListRobotApplicationsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opTagResource = "TagResource" +// ListRobotApplicationsPages iterates over the pages of a ListRobotApplications operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListRobotApplications 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 ListRobotApplications operation. +// pageNum := 0 +// err := client.ListRobotApplicationsPages(params, +// func(page *robomaker.ListRobotApplicationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RoboMaker) ListRobotApplicationsPages(input *ListRobotApplicationsInput, fn func(*ListRobotApplicationsOutput, bool) bool) error { + return c.ListRobotApplicationsPagesWithContext(aws.BackgroundContext(), input, fn) +} -// TagResourceRequest generates a "aws/request.Request" representing the -// client's request for the TagResource operation. The "output" return +// ListRobotApplicationsPagesWithContext same as ListRobotApplicationsPages 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 *RoboMaker) ListRobotApplicationsPagesWithContext(ctx aws.Context, input *ListRobotApplicationsInput, fn func(*ListRobotApplicationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListRobotApplicationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListRobotApplicationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListRobotApplicationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListRobots = "ListRobots" + +// ListRobotsRequest generates a "aws/request.Request" representing the +// client's request for the ListRobots operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See TagResource for more information on using the TagResource +// See ListRobots for more information on using the ListRobots // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the TagResourceRequest method. -// req, resp := client.TagResourceRequest(params) +// // Example sending a request using the ListRobotsRequest method. +// req, resp := client.ListRobotsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/TagResource -func (c *RoboMaker) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListRobots +func (c *RoboMaker) ListRobotsRequest(input *ListRobotsInput) (req *request.Request, output *ListRobotsOutput) { op := &request.Operation{ - Name: opTagResource, + Name: opListRobots, HTTPMethod: "POST", - HTTPPath: "/tags/{resourceArn}", + HTTPPath: "/listRobots", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, } if input == nil { - input = &TagResourceInput{} + input = &ListRobotsInput{} } - output = &TagResourceOutput{} + output = &ListRobotsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// TagResource API operation for AWS RoboMaker. -// -// Adds or edits tags for a AWS RoboMaker resource. -// -// Each tag consists of a tag key and a tag value. Tag keys and tag values are -// both required, but tag values can be empty strings. +// ListRobots API operation for AWS RoboMaker. // -// For information about the rules that apply to tag keys and tag values, see -// User-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) -// in the AWS Billing and Cost Management User Guide. +// Returns a list of robots. You can optionally provide filters to retrieve +// specific robots. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation TagResource for usage and error information. +// API operation ListRobots for usage and error information. // // Returned Error Types: -// * InternalServerException -// AWS RoboMaker experienced a service issue. Try your call again. -// // * ResourceNotFoundException // The specified resource does not exist. // @@ -3813,96 +3854,148 @@ func (c *RoboMaker) TagResourceRequest(input *TagResourceInput) (req *request.Re // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/TagResource -func (c *RoboMaker) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { - req, out := c.TagResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListRobots +func (c *RoboMaker) ListRobots(input *ListRobotsInput) (*ListRobotsOutput, error) { + req, out := c.ListRobotsRequest(input) return out, req.Send() } -// TagResourceWithContext is the same as TagResource with the addition of +// ListRobotsWithContext is the same as ListRobots with the addition of // the ability to pass a context and additional request options. // -// See TagResource for details on how to use this API operation. +// See ListRobots 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 *RoboMaker) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { - req, out := c.TagResourceRequest(input) +func (c *RoboMaker) ListRobotsWithContext(ctx aws.Context, input *ListRobotsInput, opts ...request.Option) (*ListRobotsOutput, error) { + req, out := c.ListRobotsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUntagResource = "UntagResource" +// ListRobotsPages iterates over the pages of a ListRobots operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListRobots 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 ListRobots operation. +// pageNum := 0 +// err := client.ListRobotsPages(params, +// func(page *robomaker.ListRobotsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RoboMaker) ListRobotsPages(input *ListRobotsInput, fn func(*ListRobotsOutput, bool) bool) error { + return c.ListRobotsPagesWithContext(aws.BackgroundContext(), input, fn) +} -// UntagResourceRequest generates a "aws/request.Request" representing the -// client's request for the UntagResource operation. The "output" return +// ListRobotsPagesWithContext same as ListRobotsPages 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 *RoboMaker) ListRobotsPagesWithContext(ctx aws.Context, input *ListRobotsInput, fn func(*ListRobotsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListRobotsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListRobotsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListRobotsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListSimulationApplications = "ListSimulationApplications" + +// ListSimulationApplicationsRequest generates a "aws/request.Request" representing the +// client's request for the ListSimulationApplications operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UntagResource for more information on using the UntagResource +// See ListSimulationApplications for more information on using the ListSimulationApplications // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the UntagResourceRequest method. -// req, resp := client.UntagResourceRequest(params) +// // Example sending a request using the ListSimulationApplicationsRequest method. +// req, resp := client.ListSimulationApplicationsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UntagResource -func (c *RoboMaker) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationApplications +func (c *RoboMaker) ListSimulationApplicationsRequest(input *ListSimulationApplicationsInput) (req *request.Request, output *ListSimulationApplicationsOutput) { op := &request.Operation{ - Name: opUntagResource, - HTTPMethod: "DELETE", - HTTPPath: "/tags/{resourceArn}", + Name: opListSimulationApplications, + HTTPMethod: "POST", + HTTPPath: "/listSimulationApplications", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, } if input == nil { - input = &UntagResourceInput{} + input = &ListSimulationApplicationsInput{} } - output = &UntagResourceOutput{} + output = &ListSimulationApplicationsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UntagResource API operation for AWS RoboMaker. -// -// Removes the specified tags from the specified AWS RoboMaker resource. +// ListSimulationApplications API operation for AWS RoboMaker. // -// To remove a tag, specify the tag key. To change the tag value of an existing -// tag key, use TagResource (https://docs.aws.amazon.com/robomaker/latest/dg/API_TagResource.html). +// Returns a list of simulation applications. You can optionally provide filters +// to retrieve specific simulation applications. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation UntagResource for usage and error information. +// API operation ListSimulationApplications for usage and error information. // // Returned Error Types: -// * InternalServerException -// AWS RoboMaker experienced a service issue. Try your call again. -// -// * ResourceNotFoundException -// The specified resource does not exist. -// // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. @@ -3911,243 +4004,3046 @@ func (c *RoboMaker) UntagResourceRequest(input *UntagResourceInput) (req *reques // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UntagResource -func (c *RoboMaker) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { - req, out := c.UntagResourceRequest(input) - return out, req.Send() -} +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationApplications +func (c *RoboMaker) ListSimulationApplications(input *ListSimulationApplicationsInput) (*ListSimulationApplicationsOutput, error) { + req, out := c.ListSimulationApplicationsRequest(input) + return out, req.Send() +} -// UntagResourceWithContext is the same as UntagResource with the addition of +// ListSimulationApplicationsWithContext is the same as ListSimulationApplications with the addition of // the ability to pass a context and additional request options. // -// See UntagResource for details on how to use this API operation. +// See ListSimulationApplications 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 *RoboMaker) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { - req, out := c.UntagResourceRequest(input) +func (c *RoboMaker) ListSimulationApplicationsWithContext(ctx aws.Context, input *ListSimulationApplicationsInput, opts ...request.Option) (*ListSimulationApplicationsOutput, error) { + req, out := c.ListSimulationApplicationsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateRobotApplication = "UpdateRobotApplication" +// ListSimulationApplicationsPages iterates over the pages of a ListSimulationApplications operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListSimulationApplications 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 ListSimulationApplications operation. +// pageNum := 0 +// err := client.ListSimulationApplicationsPages(params, +// func(page *robomaker.ListSimulationApplicationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RoboMaker) ListSimulationApplicationsPages(input *ListSimulationApplicationsInput, fn func(*ListSimulationApplicationsOutput, bool) bool) error { + return c.ListSimulationApplicationsPagesWithContext(aws.BackgroundContext(), input, fn) +} -// UpdateRobotApplicationRequest generates a "aws/request.Request" representing the -// client's request for the UpdateRobotApplication operation. The "output" return +// ListSimulationApplicationsPagesWithContext same as ListSimulationApplicationsPages 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 *RoboMaker) ListSimulationApplicationsPagesWithContext(ctx aws.Context, input *ListSimulationApplicationsInput, fn func(*ListSimulationApplicationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListSimulationApplicationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListSimulationApplicationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListSimulationApplicationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListSimulationJobBatches = "ListSimulationJobBatches" + +// ListSimulationJobBatchesRequest generates a "aws/request.Request" representing the +// client's request for the ListSimulationJobBatches 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 UpdateRobotApplication for more information on using the UpdateRobotApplication +// See ListSimulationJobBatches for more information on using the ListSimulationJobBatches // 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 UpdateRobotApplicationRequest method. -// req, resp := client.UpdateRobotApplicationRequest(params) +// // Example sending a request using the ListSimulationJobBatchesRequest method. +// req, resp := client.ListSimulationJobBatchesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UpdateRobotApplication -func (c *RoboMaker) UpdateRobotApplicationRequest(input *UpdateRobotApplicationInput) (req *request.Request, output *UpdateRobotApplicationOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationJobBatches +func (c *RoboMaker) ListSimulationJobBatchesRequest(input *ListSimulationJobBatchesInput) (req *request.Request, output *ListSimulationJobBatchesOutput) { op := &request.Operation{ - Name: opUpdateRobotApplication, + Name: opListSimulationJobBatches, HTTPMethod: "POST", - HTTPPath: "/updateRobotApplication", + HTTPPath: "/listSimulationJobBatches", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, } if input == nil { - input = &UpdateRobotApplicationInput{} + input = &ListSimulationJobBatchesInput{} } - output = &UpdateRobotApplicationOutput{} + output = &ListSimulationJobBatchesOutput{} req = c.newRequest(op, input, output) return } -// UpdateRobotApplication API operation for AWS RoboMaker. +// ListSimulationJobBatches API operation for AWS RoboMaker. // -// Updates a robot application. +// Returns a list simulation job batches. You can optionally provide filters +// to retrieve specific simulation batch jobs. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation UpdateRobotApplication for usage and error information. +// API operation ListSimulationJobBatches for usage and error information. // // Returned Error Types: // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // -// * ResourceNotFoundException -// The specified resource does not exist. -// -// * LimitExceededException -// The requested resource exceeds the maximum number allowed, or the number -// of concurrent stream requests exceeds the maximum number allowed. -// -// * ThrottlingException -// AWS RoboMaker is temporarily unable to process the request. Try your call -// again. -// // * InternalServerException // AWS RoboMaker experienced a service issue. Try your call again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UpdateRobotApplication -func (c *RoboMaker) UpdateRobotApplication(input *UpdateRobotApplicationInput) (*UpdateRobotApplicationOutput, error) { - req, out := c.UpdateRobotApplicationRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationJobBatches +func (c *RoboMaker) ListSimulationJobBatches(input *ListSimulationJobBatchesInput) (*ListSimulationJobBatchesOutput, error) { + req, out := c.ListSimulationJobBatchesRequest(input) return out, req.Send() } -// UpdateRobotApplicationWithContext is the same as UpdateRobotApplication with the addition of +// ListSimulationJobBatchesWithContext is the same as ListSimulationJobBatches with the addition of // the ability to pass a context and additional request options. // -// See UpdateRobotApplication for details on how to use this API operation. +// See ListSimulationJobBatches 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 *RoboMaker) UpdateRobotApplicationWithContext(ctx aws.Context, input *UpdateRobotApplicationInput, opts ...request.Option) (*UpdateRobotApplicationOutput, error) { - req, out := c.UpdateRobotApplicationRequest(input) +func (c *RoboMaker) ListSimulationJobBatchesWithContext(ctx aws.Context, input *ListSimulationJobBatchesInput, opts ...request.Option) (*ListSimulationJobBatchesOutput, error) { + req, out := c.ListSimulationJobBatchesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateSimulationApplication = "UpdateSimulationApplication" +// ListSimulationJobBatchesPages iterates over the pages of a ListSimulationJobBatches operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListSimulationJobBatches 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 ListSimulationJobBatches operation. +// pageNum := 0 +// err := client.ListSimulationJobBatchesPages(params, +// func(page *robomaker.ListSimulationJobBatchesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RoboMaker) ListSimulationJobBatchesPages(input *ListSimulationJobBatchesInput, fn func(*ListSimulationJobBatchesOutput, bool) bool) error { + return c.ListSimulationJobBatchesPagesWithContext(aws.BackgroundContext(), input, fn) +} -// UpdateSimulationApplicationRequest generates a "aws/request.Request" representing the -// client's request for the UpdateSimulationApplication operation. The "output" return +// ListSimulationJobBatchesPagesWithContext same as ListSimulationJobBatchesPages 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 *RoboMaker) ListSimulationJobBatchesPagesWithContext(ctx aws.Context, input *ListSimulationJobBatchesInput, fn func(*ListSimulationJobBatchesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListSimulationJobBatchesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListSimulationJobBatchesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListSimulationJobBatchesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListSimulationJobs = "ListSimulationJobs" + +// ListSimulationJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListSimulationJobs 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 UpdateSimulationApplication for more information on using the UpdateSimulationApplication +// See ListSimulationJobs for more information on using the ListSimulationJobs // 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 UpdateSimulationApplicationRequest method. -// req, resp := client.UpdateSimulationApplicationRequest(params) +// // Example sending a request using the ListSimulationJobsRequest method. +// req, resp := client.ListSimulationJobsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UpdateSimulationApplication -func (c *RoboMaker) UpdateSimulationApplicationRequest(input *UpdateSimulationApplicationInput) (req *request.Request, output *UpdateSimulationApplicationOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationJobs +func (c *RoboMaker) ListSimulationJobsRequest(input *ListSimulationJobsInput) (req *request.Request, output *ListSimulationJobsOutput) { op := &request.Operation{ - Name: opUpdateSimulationApplication, + Name: opListSimulationJobs, HTTPMethod: "POST", - HTTPPath: "/updateSimulationApplication", + HTTPPath: "/listSimulationJobs", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, } if input == nil { - input = &UpdateSimulationApplicationInput{} + input = &ListSimulationJobsInput{} } - output = &UpdateSimulationApplicationOutput{} + output = &ListSimulationJobsOutput{} req = c.newRequest(op, input, output) return } -// UpdateSimulationApplication API operation for AWS RoboMaker. +// ListSimulationJobs API operation for AWS RoboMaker. // -// Updates a simulation application. +// Returns a list of simulation jobs. You can optionally provide filters to +// retrieve specific simulation jobs. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS RoboMaker's -// API operation UpdateSimulationApplication for usage and error information. +// API operation ListSimulationJobs for usage and error information. // // Returned Error Types: // * InvalidParameterException // A parameter specified in a request is not valid, is unsupported, or cannot // be used. The returned message provides an explanation of the error value. // -// * ResourceNotFoundException -// The specified resource does not exist. -// -// * LimitExceededException -// The requested resource exceeds the maximum number allowed, or the number -// of concurrent stream requests exceeds the maximum number allowed. +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. // // * ThrottlingException // AWS RoboMaker is temporarily unable to process the request. Try your call // again. // -// * InternalServerException -// AWS RoboMaker experienced a service issue. Try your call again. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UpdateSimulationApplication -func (c *RoboMaker) UpdateSimulationApplication(input *UpdateSimulationApplicationInput) (*UpdateSimulationApplicationOutput, error) { - req, out := c.UpdateSimulationApplicationRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationJobs +func (c *RoboMaker) ListSimulationJobs(input *ListSimulationJobsInput) (*ListSimulationJobsOutput, error) { + req, out := c.ListSimulationJobsRequest(input) return out, req.Send() } -// UpdateSimulationApplicationWithContext is the same as UpdateSimulationApplication with the addition of +// ListSimulationJobsWithContext is the same as ListSimulationJobs with the addition of // the ability to pass a context and additional request options. // -// See UpdateSimulationApplication for details on how to use this API operation. +// See ListSimulationJobs 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 *RoboMaker) UpdateSimulationApplicationWithContext(ctx aws.Context, input *UpdateSimulationApplicationInput, opts ...request.Option) (*UpdateSimulationApplicationOutput, error) { - req, out := c.UpdateSimulationApplicationRequest(input) +func (c *RoboMaker) ListSimulationJobsWithContext(ctx aws.Context, input *ListSimulationJobsInput, opts ...request.Option) (*ListSimulationJobsOutput, error) { + req, out := c.ListSimulationJobsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -type BatchDescribeSimulationJobInput struct { - _ struct{} `type:"structure"` - - // A list of Amazon Resource Names (ARNs) of simulation jobs to describe. - // - // Jobs is a required field - Jobs []*string `locationName:"jobs" min:"1" type:"list" required:"true"` -} - -// String returns the string representation -func (s BatchDescribeSimulationJobInput) String() string { - return awsutil.Prettify(s) +// ListSimulationJobsPages iterates over the pages of a ListSimulationJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListSimulationJobs 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 ListSimulationJobs operation. +// pageNum := 0 +// err := client.ListSimulationJobsPages(params, +// func(page *robomaker.ListSimulationJobsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RoboMaker) ListSimulationJobsPages(input *ListSimulationJobsInput, fn func(*ListSimulationJobsOutput, bool) bool) error { + return c.ListSimulationJobsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListSimulationJobsPagesWithContext same as ListSimulationJobsPages 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 *RoboMaker) ListSimulationJobsPagesWithContext(ctx aws.Context, input *ListSimulationJobsInput, fn func(*ListSimulationJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListSimulationJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListSimulationJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListSimulationJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListTagsForResource = "ListTagsForResource" + +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListTagsForResource for more information on using the ListTagsForResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListTagsForResource +func (c *RoboMaker) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { + op := &request.Operation{ + Name: opListTagsForResource, + HTTPMethod: "GET", + HTTPPath: "/tags/{resourceArn}", + } + + if input == nil { + input = &ListTagsForResourceInput{} + } + + output = &ListTagsForResourceOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListTagsForResource API operation for AWS RoboMaker. +// +// Lists all tags on a AWS RoboMaker resource. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation ListTagsForResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// * ResourceNotFoundException +// The specified resource does not exist. +// +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListTagsForResource +func (c *RoboMaker) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + return out, req.Send() +} + +// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of +// the ability to pass a context and additional request options. +// +// See ListTagsForResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *RoboMaker) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opListWorldExportJobs = "ListWorldExportJobs" + +// ListWorldExportJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListWorldExportJobs 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 ListWorldExportJobs for more information on using the ListWorldExportJobs +// 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 ListWorldExportJobsRequest method. +// req, resp := client.ListWorldExportJobsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListWorldExportJobs +func (c *RoboMaker) ListWorldExportJobsRequest(input *ListWorldExportJobsInput) (req *request.Request, output *ListWorldExportJobsOutput) { + op := &request.Operation{ + Name: opListWorldExportJobs, + HTTPMethod: "POST", + HTTPPath: "/listWorldExportJobs", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListWorldExportJobsInput{} + } + + output = &ListWorldExportJobsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListWorldExportJobs API operation for AWS RoboMaker. +// +// Lists world export jobs. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation ListWorldExportJobs for usage and error information. +// +// Returned Error Types: +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListWorldExportJobs +func (c *RoboMaker) ListWorldExportJobs(input *ListWorldExportJobsInput) (*ListWorldExportJobsOutput, error) { + req, out := c.ListWorldExportJobsRequest(input) + return out, req.Send() +} + +// ListWorldExportJobsWithContext is the same as ListWorldExportJobs with the addition of +// the ability to pass a context and additional request options. +// +// See ListWorldExportJobs 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 *RoboMaker) ListWorldExportJobsWithContext(ctx aws.Context, input *ListWorldExportJobsInput, opts ...request.Option) (*ListWorldExportJobsOutput, error) { + req, out := c.ListWorldExportJobsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListWorldExportJobsPages iterates over the pages of a ListWorldExportJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListWorldExportJobs 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 ListWorldExportJobs operation. +// pageNum := 0 +// err := client.ListWorldExportJobsPages(params, +// func(page *robomaker.ListWorldExportJobsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RoboMaker) ListWorldExportJobsPages(input *ListWorldExportJobsInput, fn func(*ListWorldExportJobsOutput, bool) bool) error { + return c.ListWorldExportJobsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListWorldExportJobsPagesWithContext same as ListWorldExportJobsPages 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 *RoboMaker) ListWorldExportJobsPagesWithContext(ctx aws.Context, input *ListWorldExportJobsInput, fn func(*ListWorldExportJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListWorldExportJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListWorldExportJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListWorldExportJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListWorldGenerationJobs = "ListWorldGenerationJobs" + +// ListWorldGenerationJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListWorldGenerationJobs 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 ListWorldGenerationJobs for more information on using the ListWorldGenerationJobs +// 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 ListWorldGenerationJobsRequest method. +// req, resp := client.ListWorldGenerationJobsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListWorldGenerationJobs +func (c *RoboMaker) ListWorldGenerationJobsRequest(input *ListWorldGenerationJobsInput) (req *request.Request, output *ListWorldGenerationJobsOutput) { + op := &request.Operation{ + Name: opListWorldGenerationJobs, + HTTPMethod: "POST", + HTTPPath: "/listWorldGenerationJobs", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListWorldGenerationJobsInput{} + } + + output = &ListWorldGenerationJobsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListWorldGenerationJobs API operation for AWS RoboMaker. +// +// Lists world generator jobs. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation ListWorldGenerationJobs for usage and error information. +// +// Returned Error Types: +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListWorldGenerationJobs +func (c *RoboMaker) ListWorldGenerationJobs(input *ListWorldGenerationJobsInput) (*ListWorldGenerationJobsOutput, error) { + req, out := c.ListWorldGenerationJobsRequest(input) + return out, req.Send() +} + +// ListWorldGenerationJobsWithContext is the same as ListWorldGenerationJobs with the addition of +// the ability to pass a context and additional request options. +// +// See ListWorldGenerationJobs 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 *RoboMaker) ListWorldGenerationJobsWithContext(ctx aws.Context, input *ListWorldGenerationJobsInput, opts ...request.Option) (*ListWorldGenerationJobsOutput, error) { + req, out := c.ListWorldGenerationJobsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListWorldGenerationJobsPages iterates over the pages of a ListWorldGenerationJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListWorldGenerationJobs 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 ListWorldGenerationJobs operation. +// pageNum := 0 +// err := client.ListWorldGenerationJobsPages(params, +// func(page *robomaker.ListWorldGenerationJobsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RoboMaker) ListWorldGenerationJobsPages(input *ListWorldGenerationJobsInput, fn func(*ListWorldGenerationJobsOutput, bool) bool) error { + return c.ListWorldGenerationJobsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListWorldGenerationJobsPagesWithContext same as ListWorldGenerationJobsPages 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 *RoboMaker) ListWorldGenerationJobsPagesWithContext(ctx aws.Context, input *ListWorldGenerationJobsInput, fn func(*ListWorldGenerationJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListWorldGenerationJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListWorldGenerationJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListWorldGenerationJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListWorldTemplates = "ListWorldTemplates" + +// ListWorldTemplatesRequest generates a "aws/request.Request" representing the +// client's request for the ListWorldTemplates 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 ListWorldTemplates for more information on using the ListWorldTemplates +// 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 ListWorldTemplatesRequest method. +// req, resp := client.ListWorldTemplatesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListWorldTemplates +func (c *RoboMaker) ListWorldTemplatesRequest(input *ListWorldTemplatesInput) (req *request.Request, output *ListWorldTemplatesOutput) { + op := &request.Operation{ + Name: opListWorldTemplates, + HTTPMethod: "POST", + HTTPPath: "/listWorldTemplates", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListWorldTemplatesInput{} + } + + output = &ListWorldTemplatesOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListWorldTemplates API operation for AWS RoboMaker. +// +// Lists world templates. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation ListWorldTemplates for usage and error information. +// +// Returned Error Types: +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListWorldTemplates +func (c *RoboMaker) ListWorldTemplates(input *ListWorldTemplatesInput) (*ListWorldTemplatesOutput, error) { + req, out := c.ListWorldTemplatesRequest(input) + return out, req.Send() +} + +// ListWorldTemplatesWithContext is the same as ListWorldTemplates with the addition of +// the ability to pass a context and additional request options. +// +// See ListWorldTemplates 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 *RoboMaker) ListWorldTemplatesWithContext(ctx aws.Context, input *ListWorldTemplatesInput, opts ...request.Option) (*ListWorldTemplatesOutput, error) { + req, out := c.ListWorldTemplatesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListWorldTemplatesPages iterates over the pages of a ListWorldTemplates operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListWorldTemplates 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 ListWorldTemplates operation. +// pageNum := 0 +// err := client.ListWorldTemplatesPages(params, +// func(page *robomaker.ListWorldTemplatesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RoboMaker) ListWorldTemplatesPages(input *ListWorldTemplatesInput, fn func(*ListWorldTemplatesOutput, bool) bool) error { + return c.ListWorldTemplatesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListWorldTemplatesPagesWithContext same as ListWorldTemplatesPages 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 *RoboMaker) ListWorldTemplatesPagesWithContext(ctx aws.Context, input *ListWorldTemplatesInput, fn func(*ListWorldTemplatesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListWorldTemplatesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListWorldTemplatesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListWorldTemplatesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListWorlds = "ListWorlds" + +// ListWorldsRequest generates a "aws/request.Request" representing the +// client's request for the ListWorlds 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 ListWorlds for more information on using the ListWorlds +// 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 ListWorldsRequest method. +// req, resp := client.ListWorldsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListWorlds +func (c *RoboMaker) ListWorldsRequest(input *ListWorldsInput) (req *request.Request, output *ListWorldsOutput) { + op := &request.Operation{ + Name: opListWorlds, + HTTPMethod: "POST", + HTTPPath: "/listWorlds", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListWorldsInput{} + } + + output = &ListWorldsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListWorlds API operation for AWS RoboMaker. +// +// Lists worlds. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation ListWorlds for usage and error information. +// +// Returned Error Types: +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListWorlds +func (c *RoboMaker) ListWorlds(input *ListWorldsInput) (*ListWorldsOutput, error) { + req, out := c.ListWorldsRequest(input) + return out, req.Send() +} + +// ListWorldsWithContext is the same as ListWorlds with the addition of +// the ability to pass a context and additional request options. +// +// See ListWorlds 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 *RoboMaker) ListWorldsWithContext(ctx aws.Context, input *ListWorldsInput, opts ...request.Option) (*ListWorldsOutput, error) { + req, out := c.ListWorldsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListWorldsPages iterates over the pages of a ListWorlds operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListWorlds 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 ListWorlds operation. +// pageNum := 0 +// err := client.ListWorldsPages(params, +// func(page *robomaker.ListWorldsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *RoboMaker) ListWorldsPages(input *ListWorldsInput, fn func(*ListWorldsOutput, bool) bool) error { + return c.ListWorldsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListWorldsPagesWithContext same as ListWorldsPages 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 *RoboMaker) ListWorldsPagesWithContext(ctx aws.Context, input *ListWorldsInput, fn func(*ListWorldsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListWorldsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListWorldsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListWorldsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opRegisterRobot = "RegisterRobot" + +// RegisterRobotRequest generates a "aws/request.Request" representing the +// client's request for the RegisterRobot 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 RegisterRobot for more information on using the RegisterRobot +// 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 RegisterRobotRequest method. +// req, resp := client.RegisterRobotRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RegisterRobot +func (c *RoboMaker) RegisterRobotRequest(input *RegisterRobotInput) (req *request.Request, output *RegisterRobotOutput) { + op := &request.Operation{ + Name: opRegisterRobot, + HTTPMethod: "POST", + HTTPPath: "/registerRobot", + } + + if input == nil { + input = &RegisterRobotInput{} + } + + output = &RegisterRobotOutput{} + req = c.newRequest(op, input, output) + return +} + +// RegisterRobot API operation for AWS RoboMaker. +// +// Registers a robot with a fleet. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation RegisterRobot for usage and error information. +// +// Returned Error Types: +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// * LimitExceededException +// The requested resource exceeds the maximum number allowed, or the number +// of concurrent stream requests exceeds the maximum number allowed. +// +// * ResourceNotFoundException +// The specified resource does not exist. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RegisterRobot +func (c *RoboMaker) RegisterRobot(input *RegisterRobotInput) (*RegisterRobotOutput, error) { + req, out := c.RegisterRobotRequest(input) + return out, req.Send() +} + +// RegisterRobotWithContext is the same as RegisterRobot with the addition of +// the ability to pass a context and additional request options. +// +// See RegisterRobot 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 *RoboMaker) RegisterRobotWithContext(ctx aws.Context, input *RegisterRobotInput, opts ...request.Option) (*RegisterRobotOutput, error) { + req, out := c.RegisterRobotRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opRestartSimulationJob = "RestartSimulationJob" + +// RestartSimulationJobRequest generates a "aws/request.Request" representing the +// client's request for the RestartSimulationJob 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 RestartSimulationJob for more information on using the RestartSimulationJob +// 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 RestartSimulationJobRequest method. +// req, resp := client.RestartSimulationJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RestartSimulationJob +func (c *RoboMaker) RestartSimulationJobRequest(input *RestartSimulationJobInput) (req *request.Request, output *RestartSimulationJobOutput) { + op := &request.Operation{ + Name: opRestartSimulationJob, + HTTPMethod: "POST", + HTTPPath: "/restartSimulationJob", + } + + if input == nil { + input = &RestartSimulationJobInput{} + } + + output = &RestartSimulationJobOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// RestartSimulationJob API operation for AWS RoboMaker. +// +// Restarts a running simulation job. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation RestartSimulationJob for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource does not exist. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// * LimitExceededException +// The requested resource exceeds the maximum number allowed, or the number +// of concurrent stream requests exceeds the maximum number allowed. +// +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RestartSimulationJob +func (c *RoboMaker) RestartSimulationJob(input *RestartSimulationJobInput) (*RestartSimulationJobOutput, error) { + req, out := c.RestartSimulationJobRequest(input) + return out, req.Send() +} + +// RestartSimulationJobWithContext is the same as RestartSimulationJob with the addition of +// the ability to pass a context and additional request options. +// +// See RestartSimulationJob 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 *RoboMaker) RestartSimulationJobWithContext(ctx aws.Context, input *RestartSimulationJobInput, opts ...request.Option) (*RestartSimulationJobOutput, error) { + req, out := c.RestartSimulationJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opStartSimulationJobBatch = "StartSimulationJobBatch" + +// StartSimulationJobBatchRequest generates a "aws/request.Request" representing the +// client's request for the StartSimulationJobBatch 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 StartSimulationJobBatch for more information on using the StartSimulationJobBatch +// 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 StartSimulationJobBatchRequest method. +// req, resp := client.StartSimulationJobBatchRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/StartSimulationJobBatch +func (c *RoboMaker) StartSimulationJobBatchRequest(input *StartSimulationJobBatchInput) (req *request.Request, output *StartSimulationJobBatchOutput) { + op := &request.Operation{ + Name: opStartSimulationJobBatch, + HTTPMethod: "POST", + HTTPPath: "/startSimulationJobBatch", + } + + if input == nil { + input = &StartSimulationJobBatchInput{} + } + + output = &StartSimulationJobBatchOutput{} + req = c.newRequest(op, input, output) + return +} + +// StartSimulationJobBatch API operation for AWS RoboMaker. +// +// Starts a new simulation job batch. The batch is defined using one or more +// SimulationJobRequest objects. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation StartSimulationJobBatch for usage and error information. +// +// Returned Error Types: +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * LimitExceededException +// The requested resource exceeds the maximum number allowed, or the number +// of concurrent stream requests exceeds the maximum number allowed. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// * IdempotentParameterMismatchException +// The request uses the same client token as a previous, but non-identical request. +// Do not reuse a client token with different requests, unless the requests +// are identical. +// +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/StartSimulationJobBatch +func (c *RoboMaker) StartSimulationJobBatch(input *StartSimulationJobBatchInput) (*StartSimulationJobBatchOutput, error) { + req, out := c.StartSimulationJobBatchRequest(input) + return out, req.Send() +} + +// StartSimulationJobBatchWithContext is the same as StartSimulationJobBatch with the addition of +// the ability to pass a context and additional request options. +// +// See StartSimulationJobBatch 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 *RoboMaker) StartSimulationJobBatchWithContext(ctx aws.Context, input *StartSimulationJobBatchInput, opts ...request.Option) (*StartSimulationJobBatchOutput, error) { + req, out := c.StartSimulationJobBatchRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opSyncDeploymentJob = "SyncDeploymentJob" + +// SyncDeploymentJobRequest generates a "aws/request.Request" representing the +// client's request for the SyncDeploymentJob 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 SyncDeploymentJob for more information on using the SyncDeploymentJob +// 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 SyncDeploymentJobRequest method. +// req, resp := client.SyncDeploymentJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/SyncDeploymentJob +func (c *RoboMaker) SyncDeploymentJobRequest(input *SyncDeploymentJobInput) (req *request.Request, output *SyncDeploymentJobOutput) { + op := &request.Operation{ + Name: opSyncDeploymentJob, + HTTPMethod: "POST", + HTTPPath: "/syncDeploymentJob", + } + + if input == nil { + input = &SyncDeploymentJobInput{} + } + + output = &SyncDeploymentJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// SyncDeploymentJob API operation for AWS RoboMaker. +// +// Syncrhonizes robots in a fleet to the latest deployment. This is helpful +// if robots were added after a deployment. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation SyncDeploymentJob for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource does not exist. +// +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// * LimitExceededException +// The requested resource exceeds the maximum number allowed, or the number +// of concurrent stream requests exceeds the maximum number allowed. +// +// * ConcurrentDeploymentException +// The failure percentage threshold percentage was met. +// +// * IdempotentParameterMismatchException +// The request uses the same client token as a previous, but non-identical request. +// Do not reuse a client token with different requests, unless the requests +// are identical. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/SyncDeploymentJob +func (c *RoboMaker) SyncDeploymentJob(input *SyncDeploymentJobInput) (*SyncDeploymentJobOutput, error) { + req, out := c.SyncDeploymentJobRequest(input) + return out, req.Send() +} + +// SyncDeploymentJobWithContext is the same as SyncDeploymentJob with the addition of +// the ability to pass a context and additional request options. +// +// See SyncDeploymentJob 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 *RoboMaker) SyncDeploymentJobWithContext(ctx aws.Context, input *SyncDeploymentJobInput, opts ...request.Option) (*SyncDeploymentJobOutput, error) { + req, out := c.SyncDeploymentJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opTagResource = "TagResource" + +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See TagResource for more information on using the TagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the TagResourceRequest method. +// req, resp := client.TagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/TagResource +func (c *RoboMaker) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { + op := &request.Operation{ + Name: opTagResource, + HTTPMethod: "POST", + HTTPPath: "/tags/{resourceArn}", + } + + if input == nil { + input = &TagResourceInput{} + } + + output = &TagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// TagResource API operation for AWS RoboMaker. +// +// Adds or edits tags for a AWS RoboMaker resource. +// +// Each tag consists of a tag key and a tag value. Tag keys and tag values are +// both required, but tag values can be empty strings. +// +// For information about the rules that apply to tag keys and tag values, see +// User-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) +// in the AWS Billing and Cost Management User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation TagResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// * ResourceNotFoundException +// The specified resource does not exist. +// +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/TagResource +func (c *RoboMaker) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + return out, req.Send() +} + +// TagResourceWithContext is the same as TagResource with the addition of +// the ability to pass a context and additional request options. +// +// See TagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *RoboMaker) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUntagResource = "UntagResource" + +// UntagResourceRequest generates a "aws/request.Request" representing the +// client's request for the UntagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UntagResource for more information on using the UntagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UntagResourceRequest method. +// req, resp := client.UntagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UntagResource +func (c *RoboMaker) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "DELETE", + HTTPPath: "/tags/{resourceArn}", + } + + if input == nil { + input = &UntagResourceInput{} + } + + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UntagResource API operation for AWS RoboMaker. +// +// Removes the specified tags from the specified AWS RoboMaker resource. +// +// To remove a tag, specify the tag key. To change the tag value of an existing +// tag key, use TagResource (https://docs.aws.amazon.com/robomaker/latest/dg/API_TagResource.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation UntagResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// * ResourceNotFoundException +// The specified resource does not exist. +// +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UntagResource +func (c *RoboMaker) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() +} + +// UntagResourceWithContext is the same as UntagResource with the addition of +// the ability to pass a context and additional request options. +// +// See UntagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *RoboMaker) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateRobotApplication = "UpdateRobotApplication" + +// UpdateRobotApplicationRequest generates a "aws/request.Request" representing the +// client's request for the UpdateRobotApplication 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 UpdateRobotApplication for more information on using the UpdateRobotApplication +// 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 UpdateRobotApplicationRequest method. +// req, resp := client.UpdateRobotApplicationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UpdateRobotApplication +func (c *RoboMaker) UpdateRobotApplicationRequest(input *UpdateRobotApplicationInput) (req *request.Request, output *UpdateRobotApplicationOutput) { + op := &request.Operation{ + Name: opUpdateRobotApplication, + HTTPMethod: "POST", + HTTPPath: "/updateRobotApplication", + } + + if input == nil { + input = &UpdateRobotApplicationInput{} + } + + output = &UpdateRobotApplicationOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateRobotApplication API operation for AWS RoboMaker. +// +// Updates a robot application. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation UpdateRobotApplication for usage and error information. +// +// Returned Error Types: +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * ResourceNotFoundException +// The specified resource does not exist. +// +// * LimitExceededException +// The requested resource exceeds the maximum number allowed, or the number +// of concurrent stream requests exceeds the maximum number allowed. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UpdateRobotApplication +func (c *RoboMaker) UpdateRobotApplication(input *UpdateRobotApplicationInput) (*UpdateRobotApplicationOutput, error) { + req, out := c.UpdateRobotApplicationRequest(input) + return out, req.Send() +} + +// UpdateRobotApplicationWithContext is the same as UpdateRobotApplication with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateRobotApplication 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 *RoboMaker) UpdateRobotApplicationWithContext(ctx aws.Context, input *UpdateRobotApplicationInput, opts ...request.Option) (*UpdateRobotApplicationOutput, error) { + req, out := c.UpdateRobotApplicationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateSimulationApplication = "UpdateSimulationApplication" + +// UpdateSimulationApplicationRequest generates a "aws/request.Request" representing the +// client's request for the UpdateSimulationApplication 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 UpdateSimulationApplication for more information on using the UpdateSimulationApplication +// 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 UpdateSimulationApplicationRequest method. +// req, resp := client.UpdateSimulationApplicationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UpdateSimulationApplication +func (c *RoboMaker) UpdateSimulationApplicationRequest(input *UpdateSimulationApplicationInput) (req *request.Request, output *UpdateSimulationApplicationOutput) { + op := &request.Operation{ + Name: opUpdateSimulationApplication, + HTTPMethod: "POST", + HTTPPath: "/updateSimulationApplication", + } + + if input == nil { + input = &UpdateSimulationApplicationInput{} + } + + output = &UpdateSimulationApplicationOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateSimulationApplication API operation for AWS RoboMaker. +// +// Updates a simulation application. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation UpdateSimulationApplication for usage and error information. +// +// Returned Error Types: +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * ResourceNotFoundException +// The specified resource does not exist. +// +// * LimitExceededException +// The requested resource exceeds the maximum number allowed, or the number +// of concurrent stream requests exceeds the maximum number allowed. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UpdateSimulationApplication +func (c *RoboMaker) UpdateSimulationApplication(input *UpdateSimulationApplicationInput) (*UpdateSimulationApplicationOutput, error) { + req, out := c.UpdateSimulationApplicationRequest(input) + return out, req.Send() +} + +// UpdateSimulationApplicationWithContext is the same as UpdateSimulationApplication with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateSimulationApplication 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 *RoboMaker) UpdateSimulationApplicationWithContext(ctx aws.Context, input *UpdateSimulationApplicationInput, opts ...request.Option) (*UpdateSimulationApplicationOutput, error) { + req, out := c.UpdateSimulationApplicationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateWorldTemplate = "UpdateWorldTemplate" + +// UpdateWorldTemplateRequest generates a "aws/request.Request" representing the +// client's request for the UpdateWorldTemplate 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 UpdateWorldTemplate for more information on using the UpdateWorldTemplate +// 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 UpdateWorldTemplateRequest method. +// req, resp := client.UpdateWorldTemplateRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UpdateWorldTemplate +func (c *RoboMaker) UpdateWorldTemplateRequest(input *UpdateWorldTemplateInput) (req *request.Request, output *UpdateWorldTemplateOutput) { + op := &request.Operation{ + Name: opUpdateWorldTemplate, + HTTPMethod: "POST", + HTTPPath: "/updateWorldTemplate", + } + + if input == nil { + input = &UpdateWorldTemplateInput{} + } + + output = &UpdateWorldTemplateOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateWorldTemplate API operation for AWS RoboMaker. +// +// Updates a world template. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS RoboMaker's +// API operation UpdateWorldTemplate for usage and error information. +// +// Returned Error Types: +// * InvalidParameterException +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +// +// * ResourceNotFoundException +// The specified resource does not exist. +// +// * ThrottlingException +// AWS RoboMaker is temporarily unable to process the request. Try your call +// again. +// +// * InternalServerException +// AWS RoboMaker experienced a service issue. Try your call again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UpdateWorldTemplate +func (c *RoboMaker) UpdateWorldTemplate(input *UpdateWorldTemplateInput) (*UpdateWorldTemplateOutput, error) { + req, out := c.UpdateWorldTemplateRequest(input) + return out, req.Send() +} + +// UpdateWorldTemplateWithContext is the same as UpdateWorldTemplate with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateWorldTemplate 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 *RoboMaker) UpdateWorldTemplateWithContext(ctx aws.Context, input *UpdateWorldTemplateInput, opts ...request.Option) (*UpdateWorldTemplateOutput, error) { + req, out := c.UpdateWorldTemplateRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +type BatchDeleteWorldsInput struct { + _ struct{} `type:"structure"` + + // A list of Amazon Resource Names (arns) that correspond to worlds to delete. + // + // Worlds is a required field + Worlds []*string `locationName:"worlds" min:"1" type:"list" required:"true"` +} + +// String returns the string representation +func (s BatchDeleteWorldsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchDeleteWorldsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchDeleteWorldsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchDeleteWorldsInput"} + if s.Worlds == nil { + invalidParams.Add(request.NewErrParamRequired("Worlds")) + } + if s.Worlds != nil && len(s.Worlds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Worlds", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetWorlds sets the Worlds field's value. +func (s *BatchDeleteWorldsInput) SetWorlds(v []*string) *BatchDeleteWorldsInput { + s.Worlds = v + return s +} + +type BatchDeleteWorldsOutput struct { + _ struct{} `type:"structure"` + + // A list of unprocessed worlds associated with the call. These worlds were + // not deleted. + UnprocessedWorlds []*string `locationName:"unprocessedWorlds" min:"1" type:"list"` +} + +// String returns the string representation +func (s BatchDeleteWorldsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchDeleteWorldsOutput) GoString() string { + return s.String() +} + +// SetUnprocessedWorlds sets the UnprocessedWorlds field's value. +func (s *BatchDeleteWorldsOutput) SetUnprocessedWorlds(v []*string) *BatchDeleteWorldsOutput { + s.UnprocessedWorlds = v + return s +} + +type BatchDescribeSimulationJobInput struct { + _ struct{} `type:"structure"` + + // A list of Amazon Resource Names (ARNs) of simulation jobs to describe. + // + // Jobs is a required field + Jobs []*string `locationName:"jobs" min:"1" type:"list" required:"true"` +} + +// String returns the string representation +func (s BatchDescribeSimulationJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchDescribeSimulationJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchDescribeSimulationJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchDescribeSimulationJobInput"} + if s.Jobs == nil { + invalidParams.Add(request.NewErrParamRequired("Jobs")) + } + if s.Jobs != nil && len(s.Jobs) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Jobs", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJobs sets the Jobs field's value. +func (s *BatchDescribeSimulationJobInput) SetJobs(v []*string) *BatchDescribeSimulationJobInput { + s.Jobs = v + return s +} + +type BatchDescribeSimulationJobOutput struct { + _ struct{} `type:"structure"` + + // A list of simulation jobs. + Jobs []*SimulationJob `locationName:"jobs" type:"list"` + + // A list of unprocessed simulation job Amazon Resource Names (ARNs). + UnprocessedJobs []*string `locationName:"unprocessedJobs" min:"1" type:"list"` +} + +// String returns the string representation +func (s BatchDescribeSimulationJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchDescribeSimulationJobOutput) GoString() string { + return s.String() +} + +// SetJobs sets the Jobs field's value. +func (s *BatchDescribeSimulationJobOutput) SetJobs(v []*SimulationJob) *BatchDescribeSimulationJobOutput { + s.Jobs = v + return s +} + +// SetUnprocessedJobs sets the UnprocessedJobs field's value. +func (s *BatchDescribeSimulationJobOutput) SetUnprocessedJobs(v []*string) *BatchDescribeSimulationJobOutput { + s.UnprocessedJobs = v + return s +} + +// Information about the batch policy. +type BatchPolicy struct { + _ struct{} `type:"structure"` + + // The number of active simulation jobs create as part of the batch that can + // be in an active state at the same time. + // + // Active states include: Pending,Preparing, Running, Restarting, RunningFailed + // and Terminating. All other states are terminal states. + MaxConcurrency *int64 `locationName:"maxConcurrency" type:"integer"` + + // The amount of time, in seconds, to wait for the batch to complete. + // + // If a batch times out, and there are pending requests that were failing due + // to an internal failure (like InternalServiceError), they will be moved to + // the failed list and the batch status will be Failed. If the pending requests + // were failing for any other reason, the failed pending requests will be moved + // to the failed list and the batch status will be TimedOut. + TimeoutInSeconds *int64 `locationName:"timeoutInSeconds" type:"long"` +} + +// String returns the string representation +func (s BatchPolicy) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchPolicy) GoString() string { + return s.String() +} + +// SetMaxConcurrency sets the MaxConcurrency field's value. +func (s *BatchPolicy) SetMaxConcurrency(v int64) *BatchPolicy { + s.MaxConcurrency = &v + return s +} + +// SetTimeoutInSeconds sets the TimeoutInSeconds field's value. +func (s *BatchPolicy) SetTimeoutInSeconds(v int64) *BatchPolicy { + s.TimeoutInSeconds = &v + return s +} + +type CancelDeploymentJobInput struct { + _ struct{} `type:"structure"` + + // The deployment job ARN to cancel. + // + // Job is a required field + Job *string `locationName:"job" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s CancelDeploymentJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CancelDeploymentJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CancelDeploymentJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CancelDeploymentJobInput"} + if s.Job == nil { + invalidParams.Add(request.NewErrParamRequired("Job")) + } + if s.Job != nil && len(*s.Job) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Job", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJob sets the Job field's value. +func (s *CancelDeploymentJobInput) SetJob(v string) *CancelDeploymentJobInput { + s.Job = &v + return s +} + +type CancelDeploymentJobOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s CancelDeploymentJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CancelDeploymentJobOutput) GoString() string { + return s.String() +} + +type CancelSimulationJobBatchInput struct { + _ struct{} `type:"structure"` + + // The id of the batch to cancel. + // + // Batch is a required field + Batch *string `locationName:"batch" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s CancelSimulationJobBatchInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CancelSimulationJobBatchInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CancelSimulationJobBatchInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CancelSimulationJobBatchInput"} + if s.Batch == nil { + invalidParams.Add(request.NewErrParamRequired("Batch")) + } + if s.Batch != nil && len(*s.Batch) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Batch", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBatch sets the Batch field's value. +func (s *CancelSimulationJobBatchInput) SetBatch(v string) *CancelSimulationJobBatchInput { + s.Batch = &v + return s +} + +type CancelSimulationJobBatchOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s CancelSimulationJobBatchOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CancelSimulationJobBatchOutput) GoString() string { + return s.String() +} + +type CancelSimulationJobInput struct { + _ struct{} `type:"structure"` + + // The simulation job ARN to cancel. + // + // Job is a required field + Job *string `locationName:"job" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s CancelSimulationJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CancelSimulationJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CancelSimulationJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CancelSimulationJobInput"} + if s.Job == nil { + invalidParams.Add(request.NewErrParamRequired("Job")) + } + if s.Job != nil && len(*s.Job) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Job", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJob sets the Job field's value. +func (s *CancelSimulationJobInput) SetJob(v string) *CancelSimulationJobInput { + s.Job = &v + return s +} + +type CancelSimulationJobOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s CancelSimulationJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CancelSimulationJobOutput) GoString() string { + return s.String() +} + +type CancelWorldExportJobInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (arn) of the world export job to cancel. + // + // Job is a required field + Job *string `locationName:"job" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s CancelWorldExportJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CancelWorldExportJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CancelWorldExportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CancelWorldExportJobInput"} + if s.Job == nil { + invalidParams.Add(request.NewErrParamRequired("Job")) + } + if s.Job != nil && len(*s.Job) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Job", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJob sets the Job field's value. +func (s *CancelWorldExportJobInput) SetJob(v string) *CancelWorldExportJobInput { + s.Job = &v + return s +} + +type CancelWorldExportJobOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s CancelWorldExportJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CancelWorldExportJobOutput) GoString() string { + return s.String() +} + +type CancelWorldGenerationJobInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (arn) of the world generator job to cancel. + // + // Job is a required field + Job *string `locationName:"job" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s CancelWorldGenerationJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CancelWorldGenerationJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CancelWorldGenerationJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CancelWorldGenerationJobInput"} + if s.Job == nil { + invalidParams.Add(request.NewErrParamRequired("Job")) + } + if s.Job != nil && len(*s.Job) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Job", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJob sets the Job field's value. +func (s *CancelWorldGenerationJobInput) SetJob(v string) *CancelWorldGenerationJobInput { + s.Job = &v + return s +} + +type CancelWorldGenerationJobOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s CancelWorldGenerationJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CancelWorldGenerationJobOutput) GoString() string { + return s.String() +} + +// Compute information for the simulation job. +type Compute struct { + _ struct{} `type:"structure"` + + // The simulation unit limit. Your simulation is allocated CPU and memory proportional + // to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB + // of memory. You are only billed for the SU utilization you consume up to the + // maximim value provided. The default is 15. + SimulationUnitLimit *int64 `locationName:"simulationUnitLimit" min:"1" type:"integer"` +} + +// String returns the string representation +func (s Compute) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Compute) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Compute) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Compute"} + if s.SimulationUnitLimit != nil && *s.SimulationUnitLimit < 1 { + invalidParams.Add(request.NewErrParamMinValue("SimulationUnitLimit", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetSimulationUnitLimit sets the SimulationUnitLimit field's value. +func (s *Compute) SetSimulationUnitLimit(v int64) *Compute { + s.SimulationUnitLimit = &v + return s +} + +// Compute information for the simulation job +type ComputeResponse struct { + _ struct{} `type:"structure"` + + // The simulation unit limit. Your simulation is allocated CPU and memory proportional + // to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB + // of memory. You are only billed for the SU utilization you consume up to the + // maximim value provided. The default is 15. + SimulationUnitLimit *int64 `locationName:"simulationUnitLimit" min:"1" type:"integer"` +} + +// String returns the string representation +func (s ComputeResponse) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ComputeResponse) GoString() string { + return s.String() +} + +// SetSimulationUnitLimit sets the SimulationUnitLimit field's value. +func (s *ComputeResponse) SetSimulationUnitLimit(v int64) *ComputeResponse { + s.SimulationUnitLimit = &v + return s +} + +// The failure percentage threshold percentage was met. +type ConcurrentDeploymentException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation +func (s ConcurrentDeploymentException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ConcurrentDeploymentException) GoString() string { + return s.String() +} + +func newErrorConcurrentDeploymentException(v protocol.ResponseMetadata) error { + return &ConcurrentDeploymentException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ConcurrentDeploymentException) Code() string { + return "ConcurrentDeploymentException" +} + +// Message returns the exception's message. +func (s *ConcurrentDeploymentException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ConcurrentDeploymentException) OrigErr() error { + return nil +} + +func (s *ConcurrentDeploymentException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ConcurrentDeploymentException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ConcurrentDeploymentException) RequestID() string { + return s.RespMetadata.RequestID +} + +type CreateDeploymentJobInput struct { + _ struct{} `type:"structure"` + + // Unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string" idempotencyToken:"true"` + + // The deployment application configuration. + // + // DeploymentApplicationConfigs is a required field + DeploymentApplicationConfigs []*DeploymentApplicationConfig `locationName:"deploymentApplicationConfigs" min:"1" type:"list" required:"true"` + + // The requested deployment configuration. + DeploymentConfig *DeploymentConfig `locationName:"deploymentConfig" type:"structure"` + + // The Amazon Resource Name (ARN) of the fleet to deploy. + // + // Fleet is a required field + Fleet *string `locationName:"fleet" min:"1" type:"string" required:"true"` + + // A map that contains tag keys and tag values that are attached to the deployment + // job. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s CreateDeploymentJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateDeploymentJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateDeploymentJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateDeploymentJobInput"} + if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) + } + if s.DeploymentApplicationConfigs == nil { + invalidParams.Add(request.NewErrParamRequired("DeploymentApplicationConfigs")) + } + if s.DeploymentApplicationConfigs != nil && len(s.DeploymentApplicationConfigs) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DeploymentApplicationConfigs", 1)) + } + if s.Fleet == nil { + invalidParams.Add(request.NewErrParamRequired("Fleet")) + } + if s.Fleet != nil && len(*s.Fleet) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Fleet", 1)) + } + if s.DeploymentApplicationConfigs != nil { + for i, v := range s.DeploymentApplicationConfigs { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "DeploymentApplicationConfigs", i), err.(request.ErrInvalidParams)) + } + } + } + if s.DeploymentConfig != nil { + if err := s.DeploymentConfig.Validate(); err != nil { + invalidParams.AddNested("DeploymentConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *CreateDeploymentJobInput) SetClientRequestToken(v string) *CreateDeploymentJobInput { + s.ClientRequestToken = &v + return s +} + +// SetDeploymentApplicationConfigs sets the DeploymentApplicationConfigs field's value. +func (s *CreateDeploymentJobInput) SetDeploymentApplicationConfigs(v []*DeploymentApplicationConfig) *CreateDeploymentJobInput { + s.DeploymentApplicationConfigs = v + return s +} + +// SetDeploymentConfig sets the DeploymentConfig field's value. +func (s *CreateDeploymentJobInput) SetDeploymentConfig(v *DeploymentConfig) *CreateDeploymentJobInput { + s.DeploymentConfig = v + return s +} + +// SetFleet sets the Fleet field's value. +func (s *CreateDeploymentJobInput) SetFleet(v string) *CreateDeploymentJobInput { + s.Fleet = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateDeploymentJobInput) SetTags(v map[string]*string) *CreateDeploymentJobInput { + s.Tags = v + return s +} + +type CreateDeploymentJobOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the deployment job. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // The time, in milliseconds since the epoch, when the fleet was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + + // The deployment application configuration. + DeploymentApplicationConfigs []*DeploymentApplicationConfig `locationName:"deploymentApplicationConfigs" min:"1" type:"list"` + + // The deployment configuration. + DeploymentConfig *DeploymentConfig `locationName:"deploymentConfig" type:"structure"` + + // The failure code of the simulation job if it failed: + // + // BadPermissionError + // + // AWS Greengrass requires a service-level role permission to access other services. + // The role must include the AWSGreengrassResourceAccessRolePolicy managed policy + // (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy$jsonEditor). + // + // ExtractingBundleFailure + // + // The robot application could not be extracted from the bundle. + // + // FailureThresholdBreached + // + // The percentage of robots that could not be updated exceeded the percentage + // set for the deployment. + // + // GreengrassDeploymentFailed + // + // The robot application could not be deployed to the robot. + // + // GreengrassGroupVersionDoesNotExist + // + // The AWS Greengrass group or version associated with a robot is missing. + // + // InternalServerError + // + // An internal error has occurred. Retry your request, but if the problem persists, + // contact us with details. + // + // MissingRobotApplicationArchitecture + // + // The robot application does not have a source that matches the architecture + // of the robot. + // + // MissingRobotDeploymentResource + // + // One or more of the resources specified for the robot application are missing. + // For example, does the robot application have the correct launch package and + // launch file? + // + // PostLaunchFileFailure + // + // The post-launch script failed. + // + // PreLaunchFileFailure + // + // The pre-launch script failed. + // + // ResourceNotFound + // + // One or more deployment resources are missing. For example, do robot application + // source bundles still exist? + // + // RobotDeploymentNoResponse + // + // There is no response from the robot. It might not be powered on or connected + // to the internet. + FailureCode *string `locationName:"failureCode" type:"string" enum:"DeploymentJobErrorCode"` + + // The failure reason of the deployment job if it failed. + FailureReason *string `locationName:"failureReason" type:"string"` + + // The target fleet for the deployment job. + Fleet *string `locationName:"fleet" min:"1" type:"string"` + + // The status of the deployment job. + Status *string `locationName:"status" type:"string" enum:"DeploymentStatus"` + + // The list of all tags added to the deployment job. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s CreateDeploymentJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateDeploymentJobOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *CreateDeploymentJobOutput) SetArn(v string) *CreateDeploymentJobOutput { + s.Arn = &v + return s +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *CreateDeploymentJobOutput) SetCreatedAt(v time.Time) *CreateDeploymentJobOutput { + s.CreatedAt = &v + return s +} + +// SetDeploymentApplicationConfigs sets the DeploymentApplicationConfigs field's value. +func (s *CreateDeploymentJobOutput) SetDeploymentApplicationConfigs(v []*DeploymentApplicationConfig) *CreateDeploymentJobOutput { + s.DeploymentApplicationConfigs = v + return s +} + +// SetDeploymentConfig sets the DeploymentConfig field's value. +func (s *CreateDeploymentJobOutput) SetDeploymentConfig(v *DeploymentConfig) *CreateDeploymentJobOutput { + s.DeploymentConfig = v + return s +} + +// SetFailureCode sets the FailureCode field's value. +func (s *CreateDeploymentJobOutput) SetFailureCode(v string) *CreateDeploymentJobOutput { + s.FailureCode = &v + return s +} + +// SetFailureReason sets the FailureReason field's value. +func (s *CreateDeploymentJobOutput) SetFailureReason(v string) *CreateDeploymentJobOutput { + s.FailureReason = &v + return s +} + +// SetFleet sets the Fleet field's value. +func (s *CreateDeploymentJobOutput) SetFleet(v string) *CreateDeploymentJobOutput { + s.Fleet = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *CreateDeploymentJobOutput) SetStatus(v string) *CreateDeploymentJobOutput { + s.Status = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateDeploymentJobOutput) SetTags(v map[string]*string) *CreateDeploymentJobOutput { + s.Tags = v + return s +} + +type CreateFleetInput struct { + _ struct{} `type:"structure"` + + // The name of the fleet. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // A map that contains tag keys and tag values that are attached to the fleet. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s CreateFleetInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateFleetInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateFleetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateFleetInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *CreateFleetInput) SetName(v string) *CreateFleetInput { + s.Name = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateFleetInput) SetTags(v map[string]*string) *CreateFleetInput { + s.Tags = v + return s +} + +type CreateFleetOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the fleet. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // The time, in milliseconds since the epoch, when the fleet was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + + // The name of the fleet. + Name *string `locationName:"name" min:"1" type:"string"` + + // The list of all tags added to the fleet. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s CreateFleetOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateFleetOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *CreateFleetOutput) SetArn(v string) *CreateFleetOutput { + s.Arn = &v + return s +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *CreateFleetOutput) SetCreatedAt(v time.Time) *CreateFleetOutput { + s.CreatedAt = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateFleetOutput) SetName(v string) *CreateFleetOutput { + s.Name = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateFleetOutput) SetTags(v map[string]*string) *CreateFleetOutput { + s.Tags = v + return s +} + +type CreateRobotApplicationInput struct { + _ struct{} `type:"structure"` + + // The name of the robot application. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // The robot software suite (ROS distribuition) used by the robot application. + // + // RobotSoftwareSuite is a required field + RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure" required:"true"` + + // The sources of the robot application. + // + // Sources is a required field + Sources []*SourceConfig `locationName:"sources" type:"list" required:"true"` + + // A map that contains tag keys and tag values that are attached to the robot + // application. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s CreateRobotApplicationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateRobotApplicationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateRobotApplicationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateRobotApplicationInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.RobotSoftwareSuite == nil { + invalidParams.Add(request.NewErrParamRequired("RobotSoftwareSuite")) + } + if s.Sources == nil { + invalidParams.Add(request.NewErrParamRequired("Sources")) + } + if s.Sources != nil { + for i, v := range s.Sources { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Sources", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *CreateRobotApplicationInput) SetName(v string) *CreateRobotApplicationInput { + s.Name = &v + return s +} + +// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. +func (s *CreateRobotApplicationInput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *CreateRobotApplicationInput { + s.RobotSoftwareSuite = v + return s +} + +// SetSources sets the Sources field's value. +func (s *CreateRobotApplicationInput) SetSources(v []*SourceConfig) *CreateRobotApplicationInput { + s.Sources = v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateRobotApplicationInput) SetTags(v map[string]*string) *CreateRobotApplicationInput { + s.Tags = v + return s +} + +type CreateRobotApplicationOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the robot application. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // The time, in milliseconds since the epoch, when the robot application was + // last updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` + + // The name of the robot application. + Name *string `locationName:"name" min:"1" type:"string"` + + // The revision id of the robot application. + RevisionId *string `locationName:"revisionId" min:"1" type:"string"` + + // The robot software suite (ROS distribution) used by the robot application. + RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` + + // The sources of the robot application. + Sources []*Source `locationName:"sources" type:"list"` + + // The list of all tags added to the robot application. + Tags map[string]*string `locationName:"tags" type:"map"` + + // The version of the robot application. + Version *string `locationName:"version" min:"1" type:"string"` +} + +// String returns the string representation +func (s CreateRobotApplicationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateRobotApplicationOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *CreateRobotApplicationOutput) SetArn(v string) *CreateRobotApplicationOutput { + s.Arn = &v + return s +} + +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *CreateRobotApplicationOutput) SetLastUpdatedAt(v time.Time) *CreateRobotApplicationOutput { + s.LastUpdatedAt = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateRobotApplicationOutput) SetName(v string) *CreateRobotApplicationOutput { + s.Name = &v + return s +} + +// SetRevisionId sets the RevisionId field's value. +func (s *CreateRobotApplicationOutput) SetRevisionId(v string) *CreateRobotApplicationOutput { + s.RevisionId = &v + return s +} + +// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. +func (s *CreateRobotApplicationOutput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *CreateRobotApplicationOutput { + s.RobotSoftwareSuite = v + return s +} + +// SetSources sets the Sources field's value. +func (s *CreateRobotApplicationOutput) SetSources(v []*Source) *CreateRobotApplicationOutput { + s.Sources = v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateRobotApplicationOutput) SetTags(v map[string]*string) *CreateRobotApplicationOutput { + s.Tags = v + return s +} + +// SetVersion sets the Version field's value. +func (s *CreateRobotApplicationOutput) SetVersion(v string) *CreateRobotApplicationOutput { + s.Version = &v + return s +} + +type CreateRobotApplicationVersionInput struct { + _ struct{} `type:"structure"` + + // The application information for the robot application. + // + // Application is a required field + Application *string `locationName:"application" min:"1" type:"string" required:"true"` + + // The current revision id for the robot application. If you provide a value + // and it matches the latest revision ID, a new version will be created. + CurrentRevisionId *string `locationName:"currentRevisionId" min:"1" type:"string"` +} + +// String returns the string representation +func (s CreateRobotApplicationVersionInput) String() string { + return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchDescribeSimulationJobInput) GoString() string { +func (s CreateRobotApplicationVersionInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *BatchDescribeSimulationJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "BatchDescribeSimulationJobInput"} - if s.Jobs == nil { - invalidParams.Add(request.NewErrParamRequired("Jobs")) +func (s *CreateRobotApplicationVersionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateRobotApplicationVersionInput"} + if s.Application == nil { + invalidParams.Add(request.NewErrParamRequired("Application")) } - if s.Jobs != nil && len(s.Jobs) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Jobs", 1)) + if s.Application != nil && len(*s.Application) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Application", 1)) + } + if s.CurrentRevisionId != nil && len(*s.CurrentRevisionId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CurrentRevisionId", 1)) } if invalidParams.Len() > 0 { @@ -4156,114 +7052,319 @@ func (s *BatchDescribeSimulationJobInput) Validate() error { return nil } -// SetJobs sets the Jobs field's value. -func (s *BatchDescribeSimulationJobInput) SetJobs(v []*string) *BatchDescribeSimulationJobInput { - s.Jobs = v +// SetApplication sets the Application field's value. +func (s *CreateRobotApplicationVersionInput) SetApplication(v string) *CreateRobotApplicationVersionInput { + s.Application = &v return s } -type BatchDescribeSimulationJobOutput struct { +// SetCurrentRevisionId sets the CurrentRevisionId field's value. +func (s *CreateRobotApplicationVersionInput) SetCurrentRevisionId(v string) *CreateRobotApplicationVersionInput { + s.CurrentRevisionId = &v + return s +} + +type CreateRobotApplicationVersionOutput struct { _ struct{} `type:"structure"` - // A list of simulation jobs. - Jobs []*SimulationJob `locationName:"jobs" type:"list"` + // The Amazon Resource Name (ARN) of the robot application. + Arn *string `locationName:"arn" min:"1" type:"string"` - // A list of unprocessed simulation job Amazon Resource Names (ARNs). - UnprocessedJobs []*string `locationName:"unprocessedJobs" min:"1" type:"list"` + // The time, in milliseconds since the epoch, when the robot application was + // last updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` + + // The name of the robot application. + Name *string `locationName:"name" min:"1" type:"string"` + + // The revision id of the robot application. + RevisionId *string `locationName:"revisionId" min:"1" type:"string"` + + // The robot software suite (ROS distribution) used by the robot application. + RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` + + // The sources of the robot application. + Sources []*Source `locationName:"sources" type:"list"` + + // The version of the robot application. + Version *string `locationName:"version" min:"1" type:"string"` } // String returns the string representation -func (s BatchDescribeSimulationJobOutput) String() string { +func (s CreateRobotApplicationVersionOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchDescribeSimulationJobOutput) GoString() string { +func (s CreateRobotApplicationVersionOutput) GoString() string { return s.String() } -// SetJobs sets the Jobs field's value. -func (s *BatchDescribeSimulationJobOutput) SetJobs(v []*SimulationJob) *BatchDescribeSimulationJobOutput { - s.Jobs = v +// SetArn sets the Arn field's value. +func (s *CreateRobotApplicationVersionOutput) SetArn(v string) *CreateRobotApplicationVersionOutput { + s.Arn = &v return s } -// SetUnprocessedJobs sets the UnprocessedJobs field's value. -func (s *BatchDescribeSimulationJobOutput) SetUnprocessedJobs(v []*string) *BatchDescribeSimulationJobOutput { - s.UnprocessedJobs = v +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *CreateRobotApplicationVersionOutput) SetLastUpdatedAt(v time.Time) *CreateRobotApplicationVersionOutput { + s.LastUpdatedAt = &v return s } -// Information about the batch policy. -type BatchPolicy struct { +// SetName sets the Name field's value. +func (s *CreateRobotApplicationVersionOutput) SetName(v string) *CreateRobotApplicationVersionOutput { + s.Name = &v + return s +} + +// SetRevisionId sets the RevisionId field's value. +func (s *CreateRobotApplicationVersionOutput) SetRevisionId(v string) *CreateRobotApplicationVersionOutput { + s.RevisionId = &v + return s +} + +// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. +func (s *CreateRobotApplicationVersionOutput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *CreateRobotApplicationVersionOutput { + s.RobotSoftwareSuite = v + return s +} + +// SetSources sets the Sources field's value. +func (s *CreateRobotApplicationVersionOutput) SetSources(v []*Source) *CreateRobotApplicationVersionOutput { + s.Sources = v + return s +} + +// SetVersion sets the Version field's value. +func (s *CreateRobotApplicationVersionOutput) SetVersion(v string) *CreateRobotApplicationVersionOutput { + s.Version = &v + return s +} + +type CreateRobotInput struct { _ struct{} `type:"structure"` - // The number of active simulation jobs create as part of the batch that can - // be in an active state at the same time. + // The target architecture of the robot. // - // Active states include: Pending,Preparing, Running, Restarting, RunningFailed - // and Terminating. All other states are terminal states. - MaxConcurrency *int64 `locationName:"maxConcurrency" type:"integer"` + // Architecture is a required field + Architecture *string `locationName:"architecture" type:"string" required:"true" enum:"Architecture"` - // The amount of time, in seconds, to wait for the batch to complete. + // The Greengrass group id. // - // If a batch times out, and there are pending requests that were failing due - // to an internal failure (like InternalServiceError), they will be moved to - // the failed list and the batch status will be Failed. If the pending requests - // were failing for any other reason, the failed pending requests will be moved - // to the failed list and the batch status will be TimedOut. - TimeoutInSeconds *int64 `locationName:"timeoutInSeconds" type:"long"` + // GreengrassGroupId is a required field + GreengrassGroupId *string `locationName:"greengrassGroupId" min:"1" type:"string" required:"true"` + + // The name for the robot. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // A map that contains tag keys and tag values that are attached to the robot. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s CreateRobotInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateRobotInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateRobotInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateRobotInput"} + if s.Architecture == nil { + invalidParams.Add(request.NewErrParamRequired("Architecture")) + } + if s.GreengrassGroupId == nil { + invalidParams.Add(request.NewErrParamRequired("GreengrassGroupId")) + } + if s.GreengrassGroupId != nil && len(*s.GreengrassGroupId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("GreengrassGroupId", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetArchitecture sets the Architecture field's value. +func (s *CreateRobotInput) SetArchitecture(v string) *CreateRobotInput { + s.Architecture = &v + return s +} + +// SetGreengrassGroupId sets the GreengrassGroupId field's value. +func (s *CreateRobotInput) SetGreengrassGroupId(v string) *CreateRobotInput { + s.GreengrassGroupId = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateRobotInput) SetName(v string) *CreateRobotInput { + s.Name = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateRobotInput) SetTags(v map[string]*string) *CreateRobotInput { + s.Tags = v + return s +} + +type CreateRobotOutput struct { + _ struct{} `type:"structure"` + + // The target architecture of the robot. + Architecture *string `locationName:"architecture" type:"string" enum:"Architecture"` + + // The Amazon Resource Name (ARN) of the robot. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // The time, in milliseconds since the epoch, when the robot was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + + // The Amazon Resource Name (ARN) of the Greengrass group associated with the + // robot. + GreengrassGroupId *string `locationName:"greengrassGroupId" min:"1" type:"string"` + + // The name of the robot. + Name *string `locationName:"name" min:"1" type:"string"` + + // The list of all tags added to the robot. + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation -func (s BatchPolicy) String() string { +func (s CreateRobotOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s BatchPolicy) GoString() string { +func (s CreateRobotOutput) GoString() string { return s.String() } -// SetMaxConcurrency sets the MaxConcurrency field's value. -func (s *BatchPolicy) SetMaxConcurrency(v int64) *BatchPolicy { - s.MaxConcurrency = &v +// SetArchitecture sets the Architecture field's value. +func (s *CreateRobotOutput) SetArchitecture(v string) *CreateRobotOutput { + s.Architecture = &v return s } -// SetTimeoutInSeconds sets the TimeoutInSeconds field's value. -func (s *BatchPolicy) SetTimeoutInSeconds(v int64) *BatchPolicy { - s.TimeoutInSeconds = &v +// SetArn sets the Arn field's value. +func (s *CreateRobotOutput) SetArn(v string) *CreateRobotOutput { + s.Arn = &v return s } -type CancelDeploymentJobInput struct { +// SetCreatedAt sets the CreatedAt field's value. +func (s *CreateRobotOutput) SetCreatedAt(v time.Time) *CreateRobotOutput { + s.CreatedAt = &v + return s +} + +// SetGreengrassGroupId sets the GreengrassGroupId field's value. +func (s *CreateRobotOutput) SetGreengrassGroupId(v string) *CreateRobotOutput { + s.GreengrassGroupId = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateRobotOutput) SetName(v string) *CreateRobotOutput { + s.Name = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateRobotOutput) SetTags(v map[string]*string) *CreateRobotOutput { + s.Tags = v + return s +} + +type CreateSimulationApplicationInput struct { _ struct{} `type:"structure"` - // The deployment job ARN to cancel. + // The name of the simulation application. // - // Job is a required field - Job *string `locationName:"job" min:"1" type:"string" required:"true"` + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // The rendering engine for the simulation application. + RenderingEngine *RenderingEngine `locationName:"renderingEngine" type:"structure"` + + // The robot software suite (ROS distribution) used by the simulation application. + // + // RobotSoftwareSuite is a required field + RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure" required:"true"` + + // The simulation software suite used by the simulation application. + // + // SimulationSoftwareSuite is a required field + SimulationSoftwareSuite *SimulationSoftwareSuite `locationName:"simulationSoftwareSuite" type:"structure" required:"true"` + + // The sources of the simulation application. + // + // Sources is a required field + Sources []*SourceConfig `locationName:"sources" type:"list" required:"true"` + + // A map that contains tag keys and tag values that are attached to the simulation + // application. + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation -func (s CancelDeploymentJobInput) String() string { +func (s CreateSimulationApplicationInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CancelDeploymentJobInput) GoString() string { +func (s CreateSimulationApplicationInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CancelDeploymentJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CancelDeploymentJobInput"} - if s.Job == nil { - invalidParams.Add(request.NewErrParamRequired("Job")) +func (s *CreateSimulationApplicationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateSimulationApplicationInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) } - if s.Job != nil && len(*s.Job) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Job", 1)) + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.RobotSoftwareSuite == nil { + invalidParams.Add(request.NewErrParamRequired("RobotSoftwareSuite")) + } + if s.SimulationSoftwareSuite == nil { + invalidParams.Add(request.NewErrParamRequired("SimulationSoftwareSuite")) + } + if s.Sources == nil { + invalidParams.Add(request.NewErrParamRequired("Sources")) + } + if s.RenderingEngine != nil { + if err := s.RenderingEngine.Validate(); err != nil { + invalidParams.AddNested("RenderingEngine", err.(request.ErrInvalidParams)) + } + } + if s.Sources != nil { + for i, v := range s.Sources { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Sources", i), err.(request.ErrInvalidParams)) + } + } } if invalidParams.Len() > 0 { @@ -4272,108 +7373,181 @@ func (s *CancelDeploymentJobInput) Validate() error { return nil } -// SetJob sets the Job field's value. -func (s *CancelDeploymentJobInput) SetJob(v string) *CancelDeploymentJobInput { - s.Job = &v +// SetName sets the Name field's value. +func (s *CreateSimulationApplicationInput) SetName(v string) *CreateSimulationApplicationInput { + s.Name = &v return s } -type CancelDeploymentJobOutput struct { - _ struct{} `type:"structure"` +// SetRenderingEngine sets the RenderingEngine field's value. +func (s *CreateSimulationApplicationInput) SetRenderingEngine(v *RenderingEngine) *CreateSimulationApplicationInput { + s.RenderingEngine = v + return s } -// String returns the string representation -func (s CancelDeploymentJobOutput) String() string { - return awsutil.Prettify(s) +// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. +func (s *CreateSimulationApplicationInput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *CreateSimulationApplicationInput { + s.RobotSoftwareSuite = v + return s } -// GoString returns the string representation -func (s CancelDeploymentJobOutput) GoString() string { - return s.String() +// SetSimulationSoftwareSuite sets the SimulationSoftwareSuite field's value. +func (s *CreateSimulationApplicationInput) SetSimulationSoftwareSuite(v *SimulationSoftwareSuite) *CreateSimulationApplicationInput { + s.SimulationSoftwareSuite = v + return s } -type CancelSimulationJobBatchInput struct { +// SetSources sets the Sources field's value. +func (s *CreateSimulationApplicationInput) SetSources(v []*SourceConfig) *CreateSimulationApplicationInput { + s.Sources = v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateSimulationApplicationInput) SetTags(v map[string]*string) *CreateSimulationApplicationInput { + s.Tags = v + return s +} + +type CreateSimulationApplicationOutput struct { _ struct{} `type:"structure"` - // The id of the batch to cancel. - // - // Batch is a required field - Batch *string `locationName:"batch" min:"1" type:"string" required:"true"` + // The Amazon Resource Name (ARN) of the simulation application. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // The time, in milliseconds since the epoch, when the simulation application + // was last updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` + + // The name of the simulation application. + Name *string `locationName:"name" min:"1" type:"string"` + + // The rendering engine for the simulation application. + RenderingEngine *RenderingEngine `locationName:"renderingEngine" type:"structure"` + + // The revision id of the simulation application. + RevisionId *string `locationName:"revisionId" min:"1" type:"string"` + + // Information about the robot software suite (ROS distribution). + RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` + + // The simulation software suite used by the simulation application. + SimulationSoftwareSuite *SimulationSoftwareSuite `locationName:"simulationSoftwareSuite" type:"structure"` + + // The sources of the simulation application. + Sources []*Source `locationName:"sources" type:"list"` + + // The list of all tags added to the simulation application. + Tags map[string]*string `locationName:"tags" type:"map"` + + // The version of the simulation application. + Version *string `locationName:"version" min:"1" type:"string"` } // String returns the string representation -func (s CancelSimulationJobBatchInput) String() string { +func (s CreateSimulationApplicationOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CancelSimulationJobBatchInput) GoString() string { +func (s CreateSimulationApplicationOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *CancelSimulationJobBatchInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CancelSimulationJobBatchInput"} - if s.Batch == nil { - invalidParams.Add(request.NewErrParamRequired("Batch")) - } - if s.Batch != nil && len(*s.Batch) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Batch", 1)) - } +// SetArn sets the Arn field's value. +func (s *CreateSimulationApplicationOutput) SetArn(v string) *CreateSimulationApplicationOutput { + s.Arn = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *CreateSimulationApplicationOutput) SetLastUpdatedAt(v time.Time) *CreateSimulationApplicationOutput { + s.LastUpdatedAt = &v + return s } -// SetBatch sets the Batch field's value. -func (s *CancelSimulationJobBatchInput) SetBatch(v string) *CancelSimulationJobBatchInput { - s.Batch = &v +// SetName sets the Name field's value. +func (s *CreateSimulationApplicationOutput) SetName(v string) *CreateSimulationApplicationOutput { + s.Name = &v return s } -type CancelSimulationJobBatchOutput struct { - _ struct{} `type:"structure"` +// SetRenderingEngine sets the RenderingEngine field's value. +func (s *CreateSimulationApplicationOutput) SetRenderingEngine(v *RenderingEngine) *CreateSimulationApplicationOutput { + s.RenderingEngine = v + return s } -// String returns the string representation -func (s CancelSimulationJobBatchOutput) String() string { - return awsutil.Prettify(s) +// SetRevisionId sets the RevisionId field's value. +func (s *CreateSimulationApplicationOutput) SetRevisionId(v string) *CreateSimulationApplicationOutput { + s.RevisionId = &v + return s +} + +// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. +func (s *CreateSimulationApplicationOutput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *CreateSimulationApplicationOutput { + s.RobotSoftwareSuite = v + return s +} + +// SetSimulationSoftwareSuite sets the SimulationSoftwareSuite field's value. +func (s *CreateSimulationApplicationOutput) SetSimulationSoftwareSuite(v *SimulationSoftwareSuite) *CreateSimulationApplicationOutput { + s.SimulationSoftwareSuite = v + return s +} + +// SetSources sets the Sources field's value. +func (s *CreateSimulationApplicationOutput) SetSources(v []*Source) *CreateSimulationApplicationOutput { + s.Sources = v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateSimulationApplicationOutput) SetTags(v map[string]*string) *CreateSimulationApplicationOutput { + s.Tags = v + return s } -// GoString returns the string representation -func (s CancelSimulationJobBatchOutput) GoString() string { - return s.String() +// SetVersion sets the Version field's value. +func (s *CreateSimulationApplicationOutput) SetVersion(v string) *CreateSimulationApplicationOutput { + s.Version = &v + return s } -type CancelSimulationJobInput struct { +type CreateSimulationApplicationVersionInput struct { _ struct{} `type:"structure"` - // The simulation job ARN to cancel. + // The application information for the simulation application. // - // Job is a required field - Job *string `locationName:"job" min:"1" type:"string" required:"true"` + // Application is a required field + Application *string `locationName:"application" min:"1" type:"string" required:"true"` + + // The current revision id for the simulation application. If you provide a + // value and it matches the latest revision ID, a new version will be created. + CurrentRevisionId *string `locationName:"currentRevisionId" min:"1" type:"string"` } // String returns the string representation -func (s CancelSimulationJobInput) String() string { +func (s CreateSimulationApplicationVersionInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CancelSimulationJobInput) GoString() string { +func (s CreateSimulationApplicationVersionInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CancelSimulationJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CancelSimulationJobInput"} - if s.Job == nil { - invalidParams.Add(request.NewErrParamRequired("Job")) +func (s *CreateSimulationApplicationVersionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateSimulationApplicationVersionInput"} + if s.Application == nil { + invalidParams.Add(request.NewErrParamRequired("Application")) } - if s.Job != nil && len(*s.Job) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Job", 1)) + if s.Application != nil && len(*s.Application) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Application", 1)) + } + if s.CurrentRevisionId != nil && len(*s.CurrentRevisionId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CurrentRevisionId", 1)) } if invalidParams.Len() > 0 { @@ -4382,215 +7556,261 @@ func (s *CancelSimulationJobInput) Validate() error { return nil } -// SetJob sets the Job field's value. -func (s *CancelSimulationJobInput) SetJob(v string) *CancelSimulationJobInput { - s.Job = &v +// SetApplication sets the Application field's value. +func (s *CreateSimulationApplicationVersionInput) SetApplication(v string) *CreateSimulationApplicationVersionInput { + s.Application = &v return s } -type CancelSimulationJobOutput struct { - _ struct{} `type:"structure"` -} - -// String returns the string representation -func (s CancelSimulationJobOutput) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s CancelSimulationJobOutput) GoString() string { - return s.String() +// SetCurrentRevisionId sets the CurrentRevisionId field's value. +func (s *CreateSimulationApplicationVersionInput) SetCurrentRevisionId(v string) *CreateSimulationApplicationVersionInput { + s.CurrentRevisionId = &v + return s } -// Compute information for the simulation job. -type Compute struct { +type CreateSimulationApplicationVersionOutput struct { _ struct{} `type:"structure"` - // The simulation unit limit. Your simulation is allocated CPU and memory proportional - // to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB - // of memory. You are only billed for the SU utilization you consume up to the - // maximim value provided. - SimulationUnitLimit *int64 `locationName:"simulationUnitLimit" min:"1" type:"integer"` -} + // The Amazon Resource Name (ARN) of the simulation application. + Arn *string `locationName:"arn" min:"1" type:"string"` -// String returns the string representation -func (s Compute) String() string { - return awsutil.Prettify(s) -} + // The time, in milliseconds since the epoch, when the simulation application + // was last updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` -// GoString returns the string representation -func (s Compute) GoString() string { - return s.String() -} + // The name of the simulation application. + Name *string `locationName:"name" min:"1" type:"string"` -// Validate inspects the fields of the type to determine if they are valid. -func (s *Compute) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "Compute"} - if s.SimulationUnitLimit != nil && *s.SimulationUnitLimit < 1 { - invalidParams.Add(request.NewErrParamMinValue("SimulationUnitLimit", 1)) - } + // The rendering engine for the simulation application. + RenderingEngine *RenderingEngine `locationName:"renderingEngine" type:"structure"` - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} + // The revision ID of the simulation application. + RevisionId *string `locationName:"revisionId" min:"1" type:"string"` -// SetSimulationUnitLimit sets the SimulationUnitLimit field's value. -func (s *Compute) SetSimulationUnitLimit(v int64) *Compute { - s.SimulationUnitLimit = &v - return s -} + // Information about the robot software suite (ROS distribution). + RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` -// Compute information for the simulation job -type ComputeResponse struct { - _ struct{} `type:"structure"` + // The simulation software suite used by the simulation application. + SimulationSoftwareSuite *SimulationSoftwareSuite `locationName:"simulationSoftwareSuite" type:"structure"` - // The simulation unit limit. Your simulation is allocated CPU and memory proportional - // to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB - // of memory. You are only billed for the SU utilization you consume up to the - // maximim value provided. - SimulationUnitLimit *int64 `locationName:"simulationUnitLimit" min:"1" type:"integer"` + // The sources of the simulation application. + Sources []*Source `locationName:"sources" type:"list"` + + // The version of the simulation application. + Version *string `locationName:"version" min:"1" type:"string"` } // String returns the string representation -func (s ComputeResponse) String() string { +func (s CreateSimulationApplicationVersionOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ComputeResponse) GoString() string { +func (s CreateSimulationApplicationVersionOutput) GoString() string { return s.String() } -// SetSimulationUnitLimit sets the SimulationUnitLimit field's value. -func (s *ComputeResponse) SetSimulationUnitLimit(v int64) *ComputeResponse { - s.SimulationUnitLimit = &v +// SetArn sets the Arn field's value. +func (s *CreateSimulationApplicationVersionOutput) SetArn(v string) *CreateSimulationApplicationVersionOutput { + s.Arn = &v return s } -// The failure percentage threshold percentage was met. -type ConcurrentDeploymentException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - - Message_ *string `locationName:"message" type:"string"` -} - -// String returns the string representation -func (s ConcurrentDeploymentException) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s ConcurrentDeploymentException) GoString() string { - return s.String() +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *CreateSimulationApplicationVersionOutput) SetLastUpdatedAt(v time.Time) *CreateSimulationApplicationVersionOutput { + s.LastUpdatedAt = &v + return s } -func newErrorConcurrentDeploymentException(v protocol.ResponseMetadata) error { - return &ConcurrentDeploymentException{ - RespMetadata: v, - } +// SetName sets the Name field's value. +func (s *CreateSimulationApplicationVersionOutput) SetName(v string) *CreateSimulationApplicationVersionOutput { + s.Name = &v + return s } -// Code returns the exception type name. -func (s *ConcurrentDeploymentException) Code() string { - return "ConcurrentDeploymentException" +// SetRenderingEngine sets the RenderingEngine field's value. +func (s *CreateSimulationApplicationVersionOutput) SetRenderingEngine(v *RenderingEngine) *CreateSimulationApplicationVersionOutput { + s.RenderingEngine = v + return s } -// Message returns the exception's message. -func (s *ConcurrentDeploymentException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" +// SetRevisionId sets the RevisionId field's value. +func (s *CreateSimulationApplicationVersionOutput) SetRevisionId(v string) *CreateSimulationApplicationVersionOutput { + s.RevisionId = &v + return s } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *ConcurrentDeploymentException) OrigErr() error { - return nil +// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. +func (s *CreateSimulationApplicationVersionOutput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *CreateSimulationApplicationVersionOutput { + s.RobotSoftwareSuite = v + return s } -func (s *ConcurrentDeploymentException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// SetSimulationSoftwareSuite sets the SimulationSoftwareSuite field's value. +func (s *CreateSimulationApplicationVersionOutput) SetSimulationSoftwareSuite(v *SimulationSoftwareSuite) *CreateSimulationApplicationVersionOutput { + s.SimulationSoftwareSuite = v + return s } -// Status code returns the HTTP status code for the request's response error. -func (s *ConcurrentDeploymentException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetSources sets the Sources field's value. +func (s *CreateSimulationApplicationVersionOutput) SetSources(v []*Source) *CreateSimulationApplicationVersionOutput { + s.Sources = v + return s } -// RequestID returns the service's response RequestID for request. -func (s *ConcurrentDeploymentException) RequestID() string { - return s.RespMetadata.RequestID +// SetVersion sets the Version field's value. +func (s *CreateSimulationApplicationVersionOutput) SetVersion(v string) *CreateSimulationApplicationVersionOutput { + s.Version = &v + return s } -type CreateDeploymentJobInput struct { +type CreateSimulationJobInput struct { _ struct{} `type:"structure"` // Unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string" idempotencyToken:"true"` - // The deployment application configuration. + // Compute information for the simulation job. + Compute *Compute `locationName:"compute" type:"structure"` + + // Specify data sources to mount read-only files from S3 into your simulation. + // These files are available under /opt/robomaker/datasources/data_source_name. // - // DeploymentApplicationConfigs is a required field - DeploymentApplicationConfigs []*DeploymentApplicationConfig `locationName:"deploymentApplicationConfigs" min:"1" type:"list" required:"true"` + // There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig + // objects. + DataSources []*DataSourceConfig `locationName:"dataSources" min:"1" type:"list"` - // The requested deployment configuration. - DeploymentConfig *DeploymentConfig `locationName:"deploymentConfig" type:"structure"` + // The failure behavior the simulation job. + // + // Continue + // + // Restart the simulation job in the same host instance. + // + // Fail + // + // Stop the simulation job and terminate the instance. + FailureBehavior *string `locationName:"failureBehavior" type:"string" enum:"FailureBehavior"` - // The Amazon Resource Name (ARN) of the fleet to deploy. + // The IAM role name that allows the simulation instance to call the AWS APIs + // that are specified in its associated policies on your behalf. This is how + // credentials are passed in to your simulation job. // - // Fleet is a required field - Fleet *string `locationName:"fleet" min:"1" type:"string" required:"true"` + // IamRole is a required field + IamRole *string `locationName:"iamRole" min:"1" type:"string" required:"true"` - // A map that contains tag keys and tag values that are attached to the deployment + // The logging configuration. + LoggingConfig *LoggingConfig `locationName:"loggingConfig" type:"structure"` + + // The maximum simulation job duration in seconds (up to 14 days or 1,209,600 + // seconds. When maxJobDurationInSeconds is reached, the simulation job will + // status will transition to Completed. + // + // MaxJobDurationInSeconds is a required field + MaxJobDurationInSeconds *int64 `locationName:"maxJobDurationInSeconds" type:"long" required:"true"` + + // Location for output files generated by the simulation job. + OutputLocation *OutputLocation `locationName:"outputLocation" type:"structure"` + + // The robot application to use in the simulation job. + RobotApplications []*RobotApplicationConfig `locationName:"robotApplications" min:"1" type:"list"` + + // The simulation application to use in the simulation job. + SimulationApplications []*SimulationApplicationConfig `locationName:"simulationApplications" min:"1" type:"list"` + + // A map that contains tag keys and tag values that are attached to the simulation // job. Tags map[string]*string `locationName:"tags" type:"map"` + + // If your simulation job accesses resources in a VPC, you provide this parameter + // identifying the list of security group IDs and subnet IDs. These must belong + // to the same VPC. You must provide at least one security group and one subnet + // ID. + VpcConfig *VPCConfig `locationName:"vpcConfig" type:"structure"` } // String returns the string representation -func (s CreateDeploymentJobInput) String() string { +func (s CreateSimulationJobInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateDeploymentJobInput) GoString() string { +func (s CreateSimulationJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateDeploymentJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateDeploymentJobInput"} +func (s *CreateSimulationJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateSimulationJobInput"} if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) } - if s.DeploymentApplicationConfigs == nil { - invalidParams.Add(request.NewErrParamRequired("DeploymentApplicationConfigs")) + if s.DataSources != nil && len(s.DataSources) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DataSources", 1)) } - if s.DeploymentApplicationConfigs != nil && len(s.DeploymentApplicationConfigs) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DeploymentApplicationConfigs", 1)) + if s.IamRole == nil { + invalidParams.Add(request.NewErrParamRequired("IamRole")) } - if s.Fleet == nil { - invalidParams.Add(request.NewErrParamRequired("Fleet")) + if s.IamRole != nil && len(*s.IamRole) < 1 { + invalidParams.Add(request.NewErrParamMinLen("IamRole", 1)) } - if s.Fleet != nil && len(*s.Fleet) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Fleet", 1)) + if s.MaxJobDurationInSeconds == nil { + invalidParams.Add(request.NewErrParamRequired("MaxJobDurationInSeconds")) } - if s.DeploymentApplicationConfigs != nil { - for i, v := range s.DeploymentApplicationConfigs { + if s.RobotApplications != nil && len(s.RobotApplications) < 1 { + invalidParams.Add(request.NewErrParamMinLen("RobotApplications", 1)) + } + if s.SimulationApplications != nil && len(s.SimulationApplications) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SimulationApplications", 1)) + } + if s.Compute != nil { + if err := s.Compute.Validate(); err != nil { + invalidParams.AddNested("Compute", err.(request.ErrInvalidParams)) + } + } + if s.DataSources != nil { + for i, v := range s.DataSources { if v == nil { continue } if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "DeploymentApplicationConfigs", i), err.(request.ErrInvalidParams)) + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "DataSources", i), err.(request.ErrInvalidParams)) } } } - if s.DeploymentConfig != nil { - if err := s.DeploymentConfig.Validate(); err != nil { - invalidParams.AddNested("DeploymentConfig", err.(request.ErrInvalidParams)) + if s.LoggingConfig != nil { + if err := s.LoggingConfig.Validate(); err != nil { + invalidParams.AddNested("LoggingConfig", err.(request.ErrInvalidParams)) + } + } + if s.OutputLocation != nil { + if err := s.OutputLocation.Validate(); err != nil { + invalidParams.AddNested("OutputLocation", err.(request.ErrInvalidParams)) + } + } + if s.RobotApplications != nil { + for i, v := range s.RobotApplications { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "RobotApplications", i), err.(request.ErrInvalidParams)) + } + } + } + if s.SimulationApplications != nil { + for i, v := range s.SimulationApplications { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "SimulationApplications", i), err.(request.ErrInvalidParams)) + } + } + } + if s.VpcConfig != nil { + if err := s.VpcConfig.Validate(); err != nil { + invalidParams.AddNested("VpcConfig", err.(request.ErrInvalidParams)) } } @@ -4601,217 +7821,378 @@ func (s *CreateDeploymentJobInput) Validate() error { } // SetClientRequestToken sets the ClientRequestToken field's value. -func (s *CreateDeploymentJobInput) SetClientRequestToken(v string) *CreateDeploymentJobInput { +func (s *CreateSimulationJobInput) SetClientRequestToken(v string) *CreateSimulationJobInput { s.ClientRequestToken = &v return s } -// SetDeploymentApplicationConfigs sets the DeploymentApplicationConfigs field's value. -func (s *CreateDeploymentJobInput) SetDeploymentApplicationConfigs(v []*DeploymentApplicationConfig) *CreateDeploymentJobInput { - s.DeploymentApplicationConfigs = v +// SetCompute sets the Compute field's value. +func (s *CreateSimulationJobInput) SetCompute(v *Compute) *CreateSimulationJobInput { + s.Compute = v return s } -// SetDeploymentConfig sets the DeploymentConfig field's value. -func (s *CreateDeploymentJobInput) SetDeploymentConfig(v *DeploymentConfig) *CreateDeploymentJobInput { - s.DeploymentConfig = v +// SetDataSources sets the DataSources field's value. +func (s *CreateSimulationJobInput) SetDataSources(v []*DataSourceConfig) *CreateSimulationJobInput { + s.DataSources = v return s } -// SetFleet sets the Fleet field's value. -func (s *CreateDeploymentJobInput) SetFleet(v string) *CreateDeploymentJobInput { - s.Fleet = &v +// SetFailureBehavior sets the FailureBehavior field's value. +func (s *CreateSimulationJobInput) SetFailureBehavior(v string) *CreateSimulationJobInput { + s.FailureBehavior = &v + return s +} + +// SetIamRole sets the IamRole field's value. +func (s *CreateSimulationJobInput) SetIamRole(v string) *CreateSimulationJobInput { + s.IamRole = &v + return s +} + +// SetLoggingConfig sets the LoggingConfig field's value. +func (s *CreateSimulationJobInput) SetLoggingConfig(v *LoggingConfig) *CreateSimulationJobInput { + s.LoggingConfig = v + return s +} + +// SetMaxJobDurationInSeconds sets the MaxJobDurationInSeconds field's value. +func (s *CreateSimulationJobInput) SetMaxJobDurationInSeconds(v int64) *CreateSimulationJobInput { + s.MaxJobDurationInSeconds = &v + return s +} + +// SetOutputLocation sets the OutputLocation field's value. +func (s *CreateSimulationJobInput) SetOutputLocation(v *OutputLocation) *CreateSimulationJobInput { + s.OutputLocation = v + return s +} + +// SetRobotApplications sets the RobotApplications field's value. +func (s *CreateSimulationJobInput) SetRobotApplications(v []*RobotApplicationConfig) *CreateSimulationJobInput { + s.RobotApplications = v + return s +} + +// SetSimulationApplications sets the SimulationApplications field's value. +func (s *CreateSimulationJobInput) SetSimulationApplications(v []*SimulationApplicationConfig) *CreateSimulationJobInput { + s.SimulationApplications = v return s } // SetTags sets the Tags field's value. -func (s *CreateDeploymentJobInput) SetTags(v map[string]*string) *CreateDeploymentJobInput { +func (s *CreateSimulationJobInput) SetTags(v map[string]*string) *CreateSimulationJobInput { s.Tags = v return s } -type CreateDeploymentJobOutput struct { +// SetVpcConfig sets the VpcConfig field's value. +func (s *CreateSimulationJobInput) SetVpcConfig(v *VPCConfig) *CreateSimulationJobInput { + s.VpcConfig = v + return s +} + +type CreateSimulationJobOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the deployment job. + // The Amazon Resource Name (ARN) of the simulation job. Arn *string `locationName:"arn" min:"1" type:"string"` - // The time, in milliseconds since the epoch, when the fleet was created. - CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + // Unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"` - // The deployment application configuration. - DeploymentApplicationConfigs []*DeploymentApplicationConfig `locationName:"deploymentApplicationConfigs" min:"1" type:"list"` + // Compute information for the simulation job. + Compute *ComputeResponse `locationName:"compute" type:"structure"` - // The deployment configuration. - DeploymentConfig *DeploymentConfig `locationName:"deploymentConfig" type:"structure"` + // The data sources for the simulation job. + DataSources []*DataSource `locationName:"dataSources" type:"list"` + + // the failure behavior for the simulation job. + FailureBehavior *string `locationName:"failureBehavior" type:"string" enum:"FailureBehavior"` // The failure code of the simulation job if it failed: // - // BadPermissionError + // InternalServiceError // - // AWS Greengrass requires a service-level role permission to access other services. - // The role must include the AWSGreengrassResourceAccessRolePolicy managed policy - // (https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy$jsonEditor). + // Internal service error. // - // ExtractingBundleFailure + // RobotApplicationCrash // - // The robot application could not be extracted from the bundle. + // Robot application exited abnormally. // - // FailureThresholdBreached + // SimulationApplicationCrash // - // The percentage of robots that could not be updated exceeded the percentage - // set for the deployment. + // Simulation application exited abnormally. // - // GreengrassDeploymentFailed + // BadPermissionsRobotApplication // - // The robot application could not be deployed to the robot. + // Robot application bundle could not be downloaded. // - // GreengrassGroupVersionDoesNotExist + // BadPermissionsSimulationApplication // - // The AWS Greengrass group or version associated with a robot is missing. + // Simulation application bundle could not be downloaded. // - // InternalServerError + // BadPermissionsS3Output // - // An internal error has occurred. Retry your request, but if the problem persists, - // contact us with details. + // Unable to publish outputs to customer-provided S3 bucket. // - // MissingRobotApplicationArchitecture + // BadPermissionsCloudwatchLogs // - // The robot application does not have a source that matches the architecture - // of the robot. + // Unable to publish logs to customer-provided CloudWatch Logs resource. // - // MissingRobotDeploymentResource + // SubnetIpLimitExceeded // - // One or more of the resources specified for the robot application are missing. - // For example, does the robot application have the correct launch package and - // launch file? + // Subnet IP limit exceeded. // - // PostLaunchFileFailure + // ENILimitExceeded // - // The post-launch script failed. + // ENI limit exceeded. // - // PreLaunchFileFailure + // BadPermissionsUserCredentials // - // The pre-launch script failed. + // Unable to use the Role provided. // - // ResourceNotFound + // InvalidBundleRobotApplication // - // One or more deployment resources are missing. For example, do robot application - // source bundles still exist? + // Robot bundle cannot be extracted (invalid format, bundling error, or other + // issue). // - // RobotDeploymentNoResponse + // InvalidBundleSimulationApplication // - // There is no response from the robot. It might not be powered on or connected - // to the internet. - FailureCode *string `locationName:"failureCode" type:"string" enum:"DeploymentJobErrorCode"` + // Simulation bundle cannot be extracted (invalid format, bundling error, or + // other issue). + // + // RobotApplicationVersionMismatchedEtag + // + // Etag for RobotApplication does not match value during version creation. + // + // SimulationApplicationVersionMismatchedEtag + // + // Etag for SimulationApplication does not match value during version creation. + FailureCode *string `locationName:"failureCode" type:"string" enum:"SimulationJobErrorCode"` + + // The IAM role that allows the simulation job to call the AWS APIs that are + // specified in its associated policies on your behalf. + IamRole *string `locationName:"iamRole" min:"1" type:"string"` + + // The time, in milliseconds since the epoch, when the simulation job was last + // started. + LastStartedAt *time.Time `locationName:"lastStartedAt" type:"timestamp"` + + // The time, in milliseconds since the epoch, when the simulation job was last + // updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` + + // The logging configuration. + LoggingConfig *LoggingConfig `locationName:"loggingConfig" type:"structure"` + + // The maximum simulation job duration in seconds. + MaxJobDurationInSeconds *int64 `locationName:"maxJobDurationInSeconds" type:"long"` + + // Simulation job output files location. + OutputLocation *OutputLocation `locationName:"outputLocation" type:"structure"` - // The failure reason of the deployment job if it failed. - FailureReason *string `locationName:"failureReason" type:"string"` + // The robot application used by the simulation job. + RobotApplications []*RobotApplicationConfig `locationName:"robotApplications" min:"1" type:"list"` - // The target fleet for the deployment job. - Fleet *string `locationName:"fleet" min:"1" type:"string"` + // The simulation application used by the simulation job. + SimulationApplications []*SimulationApplicationConfig `locationName:"simulationApplications" min:"1" type:"list"` - // The status of the deployment job. - Status *string `locationName:"status" type:"string" enum:"DeploymentStatus"` + // The simulation job execution duration in milliseconds. + SimulationTimeMillis *int64 `locationName:"simulationTimeMillis" type:"long"` - // The list of all tags added to the deployment job. + // The status of the simulation job. + Status *string `locationName:"status" type:"string" enum:"SimulationJobStatus"` + + // The list of all tags added to the simulation job. Tags map[string]*string `locationName:"tags" type:"map"` + + // Information about the vpc configuration. + VpcConfig *VPCConfigResponse `locationName:"vpcConfig" type:"structure"` } // String returns the string representation -func (s CreateDeploymentJobOutput) String() string { +func (s CreateSimulationJobOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateDeploymentJobOutput) GoString() string { +func (s CreateSimulationJobOutput) GoString() string { return s.String() } // SetArn sets the Arn field's value. -func (s *CreateDeploymentJobOutput) SetArn(v string) *CreateDeploymentJobOutput { +func (s *CreateSimulationJobOutput) SetArn(v string) *CreateSimulationJobOutput { s.Arn = &v return s } -// SetCreatedAt sets the CreatedAt field's value. -func (s *CreateDeploymentJobOutput) SetCreatedAt(v time.Time) *CreateDeploymentJobOutput { - s.CreatedAt = &v +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *CreateSimulationJobOutput) SetClientRequestToken(v string) *CreateSimulationJobOutput { + s.ClientRequestToken = &v return s } -// SetDeploymentApplicationConfigs sets the DeploymentApplicationConfigs field's value. -func (s *CreateDeploymentJobOutput) SetDeploymentApplicationConfigs(v []*DeploymentApplicationConfig) *CreateDeploymentJobOutput { - s.DeploymentApplicationConfigs = v +// SetCompute sets the Compute field's value. +func (s *CreateSimulationJobOutput) SetCompute(v *ComputeResponse) *CreateSimulationJobOutput { + s.Compute = v return s } -// SetDeploymentConfig sets the DeploymentConfig field's value. -func (s *CreateDeploymentJobOutput) SetDeploymentConfig(v *DeploymentConfig) *CreateDeploymentJobOutput { - s.DeploymentConfig = v +// SetDataSources sets the DataSources field's value. +func (s *CreateSimulationJobOutput) SetDataSources(v []*DataSource) *CreateSimulationJobOutput { + s.DataSources = v + return s +} + +// SetFailureBehavior sets the FailureBehavior field's value. +func (s *CreateSimulationJobOutput) SetFailureBehavior(v string) *CreateSimulationJobOutput { + s.FailureBehavior = &v return s } // SetFailureCode sets the FailureCode field's value. -func (s *CreateDeploymentJobOutput) SetFailureCode(v string) *CreateDeploymentJobOutput { +func (s *CreateSimulationJobOutput) SetFailureCode(v string) *CreateSimulationJobOutput { s.FailureCode = &v return s } -// SetFailureReason sets the FailureReason field's value. -func (s *CreateDeploymentJobOutput) SetFailureReason(v string) *CreateDeploymentJobOutput { - s.FailureReason = &v +// SetIamRole sets the IamRole field's value. +func (s *CreateSimulationJobOutput) SetIamRole(v string) *CreateSimulationJobOutput { + s.IamRole = &v return s } -// SetFleet sets the Fleet field's value. -func (s *CreateDeploymentJobOutput) SetFleet(v string) *CreateDeploymentJobOutput { - s.Fleet = &v +// SetLastStartedAt sets the LastStartedAt field's value. +func (s *CreateSimulationJobOutput) SetLastStartedAt(v time.Time) *CreateSimulationJobOutput { + s.LastStartedAt = &v + return s +} + +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *CreateSimulationJobOutput) SetLastUpdatedAt(v time.Time) *CreateSimulationJobOutput { + s.LastUpdatedAt = &v + return s +} + +// SetLoggingConfig sets the LoggingConfig field's value. +func (s *CreateSimulationJobOutput) SetLoggingConfig(v *LoggingConfig) *CreateSimulationJobOutput { + s.LoggingConfig = v + return s +} + +// SetMaxJobDurationInSeconds sets the MaxJobDurationInSeconds field's value. +func (s *CreateSimulationJobOutput) SetMaxJobDurationInSeconds(v int64) *CreateSimulationJobOutput { + s.MaxJobDurationInSeconds = &v + return s +} + +// SetOutputLocation sets the OutputLocation field's value. +func (s *CreateSimulationJobOutput) SetOutputLocation(v *OutputLocation) *CreateSimulationJobOutput { + s.OutputLocation = v + return s +} + +// SetRobotApplications sets the RobotApplications field's value. +func (s *CreateSimulationJobOutput) SetRobotApplications(v []*RobotApplicationConfig) *CreateSimulationJobOutput { + s.RobotApplications = v + return s +} + +// SetSimulationApplications sets the SimulationApplications field's value. +func (s *CreateSimulationJobOutput) SetSimulationApplications(v []*SimulationApplicationConfig) *CreateSimulationJobOutput { + s.SimulationApplications = v + return s +} + +// SetSimulationTimeMillis sets the SimulationTimeMillis field's value. +func (s *CreateSimulationJobOutput) SetSimulationTimeMillis(v int64) *CreateSimulationJobOutput { + s.SimulationTimeMillis = &v return s } // SetStatus sets the Status field's value. -func (s *CreateDeploymentJobOutput) SetStatus(v string) *CreateDeploymentJobOutput { +func (s *CreateSimulationJobOutput) SetStatus(v string) *CreateSimulationJobOutput { s.Status = &v return s } // SetTags sets the Tags field's value. -func (s *CreateDeploymentJobOutput) SetTags(v map[string]*string) *CreateDeploymentJobOutput { +func (s *CreateSimulationJobOutput) SetTags(v map[string]*string) *CreateSimulationJobOutput { s.Tags = v return s } -type CreateFleetInput struct { +// SetVpcConfig sets the VpcConfig field's value. +func (s *CreateSimulationJobOutput) SetVpcConfig(v *VPCConfigResponse) *CreateSimulationJobOutput { + s.VpcConfig = v + return s +} + +type CreateWorldExportJobInput struct { _ struct{} `type:"structure"` - // The name of the fleet. + // Unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string" idempotencyToken:"true"` + + // The IAM role that the world export process uses to access the Amazon S3 bucket + // and put the export. // - // Name is a required field - Name *string `locationName:"name" min:"1" type:"string" required:"true"` + // IamRole is a required field + IamRole *string `locationName:"iamRole" min:"1" type:"string" required:"true"` - // A map that contains tag keys and tag values that are attached to the fleet. + // The output location. + // + // OutputLocation is a required field + OutputLocation *OutputLocation `locationName:"outputLocation" type:"structure" required:"true"` + + // A map that contains tag keys and tag values that are attached to the world + // export job. Tags map[string]*string `locationName:"tags" type:"map"` + + // A list of Amazon Resource Names (arns) that correspond to worlds to export. + // + // Worlds is a required field + Worlds []*string `locationName:"worlds" min:"1" type:"list" required:"true"` } // String returns the string representation -func (s CreateFleetInput) String() string { +func (s CreateWorldExportJobInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateFleetInput) GoString() string { +func (s CreateWorldExportJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateFleetInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateFleetInput"} - if s.Name == nil { - invalidParams.Add(request.NewErrParamRequired("Name")) +func (s *CreateWorldExportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateWorldExportJobInput"} + if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) } - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + if s.IamRole == nil { + invalidParams.Add(request.NewErrParamRequired("IamRole")) + } + if s.IamRole != nil && len(*s.IamRole) < 1 { + invalidParams.Add(request.NewErrParamMinLen("IamRole", 1)) + } + if s.OutputLocation == nil { + invalidParams.Add(request.NewErrParamRequired("OutputLocation")) + } + if s.Worlds == nil { + invalidParams.Add(request.NewErrParamRequired("Worlds")) + } + if s.Worlds != nil && len(s.Worlds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Worlds", 1)) + } + if s.OutputLocation != nil { + if err := s.OutputLocation.Validate(); err != nil { + invalidParams.AddNested("OutputLocation", err.(request.ErrInvalidParams)) + } } if invalidParams.Len() > 0 { @@ -4820,125 +8201,218 @@ func (s *CreateFleetInput) Validate() error { return nil } -// SetName sets the Name field's value. -func (s *CreateFleetInput) SetName(v string) *CreateFleetInput { - s.Name = &v +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *CreateWorldExportJobInput) SetClientRequestToken(v string) *CreateWorldExportJobInput { + s.ClientRequestToken = &v + return s +} + +// SetIamRole sets the IamRole field's value. +func (s *CreateWorldExportJobInput) SetIamRole(v string) *CreateWorldExportJobInput { + s.IamRole = &v + return s +} + +// SetOutputLocation sets the OutputLocation field's value. +func (s *CreateWorldExportJobInput) SetOutputLocation(v *OutputLocation) *CreateWorldExportJobInput { + s.OutputLocation = v return s } // SetTags sets the Tags field's value. -func (s *CreateFleetInput) SetTags(v map[string]*string) *CreateFleetInput { +func (s *CreateWorldExportJobInput) SetTags(v map[string]*string) *CreateWorldExportJobInput { s.Tags = v return s } -type CreateFleetOutput struct { +// SetWorlds sets the Worlds field's value. +func (s *CreateWorldExportJobInput) SetWorlds(v []*string) *CreateWorldExportJobInput { + s.Worlds = v + return s +} + +type CreateWorldExportJobOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the fleet. + // The Amazon Resource Name (ARN) of the world export job. Arn *string `locationName:"arn" min:"1" type:"string"` - // The time, in milliseconds since the epoch, when the fleet was created. + // Unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"` + + // The time, in milliseconds since the epoch, when the world export job was + // created. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The name of the fleet. - Name *string `locationName:"name" min:"1" type:"string"` + // The failure code of the world export job if it failed: + // + // InternalServiceError + // + // Internal service error. + // + // LimitExceeded + // + // The requested resource exceeds the maximum number allowed, or the number + // of concurrent stream requests exceeds the maximum number allowed. + // + // ResourceNotFound + // + // The specified resource could not be found. + // + // RequestThrottled + // + // The request was throttled. + // + // InvalidInput + // + // An input parameter in the request is not valid. + FailureCode *string `locationName:"failureCode" type:"string" enum:"WorldExportJobErrorCode"` - // The list of all tags added to the fleet. + // The IAM role that the world export process uses to access the Amazon S3 bucket + // and put the export. + IamRole *string `locationName:"iamRole" min:"1" type:"string"` + + // The output location. + OutputLocation *OutputLocation `locationName:"outputLocation" type:"structure"` + + // The status of the world export job. + // + // Pending + // + // The world export job request is pending. + // + // Running + // + // The world export job is running. + // + // Completed + // + // The world export job completed. + // + // Failed + // + // The world export job failed. See failureCode for more information. + // + // Canceled + // + // The world export job was cancelled. + // + // Canceling + // + // The world export job is being cancelled. + Status *string `locationName:"status" type:"string" enum:"WorldExportJobStatus"` + + // A map that contains tag keys and tag values that are attached to the world + // export job. Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation -func (s CreateFleetOutput) String() string { +func (s CreateWorldExportJobOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateFleetOutput) GoString() string { +func (s CreateWorldExportJobOutput) GoString() string { return s.String() } // SetArn sets the Arn field's value. -func (s *CreateFleetOutput) SetArn(v string) *CreateFleetOutput { +func (s *CreateWorldExportJobOutput) SetArn(v string) *CreateWorldExportJobOutput { s.Arn = &v return s } +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *CreateWorldExportJobOutput) SetClientRequestToken(v string) *CreateWorldExportJobOutput { + s.ClientRequestToken = &v + return s +} + // SetCreatedAt sets the CreatedAt field's value. -func (s *CreateFleetOutput) SetCreatedAt(v time.Time) *CreateFleetOutput { +func (s *CreateWorldExportJobOutput) SetCreatedAt(v time.Time) *CreateWorldExportJobOutput { s.CreatedAt = &v return s } -// SetName sets the Name field's value. -func (s *CreateFleetOutput) SetName(v string) *CreateFleetOutput { - s.Name = &v +// SetFailureCode sets the FailureCode field's value. +func (s *CreateWorldExportJobOutput) SetFailureCode(v string) *CreateWorldExportJobOutput { + s.FailureCode = &v + return s +} + +// SetIamRole sets the IamRole field's value. +func (s *CreateWorldExportJobOutput) SetIamRole(v string) *CreateWorldExportJobOutput { + s.IamRole = &v + return s +} + +// SetOutputLocation sets the OutputLocation field's value. +func (s *CreateWorldExportJobOutput) SetOutputLocation(v *OutputLocation) *CreateWorldExportJobOutput { + s.OutputLocation = v + return s +} + +// SetStatus sets the Status field's value. +func (s *CreateWorldExportJobOutput) SetStatus(v string) *CreateWorldExportJobOutput { + s.Status = &v return s } // SetTags sets the Tags field's value. -func (s *CreateFleetOutput) SetTags(v map[string]*string) *CreateFleetOutput { +func (s *CreateWorldExportJobOutput) SetTags(v map[string]*string) *CreateWorldExportJobOutput { s.Tags = v return s } -type CreateRobotApplicationInput struct { +type CreateWorldGenerationJobInput struct { _ struct{} `type:"structure"` - // The name of the robot application. - // - // Name is a required field - Name *string `locationName:"name" min:"1" type:"string" required:"true"` + // Unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string" idempotencyToken:"true"` - // The robot software suite (ROS distribuition) used by the robot application. - // - // RobotSoftwareSuite is a required field - RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure" required:"true"` + // A map that contains tag keys and tag values that are attached to the world + // generator job. + Tags map[string]*string `locationName:"tags" type:"map"` - // The sources of the robot application. + // The Amazon Resource Name (arn) of the world template describing the worlds + // you want to create. // - // Sources is a required field - Sources []*SourceConfig `locationName:"sources" type:"list" required:"true"` + // Template is a required field + Template *string `locationName:"template" min:"1" type:"string" required:"true"` - // A map that contains tag keys and tag values that are attached to the robot - // application. - Tags map[string]*string `locationName:"tags" type:"map"` + // Information about the world count. + // + // WorldCount is a required field + WorldCount *WorldCount `locationName:"worldCount" type:"structure" required:"true"` } // String returns the string representation -func (s CreateRobotApplicationInput) String() string { +func (s CreateWorldGenerationJobInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateRobotApplicationInput) GoString() string { +func (s CreateWorldGenerationJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateRobotApplicationInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateRobotApplicationInput"} - if s.Name == nil { - invalidParams.Add(request.NewErrParamRequired("Name")) - } - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) +func (s *CreateWorldGenerationJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateWorldGenerationJobInput"} + if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) } - if s.RobotSoftwareSuite == nil { - invalidParams.Add(request.NewErrParamRequired("RobotSoftwareSuite")) + if s.Template == nil { + invalidParams.Add(request.NewErrParamRequired("Template")) } - if s.Sources == nil { - invalidParams.Add(request.NewErrParamRequired("Sources")) + if s.Template != nil && len(*s.Template) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Template", 1)) } - if s.Sources != nil { - for i, v := range s.Sources { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Sources", i), err.(request.ErrInvalidParams)) - } - } + if s.WorldCount == nil { + invalidParams.Add(request.NewErrParamRequired("WorldCount")) } if invalidParams.Len() > 0 { @@ -4947,151 +8421,212 @@ func (s *CreateRobotApplicationInput) Validate() error { return nil } -// SetName sets the Name field's value. -func (s *CreateRobotApplicationInput) SetName(v string) *CreateRobotApplicationInput { - s.Name = &v +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *CreateWorldGenerationJobInput) SetClientRequestToken(v string) *CreateWorldGenerationJobInput { + s.ClientRequestToken = &v return s } -// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. -func (s *CreateRobotApplicationInput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *CreateRobotApplicationInput { - s.RobotSoftwareSuite = v +// SetTags sets the Tags field's value. +func (s *CreateWorldGenerationJobInput) SetTags(v map[string]*string) *CreateWorldGenerationJobInput { + s.Tags = v return s } -// SetSources sets the Sources field's value. -func (s *CreateRobotApplicationInput) SetSources(v []*SourceConfig) *CreateRobotApplicationInput { - s.Sources = v +// SetTemplate sets the Template field's value. +func (s *CreateWorldGenerationJobInput) SetTemplate(v string) *CreateWorldGenerationJobInput { + s.Template = &v return s } -// SetTags sets the Tags field's value. -func (s *CreateRobotApplicationInput) SetTags(v map[string]*string) *CreateRobotApplicationInput { - s.Tags = v +// SetWorldCount sets the WorldCount field's value. +func (s *CreateWorldGenerationJobInput) SetWorldCount(v *WorldCount) *CreateWorldGenerationJobInput { + s.WorldCount = v return s } -type CreateRobotApplicationOutput struct { +type CreateWorldGenerationJobOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the robot application. + // The Amazon Resource Name (ARN) of the world generator job. Arn *string `locationName:"arn" min:"1" type:"string"` - // The time, in milliseconds since the epoch, when the robot application was - // last updated. - LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` - - // The name of the robot application. - Name *string `locationName:"name" min:"1" type:"string"` + // Unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"` - // The revision id of the robot application. - RevisionId *string `locationName:"revisionId" min:"1" type:"string"` + // The time, in milliseconds since the epoch, when the world generator job was + // created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The robot software suite (ROS distribution) used by the robot application. - RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` + // The failure code of the world generator job if it failed: + // + // InternalServiceError + // + // Internal service error. + // + // LimitExceeded + // + // The requested resource exceeds the maximum number allowed, or the number + // of concurrent stream requests exceeds the maximum number allowed. + // + // ResourceNotFound + // + // The specified resource could not be found. + // + // RequestThrottled + // + // The request was throttled. + // + // InvalidInput + // + // An input parameter in the request is not valid. + FailureCode *string `locationName:"failureCode" type:"string" enum:"WorldGenerationJobErrorCode"` - // The sources of the robot application. - Sources []*Source `locationName:"sources" type:"list"` + // The status of the world generator job. + // + // Pending + // + // The world generator job request is pending. + // + // Running + // + // The world generator job is running. + // + // Completed + // + // The world generator job completed. + // + // Failed + // + // The world generator job failed. See failureCode for more information. + // + // PartialFailed + // + // Some worlds did not generate. + // + // Canceled + // + // The world generator job was cancelled. + // + // Canceling + // + // The world generator job is being cancelled. + Status *string `locationName:"status" type:"string" enum:"WorldGenerationJobStatus"` - // The list of all tags added to the robot application. + // A map that contains tag keys and tag values that are attached to the world + // generator job. Tags map[string]*string `locationName:"tags" type:"map"` - // The version of the robot application. - Version *string `locationName:"version" min:"1" type:"string"` + // The Amazon Resource Name (arn) of the world template. + Template *string `locationName:"template" min:"1" type:"string"` + + // Information about the world count. + WorldCount *WorldCount `locationName:"worldCount" type:"structure"` } // String returns the string representation -func (s CreateRobotApplicationOutput) String() string { +func (s CreateWorldGenerationJobOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateRobotApplicationOutput) GoString() string { +func (s CreateWorldGenerationJobOutput) GoString() string { return s.String() } // SetArn sets the Arn field's value. -func (s *CreateRobotApplicationOutput) SetArn(v string) *CreateRobotApplicationOutput { +func (s *CreateWorldGenerationJobOutput) SetArn(v string) *CreateWorldGenerationJobOutput { s.Arn = &v return s } -// SetLastUpdatedAt sets the LastUpdatedAt field's value. -func (s *CreateRobotApplicationOutput) SetLastUpdatedAt(v time.Time) *CreateRobotApplicationOutput { - s.LastUpdatedAt = &v +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *CreateWorldGenerationJobOutput) SetClientRequestToken(v string) *CreateWorldGenerationJobOutput { + s.ClientRequestToken = &v return s } -// SetName sets the Name field's value. -func (s *CreateRobotApplicationOutput) SetName(v string) *CreateRobotApplicationOutput { - s.Name = &v +// SetCreatedAt sets the CreatedAt field's value. +func (s *CreateWorldGenerationJobOutput) SetCreatedAt(v time.Time) *CreateWorldGenerationJobOutput { + s.CreatedAt = &v return s } -// SetRevisionId sets the RevisionId field's value. -func (s *CreateRobotApplicationOutput) SetRevisionId(v string) *CreateRobotApplicationOutput { - s.RevisionId = &v +// SetFailureCode sets the FailureCode field's value. +func (s *CreateWorldGenerationJobOutput) SetFailureCode(v string) *CreateWorldGenerationJobOutput { + s.FailureCode = &v return s } -// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. -func (s *CreateRobotApplicationOutput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *CreateRobotApplicationOutput { - s.RobotSoftwareSuite = v +// SetStatus sets the Status field's value. +func (s *CreateWorldGenerationJobOutput) SetStatus(v string) *CreateWorldGenerationJobOutput { + s.Status = &v return s } -// SetSources sets the Sources field's value. -func (s *CreateRobotApplicationOutput) SetSources(v []*Source) *CreateRobotApplicationOutput { - s.Sources = v +// SetTags sets the Tags field's value. +func (s *CreateWorldGenerationJobOutput) SetTags(v map[string]*string) *CreateWorldGenerationJobOutput { + s.Tags = v return s } -// SetTags sets the Tags field's value. -func (s *CreateRobotApplicationOutput) SetTags(v map[string]*string) *CreateRobotApplicationOutput { - s.Tags = v +// SetTemplate sets the Template field's value. +func (s *CreateWorldGenerationJobOutput) SetTemplate(v string) *CreateWorldGenerationJobOutput { + s.Template = &v return s } -// SetVersion sets the Version field's value. -func (s *CreateRobotApplicationOutput) SetVersion(v string) *CreateRobotApplicationOutput { - s.Version = &v +// SetWorldCount sets the WorldCount field's value. +func (s *CreateWorldGenerationJobOutput) SetWorldCount(v *WorldCount) *CreateWorldGenerationJobOutput { + s.WorldCount = v return s } -type CreateRobotApplicationVersionInput struct { +type CreateWorldTemplateInput struct { _ struct{} `type:"structure"` - // The application information for the robot application. - // - // Application is a required field - Application *string `locationName:"application" min:"1" type:"string" required:"true"` + // Unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"` - // The current revision id for the robot application. If you provide a value - // and it matches the latest revision ID, a new version will be created. - CurrentRevisionId *string `locationName:"currentRevisionId" min:"1" type:"string"` + // The name of the world template. + Name *string `locationName:"name" type:"string"` + + // A map that contains tag keys and tag values that are attached to the world + // template. + Tags map[string]*string `locationName:"tags" type:"map"` + + // The world template body. + TemplateBody *string `locationName:"templateBody" min:"1" type:"string"` + + // The location of the world template. + TemplateLocation *TemplateLocation `locationName:"templateLocation" type:"structure"` } // String returns the string representation -func (s CreateRobotApplicationVersionInput) String() string { +func (s CreateWorldTemplateInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateRobotApplicationVersionInput) GoString() string { +func (s CreateWorldTemplateInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateRobotApplicationVersionInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateRobotApplicationVersionInput"} - if s.Application == nil { - invalidParams.Add(request.NewErrParamRequired("Application")) +func (s *CreateWorldTemplateInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateWorldTemplateInput"} + if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) } - if s.Application != nil && len(*s.Application) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Application", 1)) + if s.TemplateBody != nil && len(*s.TemplateBody) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TemplateBody", 1)) } - if s.CurrentRevisionId != nil && len(*s.CurrentRevisionId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("CurrentRevisionId", 1)) + if s.TemplateLocation != nil { + if err := s.TemplateLocation.Validate(); err != nil { + invalidParams.AddNested("TemplateLocation", err.(request.ErrInvalidParams)) + } } if invalidParams.Len() > 0 { @@ -5100,146 +8635,190 @@ func (s *CreateRobotApplicationVersionInput) Validate() error { return nil } -// SetApplication sets the Application field's value. -func (s *CreateRobotApplicationVersionInput) SetApplication(v string) *CreateRobotApplicationVersionInput { - s.Application = &v +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *CreateWorldTemplateInput) SetClientRequestToken(v string) *CreateWorldTemplateInput { + s.ClientRequestToken = &v return s } -// SetCurrentRevisionId sets the CurrentRevisionId field's value. -func (s *CreateRobotApplicationVersionInput) SetCurrentRevisionId(v string) *CreateRobotApplicationVersionInput { - s.CurrentRevisionId = &v +// SetName sets the Name field's value. +func (s *CreateWorldTemplateInput) SetName(v string) *CreateWorldTemplateInput { + s.Name = &v return s } -type CreateRobotApplicationVersionOutput struct { +// SetTags sets the Tags field's value. +func (s *CreateWorldTemplateInput) SetTags(v map[string]*string) *CreateWorldTemplateInput { + s.Tags = v + return s +} + +// SetTemplateBody sets the TemplateBody field's value. +func (s *CreateWorldTemplateInput) SetTemplateBody(v string) *CreateWorldTemplateInput { + s.TemplateBody = &v + return s +} + +// SetTemplateLocation sets the TemplateLocation field's value. +func (s *CreateWorldTemplateInput) SetTemplateLocation(v *TemplateLocation) *CreateWorldTemplateInput { + s.TemplateLocation = v + return s +} + +type CreateWorldTemplateOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the robot application. + // The Amazon Resource Name (ARN) of the world template. Arn *string `locationName:"arn" min:"1" type:"string"` - // The time, in milliseconds since the epoch, when the robot application was - // last updated. - LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` + // Unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"` - // The name of the robot application. - Name *string `locationName:"name" min:"1" type:"string"` + // The time, in milliseconds since the epoch, when the world template was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The revision id of the robot application. - RevisionId *string `locationName:"revisionId" min:"1" type:"string"` + // The name of the world template. + Name *string `locationName:"name" type:"string"` - // The robot software suite (ROS distribution) used by the robot application. - RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` + // A map that contains tag keys and tag values that are attached to the world + // template. + Tags map[string]*string `locationName:"tags" type:"map"` +} - // The sources of the robot application. - Sources []*Source `locationName:"sources" type:"list"` +// String returns the string representation +func (s CreateWorldTemplateOutput) String() string { + return awsutil.Prettify(s) +} - // The version of the robot application. - Version *string `locationName:"version" min:"1" type:"string"` +// GoString returns the string representation +func (s CreateWorldTemplateOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *CreateWorldTemplateOutput) SetArn(v string) *CreateWorldTemplateOutput { + s.Arn = &v + return s +} + +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *CreateWorldTemplateOutput) SetClientRequestToken(v string) *CreateWorldTemplateOutput { + s.ClientRequestToken = &v + return s +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *CreateWorldTemplateOutput) SetCreatedAt(v time.Time) *CreateWorldTemplateOutput { + s.CreatedAt = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateWorldTemplateOutput) SetName(v string) *CreateWorldTemplateOutput { + s.Name = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateWorldTemplateOutput) SetTags(v map[string]*string) *CreateWorldTemplateOutput { + s.Tags = v + return s +} + +// Information about a data source. +type DataSource struct { + _ struct{} `type:"structure"` + + // The name of the data source. + Name *string `locationName:"name" min:"1" type:"string"` + + // The S3 bucket where the data files are located. + S3Bucket *string `locationName:"s3Bucket" min:"3" type:"string"` + + // The list of S3 keys identifying the data source files. + S3Keys []*S3KeyOutput `locationName:"s3Keys" type:"list"` } // String returns the string representation -func (s CreateRobotApplicationVersionOutput) String() string { +func (s DataSource) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateRobotApplicationVersionOutput) GoString() string { +func (s DataSource) GoString() string { return s.String() } -// SetArn sets the Arn field's value. -func (s *CreateRobotApplicationVersionOutput) SetArn(v string) *CreateRobotApplicationVersionOutput { - s.Arn = &v - return s -} - -// SetLastUpdatedAt sets the LastUpdatedAt field's value. -func (s *CreateRobotApplicationVersionOutput) SetLastUpdatedAt(v time.Time) *CreateRobotApplicationVersionOutput { - s.LastUpdatedAt = &v - return s -} - // SetName sets the Name field's value. -func (s *CreateRobotApplicationVersionOutput) SetName(v string) *CreateRobotApplicationVersionOutput { +func (s *DataSource) SetName(v string) *DataSource { s.Name = &v return s } -// SetRevisionId sets the RevisionId field's value. -func (s *CreateRobotApplicationVersionOutput) SetRevisionId(v string) *CreateRobotApplicationVersionOutput { - s.RevisionId = &v - return s -} - -// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. -func (s *CreateRobotApplicationVersionOutput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *CreateRobotApplicationVersionOutput { - s.RobotSoftwareSuite = v - return s -} - -// SetSources sets the Sources field's value. -func (s *CreateRobotApplicationVersionOutput) SetSources(v []*Source) *CreateRobotApplicationVersionOutput { - s.Sources = v +// SetS3Bucket sets the S3Bucket field's value. +func (s *DataSource) SetS3Bucket(v string) *DataSource { + s.S3Bucket = &v return s } -// SetVersion sets the Version field's value. -func (s *CreateRobotApplicationVersionOutput) SetVersion(v string) *CreateRobotApplicationVersionOutput { - s.Version = &v +// SetS3Keys sets the S3Keys field's value. +func (s *DataSource) SetS3Keys(v []*S3KeyOutput) *DataSource { + s.S3Keys = v return s } -type CreateRobotInput struct { +// Information about a data source. +type DataSourceConfig struct { _ struct{} `type:"structure"` - // The target architecture of the robot. + // The name of the data source. // - // Architecture is a required field - Architecture *string `locationName:"architecture" type:"string" required:"true" enum:"Architecture"` + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` - // The Greengrass group id. + // The S3 bucket where the data files are located. // - // GreengrassGroupId is a required field - GreengrassGroupId *string `locationName:"greengrassGroupId" min:"1" type:"string" required:"true"` + // S3Bucket is a required field + S3Bucket *string `locationName:"s3Bucket" min:"3" type:"string" required:"true"` - // The name for the robot. + // The list of S3 keys identifying the data source files. // - // Name is a required field - Name *string `locationName:"name" min:"1" type:"string" required:"true"` - - // A map that contains tag keys and tag values that are attached to the robot. - Tags map[string]*string `locationName:"tags" type:"map"` + // S3Keys is a required field + S3Keys []*string `locationName:"s3Keys" min:"1" type:"list" required:"true"` } // String returns the string representation -func (s CreateRobotInput) String() string { +func (s DataSourceConfig) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateRobotInput) GoString() string { +func (s DataSourceConfig) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateRobotInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateRobotInput"} - if s.Architecture == nil { - invalidParams.Add(request.NewErrParamRequired("Architecture")) - } - if s.GreengrassGroupId == nil { - invalidParams.Add(request.NewErrParamRequired("GreengrassGroupId")) - } - if s.GreengrassGroupId != nil && len(*s.GreengrassGroupId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("GreengrassGroupId", 1)) - } +func (s *DataSourceConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DataSourceConfig"} if s.Name == nil { invalidParams.Add(request.NewErrParamRequired("Name")) } if s.Name != nil && len(*s.Name) < 1 { invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } + if s.S3Bucket == nil { + invalidParams.Add(request.NewErrParamRequired("S3Bucket")) + } + if s.S3Bucket != nil && len(*s.S3Bucket) < 3 { + invalidParams.Add(request.NewErrParamMinLen("S3Bucket", 3)) + } + if s.S3Keys == nil { + invalidParams.Add(request.NewErrParamRequired("S3Keys")) + } + if s.S3Keys != nil && len(s.S3Keys) < 1 { + invalidParams.Add(request.NewErrParamMinLen("S3Keys", 1)) + } if invalidParams.Len() > 0 { return invalidParams @@ -5247,172 +8826,112 @@ func (s *CreateRobotInput) Validate() error { return nil } -// SetArchitecture sets the Architecture field's value. -func (s *CreateRobotInput) SetArchitecture(v string) *CreateRobotInput { - s.Architecture = &v - return s -} - -// SetGreengrassGroupId sets the GreengrassGroupId field's value. -func (s *CreateRobotInput) SetGreengrassGroupId(v string) *CreateRobotInput { - s.GreengrassGroupId = &v +// SetName sets the Name field's value. +func (s *DataSourceConfig) SetName(v string) *DataSourceConfig { + s.Name = &v return s } -// SetName sets the Name field's value. -func (s *CreateRobotInput) SetName(v string) *CreateRobotInput { - s.Name = &v +// SetS3Bucket sets the S3Bucket field's value. +func (s *DataSourceConfig) SetS3Bucket(v string) *DataSourceConfig { + s.S3Bucket = &v return s } -// SetTags sets the Tags field's value. -func (s *CreateRobotInput) SetTags(v map[string]*string) *CreateRobotInput { - s.Tags = v +// SetS3Keys sets the S3Keys field's value. +func (s *DataSourceConfig) SetS3Keys(v []*string) *DataSourceConfig { + s.S3Keys = v return s } -type CreateRobotOutput struct { +type DeleteFleetInput struct { _ struct{} `type:"structure"` - // The target architecture of the robot. - Architecture *string `locationName:"architecture" type:"string" enum:"Architecture"` - - // The Amazon Resource Name (ARN) of the robot. - Arn *string `locationName:"arn" min:"1" type:"string"` - - // The time, in milliseconds since the epoch, when the robot was created. - CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - - // The Amazon Resource Name (ARN) of the Greengrass group associated with the - // robot. - GreengrassGroupId *string `locationName:"greengrassGroupId" min:"1" type:"string"` - - // The name of the robot. - Name *string `locationName:"name" min:"1" type:"string"` - - // The list of all tags added to the robot. - Tags map[string]*string `locationName:"tags" type:"map"` + // The Amazon Resource Name (ARN) of the fleet. + // + // Fleet is a required field + Fleet *string `locationName:"fleet" min:"1" type:"string" required:"true"` } // String returns the string representation -func (s CreateRobotOutput) String() string { +func (s DeleteFleetInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateRobotOutput) GoString() string { +func (s DeleteFleetInput) GoString() string { return s.String() } -// SetArchitecture sets the Architecture field's value. -func (s *CreateRobotOutput) SetArchitecture(v string) *CreateRobotOutput { - s.Architecture = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteFleetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteFleetInput"} + if s.Fleet == nil { + invalidParams.Add(request.NewErrParamRequired("Fleet")) + } + if s.Fleet != nil && len(*s.Fleet) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Fleet", 1)) + } -// SetArn sets the Arn field's value. -func (s *CreateRobotOutput) SetArn(v string) *CreateRobotOutput { - s.Arn = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetCreatedAt sets the CreatedAt field's value. -func (s *CreateRobotOutput) SetCreatedAt(v time.Time) *CreateRobotOutput { - s.CreatedAt = &v +// SetFleet sets the Fleet field's value. +func (s *DeleteFleetInput) SetFleet(v string) *DeleteFleetInput { + s.Fleet = &v return s } -// SetGreengrassGroupId sets the GreengrassGroupId field's value. -func (s *CreateRobotOutput) SetGreengrassGroupId(v string) *CreateRobotOutput { - s.GreengrassGroupId = &v - return s +type DeleteFleetOutput struct { + _ struct{} `type:"structure"` } -// SetName sets the Name field's value. -func (s *CreateRobotOutput) SetName(v string) *CreateRobotOutput { - s.Name = &v - return s +// String returns the string representation +func (s DeleteFleetOutput) String() string { + return awsutil.Prettify(s) } -// SetTags sets the Tags field's value. -func (s *CreateRobotOutput) SetTags(v map[string]*string) *CreateRobotOutput { - s.Tags = v - return s +// GoString returns the string representation +func (s DeleteFleetOutput) GoString() string { + return s.String() } -type CreateSimulationApplicationInput struct { +type DeleteRobotApplicationInput struct { _ struct{} `type:"structure"` - // The name of the simulation application. - // - // Name is a required field - Name *string `locationName:"name" min:"1" type:"string" required:"true"` - - // The rendering engine for the simulation application. - RenderingEngine *RenderingEngine `locationName:"renderingEngine" type:"structure"` - - // The robot software suite (ROS distribution) used by the simulation application. - // - // RobotSoftwareSuite is a required field - RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure" required:"true"` - - // The simulation software suite used by the simulation application. - // - // SimulationSoftwareSuite is a required field - SimulationSoftwareSuite *SimulationSoftwareSuite `locationName:"simulationSoftwareSuite" type:"structure" required:"true"` - - // The sources of the simulation application. + // The Amazon Resource Name (ARN) of the the robot application. // - // Sources is a required field - Sources []*SourceConfig `locationName:"sources" type:"list" required:"true"` + // Application is a required field + Application *string `locationName:"application" min:"1" type:"string" required:"true"` - // A map that contains tag keys and tag values that are attached to the simulation - // application. - Tags map[string]*string `locationName:"tags" type:"map"` + // The version of the robot application to delete. + ApplicationVersion *string `locationName:"applicationVersion" min:"1" type:"string"` } // String returns the string representation -func (s CreateSimulationApplicationInput) String() string { +func (s DeleteRobotApplicationInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateSimulationApplicationInput) GoString() string { +func (s DeleteRobotApplicationInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateSimulationApplicationInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateSimulationApplicationInput"} - if s.Name == nil { - invalidParams.Add(request.NewErrParamRequired("Name")) - } - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) - } - if s.RobotSoftwareSuite == nil { - invalidParams.Add(request.NewErrParamRequired("RobotSoftwareSuite")) - } - if s.SimulationSoftwareSuite == nil { - invalidParams.Add(request.NewErrParamRequired("SimulationSoftwareSuite")) - } - if s.Sources == nil { - invalidParams.Add(request.NewErrParamRequired("Sources")) +func (s *DeleteRobotApplicationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteRobotApplicationInput"} + if s.Application == nil { + invalidParams.Add(request.NewErrParamRequired("Application")) } - if s.RenderingEngine != nil { - if err := s.RenderingEngine.Validate(); err != nil { - invalidParams.AddNested("RenderingEngine", err.(request.ErrInvalidParams)) - } + if s.Application != nil && len(*s.Application) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Application", 1)) } - if s.Sources != nil { - for i, v := range s.Sources { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Sources", i), err.(request.ErrInvalidParams)) - } - } + if s.ApplicationVersion != nil && len(*s.ApplicationVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationVersion", 1)) } if invalidParams.Len() > 0 { @@ -5421,181 +8940,120 @@ func (s *CreateSimulationApplicationInput) Validate() error { return nil } -// SetName sets the Name field's value. -func (s *CreateSimulationApplicationInput) SetName(v string) *CreateSimulationApplicationInput { - s.Name = &v - return s -} - -// SetRenderingEngine sets the RenderingEngine field's value. -func (s *CreateSimulationApplicationInput) SetRenderingEngine(v *RenderingEngine) *CreateSimulationApplicationInput { - s.RenderingEngine = v - return s -} - -// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. -func (s *CreateSimulationApplicationInput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *CreateSimulationApplicationInput { - s.RobotSoftwareSuite = v - return s -} - -// SetSimulationSoftwareSuite sets the SimulationSoftwareSuite field's value. -func (s *CreateSimulationApplicationInput) SetSimulationSoftwareSuite(v *SimulationSoftwareSuite) *CreateSimulationApplicationInput { - s.SimulationSoftwareSuite = v - return s -} - -// SetSources sets the Sources field's value. -func (s *CreateSimulationApplicationInput) SetSources(v []*SourceConfig) *CreateSimulationApplicationInput { - s.Sources = v +// SetApplication sets the Application field's value. +func (s *DeleteRobotApplicationInput) SetApplication(v string) *DeleteRobotApplicationInput { + s.Application = &v return s } -// SetTags sets the Tags field's value. -func (s *CreateSimulationApplicationInput) SetTags(v map[string]*string) *CreateSimulationApplicationInput { - s.Tags = v +// SetApplicationVersion sets the ApplicationVersion field's value. +func (s *DeleteRobotApplicationInput) SetApplicationVersion(v string) *DeleteRobotApplicationInput { + s.ApplicationVersion = &v return s } -type CreateSimulationApplicationOutput struct { +type DeleteRobotApplicationOutput struct { _ struct{} `type:"structure"` - - // The Amazon Resource Name (ARN) of the simulation application. - Arn *string `locationName:"arn" min:"1" type:"string"` - - // The time, in milliseconds since the epoch, when the simulation application - // was last updated. - LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` - - // The name of the simulation application. - Name *string `locationName:"name" min:"1" type:"string"` - - // The rendering engine for the simulation application. - RenderingEngine *RenderingEngine `locationName:"renderingEngine" type:"structure"` - - // The revision id of the simulation application. - RevisionId *string `locationName:"revisionId" min:"1" type:"string"` - - // Information about the robot software suite (ROS distribution). - RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` - - // The simulation software suite used by the simulation application. - SimulationSoftwareSuite *SimulationSoftwareSuite `locationName:"simulationSoftwareSuite" type:"structure"` - - // The sources of the simulation application. - Sources []*Source `locationName:"sources" type:"list"` - - // The list of all tags added to the simulation application. - Tags map[string]*string `locationName:"tags" type:"map"` - - // The version of the simulation application. - Version *string `locationName:"version" min:"1" type:"string"` } // String returns the string representation -func (s CreateSimulationApplicationOutput) String() string { +func (s DeleteRobotApplicationOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateSimulationApplicationOutput) GoString() string { +func (s DeleteRobotApplicationOutput) GoString() string { return s.String() } -// SetArn sets the Arn field's value. -func (s *CreateSimulationApplicationOutput) SetArn(v string) *CreateSimulationApplicationOutput { - s.Arn = &v - return s -} +type DeleteRobotInput struct { + _ struct{} `type:"structure"` -// SetLastUpdatedAt sets the LastUpdatedAt field's value. -func (s *CreateSimulationApplicationOutput) SetLastUpdatedAt(v time.Time) *CreateSimulationApplicationOutput { - s.LastUpdatedAt = &v - return s + // The Amazon Resource Name (ARN) of the robot. + // + // Robot is a required field + Robot *string `locationName:"robot" min:"1" type:"string" required:"true"` } -// SetName sets the Name field's value. -func (s *CreateSimulationApplicationOutput) SetName(v string) *CreateSimulationApplicationOutput { - s.Name = &v - return s +// String returns the string representation +func (s DeleteRobotInput) String() string { + return awsutil.Prettify(s) } -// SetRenderingEngine sets the RenderingEngine field's value. -func (s *CreateSimulationApplicationOutput) SetRenderingEngine(v *RenderingEngine) *CreateSimulationApplicationOutput { - s.RenderingEngine = v - return s +// GoString returns the string representation +func (s DeleteRobotInput) GoString() string { + return s.String() } -// SetRevisionId sets the RevisionId field's value. -func (s *CreateSimulationApplicationOutput) SetRevisionId(v string) *CreateSimulationApplicationOutput { - s.RevisionId = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteRobotInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteRobotInput"} + if s.Robot == nil { + invalidParams.Add(request.NewErrParamRequired("Robot")) + } + if s.Robot != nil && len(*s.Robot) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Robot", 1)) + } -// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. -func (s *CreateSimulationApplicationOutput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *CreateSimulationApplicationOutput { - s.RobotSoftwareSuite = v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetSimulationSoftwareSuite sets the SimulationSoftwareSuite field's value. -func (s *CreateSimulationApplicationOutput) SetSimulationSoftwareSuite(v *SimulationSoftwareSuite) *CreateSimulationApplicationOutput { - s.SimulationSoftwareSuite = v +// SetRobot sets the Robot field's value. +func (s *DeleteRobotInput) SetRobot(v string) *DeleteRobotInput { + s.Robot = &v return s } -// SetSources sets the Sources field's value. -func (s *CreateSimulationApplicationOutput) SetSources(v []*Source) *CreateSimulationApplicationOutput { - s.Sources = v - return s +type DeleteRobotOutput struct { + _ struct{} `type:"structure"` } -// SetTags sets the Tags field's value. -func (s *CreateSimulationApplicationOutput) SetTags(v map[string]*string) *CreateSimulationApplicationOutput { - s.Tags = v - return s +// String returns the string representation +func (s DeleteRobotOutput) String() string { + return awsutil.Prettify(s) } -// SetVersion sets the Version field's value. -func (s *CreateSimulationApplicationOutput) SetVersion(v string) *CreateSimulationApplicationOutput { - s.Version = &v - return s +// GoString returns the string representation +func (s DeleteRobotOutput) GoString() string { + return s.String() } -type CreateSimulationApplicationVersionInput struct { +type DeleteSimulationApplicationInput struct { _ struct{} `type:"structure"` - // The application information for the simulation application. + // The application information for the simulation application to delete. // // Application is a required field Application *string `locationName:"application" min:"1" type:"string" required:"true"` - // The current revision id for the simulation application. If you provide a - // value and it matches the latest revision ID, a new version will be created. - CurrentRevisionId *string `locationName:"currentRevisionId" min:"1" type:"string"` + // The version of the simulation application to delete. + ApplicationVersion *string `locationName:"applicationVersion" min:"1" type:"string"` } // String returns the string representation -func (s CreateSimulationApplicationVersionInput) String() string { +func (s DeleteSimulationApplicationInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateSimulationApplicationVersionInput) GoString() string { +func (s DeleteSimulationApplicationInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateSimulationApplicationVersionInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateSimulationApplicationVersionInput"} +func (s *DeleteSimulationApplicationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteSimulationApplicationInput"} if s.Application == nil { invalidParams.Add(request.NewErrParamRequired("Application")) } if s.Application != nil && len(*s.Application) < 1 { invalidParams.Add(request.NewErrParamMinLen("Application", 1)) } - if s.CurrentRevisionId != nil && len(*s.CurrentRevisionId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("CurrentRevisionId", 1)) + if s.ApplicationVersion != nil && len(*s.ApplicationVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationVersion", 1)) } if invalidParams.Len() > 0 { @@ -5605,260 +9063,205 @@ func (s *CreateSimulationApplicationVersionInput) Validate() error { } // SetApplication sets the Application field's value. -func (s *CreateSimulationApplicationVersionInput) SetApplication(v string) *CreateSimulationApplicationVersionInput { +func (s *DeleteSimulationApplicationInput) SetApplication(v string) *DeleteSimulationApplicationInput { s.Application = &v return s } -// SetCurrentRevisionId sets the CurrentRevisionId field's value. -func (s *CreateSimulationApplicationVersionInput) SetCurrentRevisionId(v string) *CreateSimulationApplicationVersionInput { - s.CurrentRevisionId = &v +// SetApplicationVersion sets the ApplicationVersion field's value. +func (s *DeleteSimulationApplicationInput) SetApplicationVersion(v string) *DeleteSimulationApplicationInput { + s.ApplicationVersion = &v return s } -type CreateSimulationApplicationVersionOutput struct { +type DeleteSimulationApplicationOutput struct { _ struct{} `type:"structure"` - - // The Amazon Resource Name (ARN) of the simulation application. - Arn *string `locationName:"arn" min:"1" type:"string"` - - // The time, in milliseconds since the epoch, when the simulation application - // was last updated. - LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` - - // The name of the simulation application. - Name *string `locationName:"name" min:"1" type:"string"` - - // The rendering engine for the simulation application. - RenderingEngine *RenderingEngine `locationName:"renderingEngine" type:"structure"` - - // The revision ID of the simulation application. - RevisionId *string `locationName:"revisionId" min:"1" type:"string"` - - // Information about the robot software suite (ROS distribution). - RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` - - // The simulation software suite used by the simulation application. - SimulationSoftwareSuite *SimulationSoftwareSuite `locationName:"simulationSoftwareSuite" type:"structure"` - - // The sources of the simulation application. - Sources []*Source `locationName:"sources" type:"list"` - - // The version of the simulation application. - Version *string `locationName:"version" min:"1" type:"string"` } // String returns the string representation -func (s CreateSimulationApplicationVersionOutput) String() string { +func (s DeleteSimulationApplicationOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateSimulationApplicationVersionOutput) GoString() string { +func (s DeleteSimulationApplicationOutput) GoString() string { return s.String() } -// SetArn sets the Arn field's value. -func (s *CreateSimulationApplicationVersionOutput) SetArn(v string) *CreateSimulationApplicationVersionOutput { - s.Arn = &v - return s -} +type DeleteWorldTemplateInput struct { + _ struct{} `type:"structure"` -// SetLastUpdatedAt sets the LastUpdatedAt field's value. -func (s *CreateSimulationApplicationVersionOutput) SetLastUpdatedAt(v time.Time) *CreateSimulationApplicationVersionOutput { - s.LastUpdatedAt = &v - return s + // The Amazon Resource Name (arn) of the world template you want to delete. + // + // Template is a required field + Template *string `locationName:"template" min:"1" type:"string" required:"true"` } -// SetName sets the Name field's value. -func (s *CreateSimulationApplicationVersionOutput) SetName(v string) *CreateSimulationApplicationVersionOutput { - s.Name = &v - return s +// String returns the string representation +func (s DeleteWorldTemplateInput) String() string { + return awsutil.Prettify(s) } -// SetRenderingEngine sets the RenderingEngine field's value. -func (s *CreateSimulationApplicationVersionOutput) SetRenderingEngine(v *RenderingEngine) *CreateSimulationApplicationVersionOutput { - s.RenderingEngine = v - return s +// GoString returns the string representation +func (s DeleteWorldTemplateInput) GoString() string { + return s.String() } -// SetRevisionId sets the RevisionId field's value. -func (s *CreateSimulationApplicationVersionOutput) SetRevisionId(v string) *CreateSimulationApplicationVersionOutput { - s.RevisionId = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteWorldTemplateInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteWorldTemplateInput"} + if s.Template == nil { + invalidParams.Add(request.NewErrParamRequired("Template")) + } + if s.Template != nil && len(*s.Template) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Template", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. -func (s *CreateSimulationApplicationVersionOutput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *CreateSimulationApplicationVersionOutput { - s.RobotSoftwareSuite = v +// SetTemplate sets the Template field's value. +func (s *DeleteWorldTemplateInput) SetTemplate(v string) *DeleteWorldTemplateInput { + s.Template = &v return s } -// SetSimulationSoftwareSuite sets the SimulationSoftwareSuite field's value. -func (s *CreateSimulationApplicationVersionOutput) SetSimulationSoftwareSuite(v *SimulationSoftwareSuite) *CreateSimulationApplicationVersionOutput { - s.SimulationSoftwareSuite = v - return s +type DeleteWorldTemplateOutput struct { + _ struct{} `type:"structure"` } -// SetSources sets the Sources field's value. -func (s *CreateSimulationApplicationVersionOutput) SetSources(v []*Source) *CreateSimulationApplicationVersionOutput { - s.Sources = v - return s +// String returns the string representation +func (s DeleteWorldTemplateOutput) String() string { + return awsutil.Prettify(s) } -// SetVersion sets the Version field's value. -func (s *CreateSimulationApplicationVersionOutput) SetVersion(v string) *CreateSimulationApplicationVersionOutput { - s.Version = &v - return s +// GoString returns the string representation +func (s DeleteWorldTemplateOutput) GoString() string { + return s.String() } -type CreateSimulationJobInput struct { +// Information about a deployment application configuration. +type DeploymentApplicationConfig struct { _ struct{} `type:"structure"` - // Unique, case-sensitive identifier that you provide to ensure the idempotency - // of the request. - ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string" idempotencyToken:"true"` - - // Compute information for the simulation job. - Compute *Compute `locationName:"compute" type:"structure"` - - // Specify data sources to mount read-only files from S3 into your simulation. - // These files are available under /opt/robomaker/datasources/data_source_name. - // - // There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig - // objects. - DataSources []*DataSourceConfig `locationName:"dataSources" min:"1" type:"list"` - - // The failure behavior the simulation job. - // - // Continue - // - // Restart the simulation job in the same host instance. - // - // Fail + // The Amazon Resource Name (ARN) of the robot application. // - // Stop the simulation job and terminate the instance. - FailureBehavior *string `locationName:"failureBehavior" type:"string" enum:"FailureBehavior"` + // Application is a required field + Application *string `locationName:"application" min:"1" type:"string" required:"true"` - // The IAM role name that allows the simulation instance to call the AWS APIs - // that are specified in its associated policies on your behalf. This is how - // credentials are passed in to your simulation job. + // The version of the application. // - // IamRole is a required field - IamRole *string `locationName:"iamRole" min:"1" type:"string" required:"true"` - - // The logging configuration. - LoggingConfig *LoggingConfig `locationName:"loggingConfig" type:"structure"` + // ApplicationVersion is a required field + ApplicationVersion *string `locationName:"applicationVersion" min:"1" type:"string" required:"true"` - // The maximum simulation job duration in seconds (up to 14 days or 1,209,600 - // seconds. When maxJobDurationInSeconds is reached, the simulation job will - // status will transition to Completed. + // The launch configuration. // - // MaxJobDurationInSeconds is a required field - MaxJobDurationInSeconds *int64 `locationName:"maxJobDurationInSeconds" type:"long" required:"true"` - - // Location for output files generated by the simulation job. - OutputLocation *OutputLocation `locationName:"outputLocation" type:"structure"` - - // The robot application to use in the simulation job. - RobotApplications []*RobotApplicationConfig `locationName:"robotApplications" min:"1" type:"list"` - - // The simulation application to use in the simulation job. - SimulationApplications []*SimulationApplicationConfig `locationName:"simulationApplications" min:"1" type:"list"` - - // A map that contains tag keys and tag values that are attached to the simulation - // job. - Tags map[string]*string `locationName:"tags" type:"map"` - - // If your simulation job accesses resources in a VPC, you provide this parameter - // identifying the list of security group IDs and subnet IDs. These must belong - // to the same VPC. You must provide at least one security group and one subnet - // ID. - VpcConfig *VPCConfig `locationName:"vpcConfig" type:"structure"` + // LaunchConfig is a required field + LaunchConfig *DeploymentLaunchConfig `locationName:"launchConfig" type:"structure" required:"true"` } // String returns the string representation -func (s CreateSimulationJobInput) String() string { +func (s DeploymentApplicationConfig) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateSimulationJobInput) GoString() string { +func (s DeploymentApplicationConfig) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateSimulationJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateSimulationJobInput"} - if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 1)) - } - if s.DataSources != nil && len(s.DataSources) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DataSources", 1)) - } - if s.IamRole == nil { - invalidParams.Add(request.NewErrParamRequired("IamRole")) - } - if s.IamRole != nil && len(*s.IamRole) < 1 { - invalidParams.Add(request.NewErrParamMinLen("IamRole", 1)) - } - if s.MaxJobDurationInSeconds == nil { - invalidParams.Add(request.NewErrParamRequired("MaxJobDurationInSeconds")) +func (s *DeploymentApplicationConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeploymentApplicationConfig"} + if s.Application == nil { + invalidParams.Add(request.NewErrParamRequired("Application")) } - if s.RobotApplications != nil && len(s.RobotApplications) < 1 { - invalidParams.Add(request.NewErrParamMinLen("RobotApplications", 1)) + if s.Application != nil && len(*s.Application) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Application", 1)) } - if s.SimulationApplications != nil && len(s.SimulationApplications) < 1 { - invalidParams.Add(request.NewErrParamMinLen("SimulationApplications", 1)) + if s.ApplicationVersion == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationVersion")) } - if s.Compute != nil { - if err := s.Compute.Validate(); err != nil { - invalidParams.AddNested("Compute", err.(request.ErrInvalidParams)) - } + if s.ApplicationVersion != nil && len(*s.ApplicationVersion) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationVersion", 1)) } - if s.DataSources != nil { - for i, v := range s.DataSources { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "DataSources", i), err.(request.ErrInvalidParams)) - } - } + if s.LaunchConfig == nil { + invalidParams.Add(request.NewErrParamRequired("LaunchConfig")) } - if s.LoggingConfig != nil { - if err := s.LoggingConfig.Validate(); err != nil { - invalidParams.AddNested("LoggingConfig", err.(request.ErrInvalidParams)) + if s.LaunchConfig != nil { + if err := s.LaunchConfig.Validate(); err != nil { + invalidParams.AddNested("LaunchConfig", err.(request.ErrInvalidParams)) } } - if s.OutputLocation != nil { - if err := s.OutputLocation.Validate(); err != nil { - invalidParams.AddNested("OutputLocation", err.(request.ErrInvalidParams)) - } + + if invalidParams.Len() > 0 { + return invalidParams } - if s.RobotApplications != nil { - for i, v := range s.RobotApplications { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "RobotApplications", i), err.(request.ErrInvalidParams)) - } - } + return nil +} + +// SetApplication sets the Application field's value. +func (s *DeploymentApplicationConfig) SetApplication(v string) *DeploymentApplicationConfig { + s.Application = &v + return s +} + +// SetApplicationVersion sets the ApplicationVersion field's value. +func (s *DeploymentApplicationConfig) SetApplicationVersion(v string) *DeploymentApplicationConfig { + s.ApplicationVersion = &v + return s +} + +// SetLaunchConfig sets the LaunchConfig field's value. +func (s *DeploymentApplicationConfig) SetLaunchConfig(v *DeploymentLaunchConfig) *DeploymentApplicationConfig { + s.LaunchConfig = v + return s +} + +// Information about a deployment configuration. +type DeploymentConfig struct { + _ struct{} `type:"structure"` + + // The percentage of robots receiving the deployment at the same time. + ConcurrentDeploymentPercentage *int64 `locationName:"concurrentDeploymentPercentage" min:"1" type:"integer"` + + // The download condition file. + DownloadConditionFile *S3Object `locationName:"downloadConditionFile" type:"structure"` + + // The percentage of deployments that need to fail before stopping deployment. + FailureThresholdPercentage *int64 `locationName:"failureThresholdPercentage" min:"1" type:"integer"` + + // The amount of time, in seconds, to wait for deployment to a single robot + // to complete. Choose a time between 1 minute and 7 days. The default is 5 + // hours. + RobotDeploymentTimeoutInSeconds *int64 `locationName:"robotDeploymentTimeoutInSeconds" type:"long"` +} + +// String returns the string representation +func (s DeploymentConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeploymentConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeploymentConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeploymentConfig"} + if s.ConcurrentDeploymentPercentage != nil && *s.ConcurrentDeploymentPercentage < 1 { + invalidParams.Add(request.NewErrParamMinValue("ConcurrentDeploymentPercentage", 1)) } - if s.SimulationApplications != nil { - for i, v := range s.SimulationApplications { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "SimulationApplications", i), err.(request.ErrInvalidParams)) - } - } + if s.FailureThresholdPercentage != nil && *s.FailureThresholdPercentage < 1 { + invalidParams.Add(request.NewErrParamMinValue("FailureThresholdPercentage", 1)) } - if s.VpcConfig != nil { - if err := s.VpcConfig.Validate(); err != nil { - invalidParams.AddNested("VpcConfig", err.(request.ErrInvalidParams)) + if s.DownloadConditionFile != nil { + if err := s.DownloadConditionFile.Validate(); err != nil { + invalidParams.AddNested("DownloadConditionFile", err.(request.ErrInvalidParams)) } } @@ -5868,435 +9271,448 @@ func (s *CreateSimulationJobInput) Validate() error { return nil } -// SetClientRequestToken sets the ClientRequestToken field's value. -func (s *CreateSimulationJobInput) SetClientRequestToken(v string) *CreateSimulationJobInput { - s.ClientRequestToken = &v +// SetConcurrentDeploymentPercentage sets the ConcurrentDeploymentPercentage field's value. +func (s *DeploymentConfig) SetConcurrentDeploymentPercentage(v int64) *DeploymentConfig { + s.ConcurrentDeploymentPercentage = &v + return s +} + +// SetDownloadConditionFile sets the DownloadConditionFile field's value. +func (s *DeploymentConfig) SetDownloadConditionFile(v *S3Object) *DeploymentConfig { + s.DownloadConditionFile = v + return s +} + +// SetFailureThresholdPercentage sets the FailureThresholdPercentage field's value. +func (s *DeploymentConfig) SetFailureThresholdPercentage(v int64) *DeploymentConfig { + s.FailureThresholdPercentage = &v + return s +} + +// SetRobotDeploymentTimeoutInSeconds sets the RobotDeploymentTimeoutInSeconds field's value. +func (s *DeploymentConfig) SetRobotDeploymentTimeoutInSeconds(v int64) *DeploymentConfig { + s.RobotDeploymentTimeoutInSeconds = &v return s } -// SetCompute sets the Compute field's value. -func (s *CreateSimulationJobInput) SetCompute(v *Compute) *CreateSimulationJobInput { - s.Compute = v - return s +// Information about a deployment job. +type DeploymentJob struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the deployment job. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // The time, in milliseconds since the epoch, when the deployment job was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + + // The deployment application configuration. + DeploymentApplicationConfigs []*DeploymentApplicationConfig `locationName:"deploymentApplicationConfigs" min:"1" type:"list"` + + // The deployment configuration. + DeploymentConfig *DeploymentConfig `locationName:"deploymentConfig" type:"structure"` + + // The deployment job failure code. + FailureCode *string `locationName:"failureCode" type:"string" enum:"DeploymentJobErrorCode"` + + // A short description of the reason why the deployment job failed. + FailureReason *string `locationName:"failureReason" type:"string"` + + // The Amazon Resource Name (ARN) of the fleet. + Fleet *string `locationName:"fleet" min:"1" type:"string"` + + // The status of the deployment job. + Status *string `locationName:"status" type:"string" enum:"DeploymentStatus"` } -// SetDataSources sets the DataSources field's value. -func (s *CreateSimulationJobInput) SetDataSources(v []*DataSourceConfig) *CreateSimulationJobInput { - s.DataSources = v - return s +// String returns the string representation +func (s DeploymentJob) String() string { + return awsutil.Prettify(s) } -// SetFailureBehavior sets the FailureBehavior field's value. -func (s *CreateSimulationJobInput) SetFailureBehavior(v string) *CreateSimulationJobInput { - s.FailureBehavior = &v - return s +// GoString returns the string representation +func (s DeploymentJob) GoString() string { + return s.String() } -// SetIamRole sets the IamRole field's value. -func (s *CreateSimulationJobInput) SetIamRole(v string) *CreateSimulationJobInput { - s.IamRole = &v +// SetArn sets the Arn field's value. +func (s *DeploymentJob) SetArn(v string) *DeploymentJob { + s.Arn = &v return s } -// SetLoggingConfig sets the LoggingConfig field's value. -func (s *CreateSimulationJobInput) SetLoggingConfig(v *LoggingConfig) *CreateSimulationJobInput { - s.LoggingConfig = v +// SetCreatedAt sets the CreatedAt field's value. +func (s *DeploymentJob) SetCreatedAt(v time.Time) *DeploymentJob { + s.CreatedAt = &v return s } -// SetMaxJobDurationInSeconds sets the MaxJobDurationInSeconds field's value. -func (s *CreateSimulationJobInput) SetMaxJobDurationInSeconds(v int64) *CreateSimulationJobInput { - s.MaxJobDurationInSeconds = &v +// SetDeploymentApplicationConfigs sets the DeploymentApplicationConfigs field's value. +func (s *DeploymentJob) SetDeploymentApplicationConfigs(v []*DeploymentApplicationConfig) *DeploymentJob { + s.DeploymentApplicationConfigs = v return s } -// SetOutputLocation sets the OutputLocation field's value. -func (s *CreateSimulationJobInput) SetOutputLocation(v *OutputLocation) *CreateSimulationJobInput { - s.OutputLocation = v +// SetDeploymentConfig sets the DeploymentConfig field's value. +func (s *DeploymentJob) SetDeploymentConfig(v *DeploymentConfig) *DeploymentJob { + s.DeploymentConfig = v return s } -// SetRobotApplications sets the RobotApplications field's value. -func (s *CreateSimulationJobInput) SetRobotApplications(v []*RobotApplicationConfig) *CreateSimulationJobInput { - s.RobotApplications = v +// SetFailureCode sets the FailureCode field's value. +func (s *DeploymentJob) SetFailureCode(v string) *DeploymentJob { + s.FailureCode = &v return s } -// SetSimulationApplications sets the SimulationApplications field's value. -func (s *CreateSimulationJobInput) SetSimulationApplications(v []*SimulationApplicationConfig) *CreateSimulationJobInput { - s.SimulationApplications = v +// SetFailureReason sets the FailureReason field's value. +func (s *DeploymentJob) SetFailureReason(v string) *DeploymentJob { + s.FailureReason = &v return s } -// SetTags sets the Tags field's value. -func (s *CreateSimulationJobInput) SetTags(v map[string]*string) *CreateSimulationJobInput { - s.Tags = v +// SetFleet sets the Fleet field's value. +func (s *DeploymentJob) SetFleet(v string) *DeploymentJob { + s.Fleet = &v return s } -// SetVpcConfig sets the VpcConfig field's value. -func (s *CreateSimulationJobInput) SetVpcConfig(v *VPCConfig) *CreateSimulationJobInput { - s.VpcConfig = v +// SetStatus sets the Status field's value. +func (s *DeploymentJob) SetStatus(v string) *DeploymentJob { + s.Status = &v return s } -type CreateSimulationJobOutput struct { +// Configuration information for a deployment launch. +type DeploymentLaunchConfig struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the simulation job. - Arn *string `locationName:"arn" min:"1" type:"string"` - - // Unique, case-sensitive identifier that you provide to ensure the idempotency - // of the request. - ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"` - - // Compute information for the simulation job. - Compute *ComputeResponse `locationName:"compute" type:"structure"` - - // The data sources for the simulation job. - DataSources []*DataSource `locationName:"dataSources" type:"list"` - - // the failure behavior for the simulation job. - FailureBehavior *string `locationName:"failureBehavior" type:"string" enum:"FailureBehavior"` + // An array of key/value pairs specifying environment variables for the robot + // application + EnvironmentVariables map[string]*string `locationName:"environmentVariables" type:"map"` - // The failure code of the simulation job if it failed: - // - // InternalServiceError - // - // Internal service error. - // - // RobotApplicationCrash - // - // Robot application exited abnormally. - // - // SimulationApplicationCrash - // - // Simulation application exited abnormally. - // - // BadPermissionsRobotApplication - // - // Robot application bundle could not be downloaded. - // - // BadPermissionsSimulationApplication - // - // Simulation application bundle could not be downloaded. - // - // BadPermissionsS3Output - // - // Unable to publish outputs to customer-provided S3 bucket. - // - // BadPermissionsCloudwatchLogs - // - // Unable to publish logs to customer-provided CloudWatch Logs resource. - // - // SubnetIpLimitExceeded - // - // Subnet IP limit exceeded. - // - // ENILimitExceeded - // - // ENI limit exceeded. - // - // BadPermissionsUserCredentials - // - // Unable to use the Role provided. - // - // InvalidBundleRobotApplication - // - // Robot bundle cannot be extracted (invalid format, bundling error, or other - // issue). - // - // InvalidBundleSimulationApplication - // - // Simulation bundle cannot be extracted (invalid format, bundling error, or - // other issue). - // - // RobotApplicationVersionMismatchedEtag - // - // Etag for RobotApplication does not match value during version creation. + // The launch file name. // - // SimulationApplicationVersionMismatchedEtag + // LaunchFile is a required field + LaunchFile *string `locationName:"launchFile" min:"1" type:"string" required:"true"` + + // The package name. // - // Etag for SimulationApplication does not match value during version creation. - FailureCode *string `locationName:"failureCode" type:"string" enum:"SimulationJobErrorCode"` + // PackageName is a required field + PackageName *string `locationName:"packageName" min:"1" type:"string" required:"true"` - // The IAM role that allows the simulation job to call the AWS APIs that are - // specified in its associated policies on your behalf. - IamRole *string `locationName:"iamRole" min:"1" type:"string"` + // The deployment post-launch file. This file will be executed after the launch + // file. + PostLaunchFile *string `locationName:"postLaunchFile" min:"1" type:"string"` - // The time, in milliseconds since the epoch, when the simulation job was last - // started. - LastStartedAt *time.Time `locationName:"lastStartedAt" type:"timestamp"` + // The deployment pre-launch file. This file will be executed prior to the launch + // file. + PreLaunchFile *string `locationName:"preLaunchFile" min:"1" type:"string"` +} - // The time, in milliseconds since the epoch, when the simulation job was last - // updated. - LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` +// String returns the string representation +func (s DeploymentLaunchConfig) String() string { + return awsutil.Prettify(s) +} - // The logging configuration. - LoggingConfig *LoggingConfig `locationName:"loggingConfig" type:"structure"` +// GoString returns the string representation +func (s DeploymentLaunchConfig) GoString() string { + return s.String() +} - // The maximum simulation job duration in seconds. - MaxJobDurationInSeconds *int64 `locationName:"maxJobDurationInSeconds" type:"long"` +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeploymentLaunchConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeploymentLaunchConfig"} + if s.LaunchFile == nil { + invalidParams.Add(request.NewErrParamRequired("LaunchFile")) + } + if s.LaunchFile != nil && len(*s.LaunchFile) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LaunchFile", 1)) + } + if s.PackageName == nil { + invalidParams.Add(request.NewErrParamRequired("PackageName")) + } + if s.PackageName != nil && len(*s.PackageName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PackageName", 1)) + } + if s.PostLaunchFile != nil && len(*s.PostLaunchFile) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PostLaunchFile", 1)) + } + if s.PreLaunchFile != nil && len(*s.PreLaunchFile) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PreLaunchFile", 1)) + } - // Simulation job output files location. - OutputLocation *OutputLocation `locationName:"outputLocation" type:"structure"` + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} - // The robot application used by the simulation job. - RobotApplications []*RobotApplicationConfig `locationName:"robotApplications" min:"1" type:"list"` +// SetEnvironmentVariables sets the EnvironmentVariables field's value. +func (s *DeploymentLaunchConfig) SetEnvironmentVariables(v map[string]*string) *DeploymentLaunchConfig { + s.EnvironmentVariables = v + return s +} - // The simulation application used by the simulation job. - SimulationApplications []*SimulationApplicationConfig `locationName:"simulationApplications" min:"1" type:"list"` +// SetLaunchFile sets the LaunchFile field's value. +func (s *DeploymentLaunchConfig) SetLaunchFile(v string) *DeploymentLaunchConfig { + s.LaunchFile = &v + return s +} + +// SetPackageName sets the PackageName field's value. +func (s *DeploymentLaunchConfig) SetPackageName(v string) *DeploymentLaunchConfig { + s.PackageName = &v + return s +} - // The simulation job execution duration in milliseconds. - SimulationTimeMillis *int64 `locationName:"simulationTimeMillis" type:"long"` +// SetPostLaunchFile sets the PostLaunchFile field's value. +func (s *DeploymentLaunchConfig) SetPostLaunchFile(v string) *DeploymentLaunchConfig { + s.PostLaunchFile = &v + return s +} - // The status of the simulation job. - Status *string `locationName:"status" type:"string" enum:"SimulationJobStatus"` +// SetPreLaunchFile sets the PreLaunchFile field's value. +func (s *DeploymentLaunchConfig) SetPreLaunchFile(v string) *DeploymentLaunchConfig { + s.PreLaunchFile = &v + return s +} - // The list of all tags added to the simulation job. - Tags map[string]*string `locationName:"tags" type:"map"` +type DeregisterRobotInput struct { + _ struct{} `type:"structure"` - // Information about the vpc configuration. - VpcConfig *VPCConfigResponse `locationName:"vpcConfig" type:"structure"` + // The Amazon Resource Name (ARN) of the fleet. + // + // Fleet is a required field + Fleet *string `locationName:"fleet" min:"1" type:"string" required:"true"` + + // The Amazon Resource Name (ARN) of the robot. + // + // Robot is a required field + Robot *string `locationName:"robot" min:"1" type:"string" required:"true"` } // String returns the string representation -func (s CreateSimulationJobOutput) String() string { +func (s DeregisterRobotInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s CreateSimulationJobOutput) GoString() string { +func (s DeregisterRobotInput) GoString() string { return s.String() } -// SetArn sets the Arn field's value. -func (s *CreateSimulationJobOutput) SetArn(v string) *CreateSimulationJobOutput { - s.Arn = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeregisterRobotInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeregisterRobotInput"} + if s.Fleet == nil { + invalidParams.Add(request.NewErrParamRequired("Fleet")) + } + if s.Fleet != nil && len(*s.Fleet) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Fleet", 1)) + } + if s.Robot == nil { + invalidParams.Add(request.NewErrParamRequired("Robot")) + } + if s.Robot != nil && len(*s.Robot) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Robot", 1)) + } -// SetClientRequestToken sets the ClientRequestToken field's value. -func (s *CreateSimulationJobOutput) SetClientRequestToken(v string) *CreateSimulationJobOutput { - s.ClientRequestToken = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetCompute sets the Compute field's value. -func (s *CreateSimulationJobOutput) SetCompute(v *ComputeResponse) *CreateSimulationJobOutput { - s.Compute = v +// SetFleet sets the Fleet field's value. +func (s *DeregisterRobotInput) SetFleet(v string) *DeregisterRobotInput { + s.Fleet = &v return s } -// SetDataSources sets the DataSources field's value. -func (s *CreateSimulationJobOutput) SetDataSources(v []*DataSource) *CreateSimulationJobOutput { - s.DataSources = v +// SetRobot sets the Robot field's value. +func (s *DeregisterRobotInput) SetRobot(v string) *DeregisterRobotInput { + s.Robot = &v return s } -// SetFailureBehavior sets the FailureBehavior field's value. -func (s *CreateSimulationJobOutput) SetFailureBehavior(v string) *CreateSimulationJobOutput { - s.FailureBehavior = &v - return s -} +type DeregisterRobotOutput struct { + _ struct{} `type:"structure"` -// SetFailureCode sets the FailureCode field's value. -func (s *CreateSimulationJobOutput) SetFailureCode(v string) *CreateSimulationJobOutput { - s.FailureCode = &v - return s -} + // The Amazon Resource Name (ARN) of the fleet. + Fleet *string `locationName:"fleet" min:"1" type:"string"` -// SetIamRole sets the IamRole field's value. -func (s *CreateSimulationJobOutput) SetIamRole(v string) *CreateSimulationJobOutput { - s.IamRole = &v - return s + // The Amazon Resource Name (ARN) of the robot. + Robot *string `locationName:"robot" min:"1" type:"string"` } -// SetLastStartedAt sets the LastStartedAt field's value. -func (s *CreateSimulationJobOutput) SetLastStartedAt(v time.Time) *CreateSimulationJobOutput { - s.LastStartedAt = &v - return s +// String returns the string representation +func (s DeregisterRobotOutput) String() string { + return awsutil.Prettify(s) } -// SetLastUpdatedAt sets the LastUpdatedAt field's value. -func (s *CreateSimulationJobOutput) SetLastUpdatedAt(v time.Time) *CreateSimulationJobOutput { - s.LastUpdatedAt = &v - return s +// GoString returns the string representation +func (s DeregisterRobotOutput) GoString() string { + return s.String() } -// SetLoggingConfig sets the LoggingConfig field's value. -func (s *CreateSimulationJobOutput) SetLoggingConfig(v *LoggingConfig) *CreateSimulationJobOutput { - s.LoggingConfig = v +// SetFleet sets the Fleet field's value. +func (s *DeregisterRobotOutput) SetFleet(v string) *DeregisterRobotOutput { + s.Fleet = &v return s } -// SetMaxJobDurationInSeconds sets the MaxJobDurationInSeconds field's value. -func (s *CreateSimulationJobOutput) SetMaxJobDurationInSeconds(v int64) *CreateSimulationJobOutput { - s.MaxJobDurationInSeconds = &v +// SetRobot sets the Robot field's value. +func (s *DeregisterRobotOutput) SetRobot(v string) *DeregisterRobotOutput { + s.Robot = &v return s } -// SetOutputLocation sets the OutputLocation field's value. -func (s *CreateSimulationJobOutput) SetOutputLocation(v *OutputLocation) *CreateSimulationJobOutput { - s.OutputLocation = v - return s -} +type DescribeDeploymentJobInput struct { + _ struct{} `type:"structure"` -// SetRobotApplications sets the RobotApplications field's value. -func (s *CreateSimulationJobOutput) SetRobotApplications(v []*RobotApplicationConfig) *CreateSimulationJobOutput { - s.RobotApplications = v - return s + // The Amazon Resource Name (ARN) of the deployment job. + // + // Job is a required field + Job *string `locationName:"job" min:"1" type:"string" required:"true"` } -// SetSimulationApplications sets the SimulationApplications field's value. -func (s *CreateSimulationJobOutput) SetSimulationApplications(v []*SimulationApplicationConfig) *CreateSimulationJobOutput { - s.SimulationApplications = v - return s +// String returns the string representation +func (s DescribeDeploymentJobInput) String() string { + return awsutil.Prettify(s) } -// SetSimulationTimeMillis sets the SimulationTimeMillis field's value. -func (s *CreateSimulationJobOutput) SetSimulationTimeMillis(v int64) *CreateSimulationJobOutput { - s.SimulationTimeMillis = &v - return s +// GoString returns the string representation +func (s DescribeDeploymentJobInput) GoString() string { + return s.String() } -// SetStatus sets the Status field's value. -func (s *CreateSimulationJobOutput) SetStatus(v string) *CreateSimulationJobOutput { - s.Status = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeDeploymentJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeDeploymentJobInput"} + if s.Job == nil { + invalidParams.Add(request.NewErrParamRequired("Job")) + } + if s.Job != nil && len(*s.Job) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Job", 1)) + } -// SetTags sets the Tags field's value. -func (s *CreateSimulationJobOutput) SetTags(v map[string]*string) *CreateSimulationJobOutput { - s.Tags = v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetVpcConfig sets the VpcConfig field's value. -func (s *CreateSimulationJobOutput) SetVpcConfig(v *VPCConfigResponse) *CreateSimulationJobOutput { - s.VpcConfig = v +// SetJob sets the Job field's value. +func (s *DescribeDeploymentJobInput) SetJob(v string) *DescribeDeploymentJobInput { + s.Job = &v return s } -// Information about a data source. -type DataSource struct { +type DescribeDeploymentJobOutput struct { _ struct{} `type:"structure"` - // The name of the data source. - Name *string `locationName:"name" min:"1" type:"string"` + // The Amazon Resource Name (ARN) of the deployment job. + Arn *string `locationName:"arn" min:"1" type:"string"` - // The S3 bucket where the data files are located. - S3Bucket *string `locationName:"s3Bucket" min:"3" type:"string"` + // The time, in milliseconds since the epoch, when the deployment job was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The list of S3 keys identifying the data source files. - S3Keys []*S3KeyOutput `locationName:"s3Keys" type:"list"` + // The deployment application configuration. + DeploymentApplicationConfigs []*DeploymentApplicationConfig `locationName:"deploymentApplicationConfigs" min:"1" type:"list"` + + // The deployment configuration. + DeploymentConfig *DeploymentConfig `locationName:"deploymentConfig" type:"structure"` + + // The deployment job failure code. + FailureCode *string `locationName:"failureCode" type:"string" enum:"DeploymentJobErrorCode"` + + // A short description of the reason why the deployment job failed. + FailureReason *string `locationName:"failureReason" type:"string"` + + // The Amazon Resource Name (ARN) of the fleet. + Fleet *string `locationName:"fleet" min:"1" type:"string"` + + // A list of robot deployment summaries. + RobotDeploymentSummary []*RobotDeployment `locationName:"robotDeploymentSummary" type:"list"` + + // The status of the deployment job. + Status *string `locationName:"status" type:"string" enum:"DeploymentStatus"` + + // The list of all tags added to the specified deployment job. + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation -func (s DataSource) String() string { +func (s DescribeDeploymentJobOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DataSource) GoString() string { +func (s DescribeDeploymentJobOutput) GoString() string { return s.String() } -// SetName sets the Name field's value. -func (s *DataSource) SetName(v string) *DataSource { - s.Name = &v +// SetArn sets the Arn field's value. +func (s *DescribeDeploymentJobOutput) SetArn(v string) *DescribeDeploymentJobOutput { + s.Arn = &v return s } -// SetS3Bucket sets the S3Bucket field's value. -func (s *DataSource) SetS3Bucket(v string) *DataSource { - s.S3Bucket = &v +// SetCreatedAt sets the CreatedAt field's value. +func (s *DescribeDeploymentJobOutput) SetCreatedAt(v time.Time) *DescribeDeploymentJobOutput { + s.CreatedAt = &v return s } -// SetS3Keys sets the S3Keys field's value. -func (s *DataSource) SetS3Keys(v []*S3KeyOutput) *DataSource { - s.S3Keys = v +// SetDeploymentApplicationConfigs sets the DeploymentApplicationConfigs field's value. +func (s *DescribeDeploymentJobOutput) SetDeploymentApplicationConfigs(v []*DeploymentApplicationConfig) *DescribeDeploymentJobOutput { + s.DeploymentApplicationConfigs = v return s } -// Information about a data source. -type DataSourceConfig struct { - _ struct{} `type:"structure"` - - // The name of the data source. - // - // Name is a required field - Name *string `locationName:"name" min:"1" type:"string" required:"true"` - - // The S3 bucket where the data files are located. - // - // S3Bucket is a required field - S3Bucket *string `locationName:"s3Bucket" min:"3" type:"string" required:"true"` - - // The list of S3 keys identifying the data source files. - // - // S3Keys is a required field - S3Keys []*string `locationName:"s3Keys" min:"1" type:"list" required:"true"` +// SetDeploymentConfig sets the DeploymentConfig field's value. +func (s *DescribeDeploymentJobOutput) SetDeploymentConfig(v *DeploymentConfig) *DescribeDeploymentJobOutput { + s.DeploymentConfig = v + return s } -// String returns the string representation -func (s DataSourceConfig) String() string { - return awsutil.Prettify(s) +// SetFailureCode sets the FailureCode field's value. +func (s *DescribeDeploymentJobOutput) SetFailureCode(v string) *DescribeDeploymentJobOutput { + s.FailureCode = &v + return s } -// GoString returns the string representation -func (s DataSourceConfig) GoString() string { - return s.String() +// SetFailureReason sets the FailureReason field's value. +func (s *DescribeDeploymentJobOutput) SetFailureReason(v string) *DescribeDeploymentJobOutput { + s.FailureReason = &v + return s } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DataSourceConfig) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DataSourceConfig"} - if s.Name == nil { - invalidParams.Add(request.NewErrParamRequired("Name")) - } - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) - } - if s.S3Bucket == nil { - invalidParams.Add(request.NewErrParamRequired("S3Bucket")) - } - if s.S3Bucket != nil && len(*s.S3Bucket) < 3 { - invalidParams.Add(request.NewErrParamMinLen("S3Bucket", 3)) - } - if s.S3Keys == nil { - invalidParams.Add(request.NewErrParamRequired("S3Keys")) - } - if s.S3Keys != nil && len(s.S3Keys) < 1 { - invalidParams.Add(request.NewErrParamMinLen("S3Keys", 1)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetFleet sets the Fleet field's value. +func (s *DescribeDeploymentJobOutput) SetFleet(v string) *DescribeDeploymentJobOutput { + s.Fleet = &v + return s } -// SetName sets the Name field's value. -func (s *DataSourceConfig) SetName(v string) *DataSourceConfig { - s.Name = &v +// SetRobotDeploymentSummary sets the RobotDeploymentSummary field's value. +func (s *DescribeDeploymentJobOutput) SetRobotDeploymentSummary(v []*RobotDeployment) *DescribeDeploymentJobOutput { + s.RobotDeploymentSummary = v return s } -// SetS3Bucket sets the S3Bucket field's value. -func (s *DataSourceConfig) SetS3Bucket(v string) *DataSourceConfig { - s.S3Bucket = &v +// SetStatus sets the Status field's value. +func (s *DescribeDeploymentJobOutput) SetStatus(v string) *DescribeDeploymentJobOutput { + s.Status = &v return s } -// SetS3Keys sets the S3Keys field's value. -func (s *DataSourceConfig) SetS3Keys(v []*string) *DataSourceConfig { - s.S3Keys = v +// SetTags sets the Tags field's value. +func (s *DescribeDeploymentJobOutput) SetTags(v map[string]*string) *DescribeDeploymentJobOutput { + s.Tags = v return s } -type DeleteFleetInput struct { +type DescribeFleetInput struct { _ struct{} `type:"structure"` // The Amazon Resource Name (ARN) of the fleet. @@ -6306,18 +9722,18 @@ type DeleteFleetInput struct { } // String returns the string representation -func (s DeleteFleetInput) String() string { +func (s DescribeFleetInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DeleteFleetInput) GoString() string { +func (s DescribeFleetInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteFleetInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteFleetInput"} +func (s *DescribeFleetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeFleetInput"} if s.Fleet == nil { invalidParams.Add(request.NewErrParamRequired("Fleet")) } @@ -6332,50 +9748,122 @@ func (s *DeleteFleetInput) Validate() error { } // SetFleet sets the Fleet field's value. -func (s *DeleteFleetInput) SetFleet(v string) *DeleteFleetInput { +func (s *DescribeFleetInput) SetFleet(v string) *DescribeFleetInput { s.Fleet = &v return s } -type DeleteFleetOutput struct { +type DescribeFleetOutput struct { _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the fleet. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // The time, in milliseconds since the epoch, when the fleet was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + + // The Amazon Resource Name (ARN) of the last deployment job. + LastDeploymentJob *string `locationName:"lastDeploymentJob" min:"1" type:"string"` + + // The status of the last deployment. + LastDeploymentStatus *string `locationName:"lastDeploymentStatus" type:"string" enum:"DeploymentStatus"` + + // The time of the last deployment. + LastDeploymentTime *time.Time `locationName:"lastDeploymentTime" type:"timestamp"` + + // The name of the fleet. + Name *string `locationName:"name" min:"1" type:"string"` + + // A list of robots. + Robots []*Robot `locationName:"robots" type:"list"` + + // The list of all tags added to the specified fleet. + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation -func (s DeleteFleetOutput) String() string { +func (s DescribeFleetOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DeleteFleetOutput) GoString() string { +func (s DescribeFleetOutput) GoString() string { return s.String() } -type DeleteRobotApplicationInput struct { +// SetArn sets the Arn field's value. +func (s *DescribeFleetOutput) SetArn(v string) *DescribeFleetOutput { + s.Arn = &v + return s +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *DescribeFleetOutput) SetCreatedAt(v time.Time) *DescribeFleetOutput { + s.CreatedAt = &v + return s +} + +// SetLastDeploymentJob sets the LastDeploymentJob field's value. +func (s *DescribeFleetOutput) SetLastDeploymentJob(v string) *DescribeFleetOutput { + s.LastDeploymentJob = &v + return s +} + +// SetLastDeploymentStatus sets the LastDeploymentStatus field's value. +func (s *DescribeFleetOutput) SetLastDeploymentStatus(v string) *DescribeFleetOutput { + s.LastDeploymentStatus = &v + return s +} + +// SetLastDeploymentTime sets the LastDeploymentTime field's value. +func (s *DescribeFleetOutput) SetLastDeploymentTime(v time.Time) *DescribeFleetOutput { + s.LastDeploymentTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *DescribeFleetOutput) SetName(v string) *DescribeFleetOutput { + s.Name = &v + return s +} + +// SetRobots sets the Robots field's value. +func (s *DescribeFleetOutput) SetRobots(v []*Robot) *DescribeFleetOutput { + s.Robots = v + return s +} + +// SetTags sets the Tags field's value. +func (s *DescribeFleetOutput) SetTags(v map[string]*string) *DescribeFleetOutput { + s.Tags = v + return s +} + +type DescribeRobotApplicationInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the the robot application. + // The Amazon Resource Name (ARN) of the robot application. // // Application is a required field Application *string `locationName:"application" min:"1" type:"string" required:"true"` - // The version of the robot application to delete. + // The version of the robot application to describe. ApplicationVersion *string `locationName:"applicationVersion" min:"1" type:"string"` } // String returns the string representation -func (s DeleteRobotApplicationInput) String() string { +func (s DescribeRobotApplicationInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DeleteRobotApplicationInput) GoString() string { +func (s DescribeRobotApplicationInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteRobotApplicationInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteRobotApplicationInput"} +func (s *DescribeRobotApplicationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeRobotApplicationInput"} if s.Application == nil { invalidParams.Add(request.NewErrParamRequired("Application")) } @@ -6393,53 +9881,126 @@ func (s *DeleteRobotApplicationInput) Validate() error { } // SetApplication sets the Application field's value. -func (s *DeleteRobotApplicationInput) SetApplication(v string) *DeleteRobotApplicationInput { +func (s *DescribeRobotApplicationInput) SetApplication(v string) *DescribeRobotApplicationInput { s.Application = &v return s } // SetApplicationVersion sets the ApplicationVersion field's value. -func (s *DeleteRobotApplicationInput) SetApplicationVersion(v string) *DeleteRobotApplicationInput { +func (s *DescribeRobotApplicationInput) SetApplicationVersion(v string) *DescribeRobotApplicationInput { s.ApplicationVersion = &v return s } -type DeleteRobotApplicationOutput struct { +type DescribeRobotApplicationOutput struct { _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the robot application. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // The time, in milliseconds since the epoch, when the robot application was + // last updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` + + // The name of the robot application. + Name *string `locationName:"name" min:"1" type:"string"` + + // The revision id of the robot application. + RevisionId *string `locationName:"revisionId" min:"1" type:"string"` + + // The robot software suite (ROS distribution) used by the robot application. + RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` + + // The sources of the robot application. + Sources []*Source `locationName:"sources" type:"list"` + + // The list of all tags added to the specified robot application. + Tags map[string]*string `locationName:"tags" type:"map"` + + // The version of the robot application. + Version *string `locationName:"version" min:"1" type:"string"` } // String returns the string representation -func (s DeleteRobotApplicationOutput) String() string { +func (s DescribeRobotApplicationOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DeleteRobotApplicationOutput) GoString() string { +func (s DescribeRobotApplicationOutput) GoString() string { return s.String() } -type DeleteRobotInput struct { +// SetArn sets the Arn field's value. +func (s *DescribeRobotApplicationOutput) SetArn(v string) *DescribeRobotApplicationOutput { + s.Arn = &v + return s +} + +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *DescribeRobotApplicationOutput) SetLastUpdatedAt(v time.Time) *DescribeRobotApplicationOutput { + s.LastUpdatedAt = &v + return s +} + +// SetName sets the Name field's value. +func (s *DescribeRobotApplicationOutput) SetName(v string) *DescribeRobotApplicationOutput { + s.Name = &v + return s +} + +// SetRevisionId sets the RevisionId field's value. +func (s *DescribeRobotApplicationOutput) SetRevisionId(v string) *DescribeRobotApplicationOutput { + s.RevisionId = &v + return s +} + +// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. +func (s *DescribeRobotApplicationOutput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *DescribeRobotApplicationOutput { + s.RobotSoftwareSuite = v + return s +} + +// SetSources sets the Sources field's value. +func (s *DescribeRobotApplicationOutput) SetSources(v []*Source) *DescribeRobotApplicationOutput { + s.Sources = v + return s +} + +// SetTags sets the Tags field's value. +func (s *DescribeRobotApplicationOutput) SetTags(v map[string]*string) *DescribeRobotApplicationOutput { + s.Tags = v + return s +} + +// SetVersion sets the Version field's value. +func (s *DescribeRobotApplicationOutput) SetVersion(v string) *DescribeRobotApplicationOutput { + s.Version = &v + return s +} + +type DescribeRobotInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the robot. + // The Amazon Resource Name (ARN) of the robot to be described. // // Robot is a required field Robot *string `locationName:"robot" min:"1" type:"string" required:"true"` } // String returns the string representation -func (s DeleteRobotInput) String() string { +func (s DescribeRobotInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DeleteRobotInput) GoString() string { +func (s DescribeRobotInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteRobotInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteRobotInput"} +func (s *DescribeRobotInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeRobotInput"} if s.Robot == nil { invalidParams.Add(request.NewErrParamRequired("Robot")) } @@ -6454,145 +10015,149 @@ func (s *DeleteRobotInput) Validate() error { } // SetRobot sets the Robot field's value. -func (s *DeleteRobotInput) SetRobot(v string) *DeleteRobotInput { +func (s *DescribeRobotInput) SetRobot(v string) *DescribeRobotInput { s.Robot = &v return s } -type DeleteRobotOutput struct { +type DescribeRobotOutput struct { _ struct{} `type:"structure"` + + // The target architecture of the robot application. + Architecture *string `locationName:"architecture" type:"string" enum:"Architecture"` + + // The Amazon Resource Name (ARN) of the robot. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // The time, in milliseconds since the epoch, when the robot was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + + // The Amazon Resource Name (ARN) of the fleet. + FleetArn *string `locationName:"fleetArn" min:"1" type:"string"` + + // The Greengrass group id. + GreengrassGroupId *string `locationName:"greengrassGroupId" min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of the last deployment job. + LastDeploymentJob *string `locationName:"lastDeploymentJob" min:"1" type:"string"` + + // The time of the last deployment job. + LastDeploymentTime *time.Time `locationName:"lastDeploymentTime" type:"timestamp"` + + // The name of the robot. + Name *string `locationName:"name" min:"1" type:"string"` + + // The status of the fleet. + Status *string `locationName:"status" type:"string" enum:"RobotStatus"` + + // The list of all tags added to the specified robot. + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation -func (s DeleteRobotOutput) String() string { +func (s DescribeRobotOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DeleteRobotOutput) GoString() string { +func (s DescribeRobotOutput) GoString() string { return s.String() } -type DeleteSimulationApplicationInput struct { - _ struct{} `type:"structure"` - - // The application information for the simulation application to delete. - // - // Application is a required field - Application *string `locationName:"application" min:"1" type:"string" required:"true"` - - // The version of the simulation application to delete. - ApplicationVersion *string `locationName:"applicationVersion" min:"1" type:"string"` +// SetArchitecture sets the Architecture field's value. +func (s *DescribeRobotOutput) SetArchitecture(v string) *DescribeRobotOutput { + s.Architecture = &v + return s } -// String returns the string representation -func (s DeleteSimulationApplicationInput) String() string { - return awsutil.Prettify(s) +// SetArn sets the Arn field's value. +func (s *DescribeRobotOutput) SetArn(v string) *DescribeRobotOutput { + s.Arn = &v + return s } -// GoString returns the string representation -func (s DeleteSimulationApplicationInput) GoString() string { - return s.String() +// SetCreatedAt sets the CreatedAt field's value. +func (s *DescribeRobotOutput) SetCreatedAt(v time.Time) *DescribeRobotOutput { + s.CreatedAt = &v + return s } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteSimulationApplicationInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteSimulationApplicationInput"} - if s.Application == nil { - invalidParams.Add(request.NewErrParamRequired("Application")) - } - if s.Application != nil && len(*s.Application) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Application", 1)) - } - if s.ApplicationVersion != nil && len(*s.ApplicationVersion) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ApplicationVersion", 1)) - } +// SetFleetArn sets the FleetArn field's value. +func (s *DescribeRobotOutput) SetFleetArn(v string) *DescribeRobotOutput { + s.FleetArn = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetGreengrassGroupId sets the GreengrassGroupId field's value. +func (s *DescribeRobotOutput) SetGreengrassGroupId(v string) *DescribeRobotOutput { + s.GreengrassGroupId = &v + return s } -// SetApplication sets the Application field's value. -func (s *DeleteSimulationApplicationInput) SetApplication(v string) *DeleteSimulationApplicationInput { - s.Application = &v +// SetLastDeploymentJob sets the LastDeploymentJob field's value. +func (s *DescribeRobotOutput) SetLastDeploymentJob(v string) *DescribeRobotOutput { + s.LastDeploymentJob = &v return s } -// SetApplicationVersion sets the ApplicationVersion field's value. -func (s *DeleteSimulationApplicationInput) SetApplicationVersion(v string) *DeleteSimulationApplicationInput { - s.ApplicationVersion = &v +// SetLastDeploymentTime sets the LastDeploymentTime field's value. +func (s *DescribeRobotOutput) SetLastDeploymentTime(v time.Time) *DescribeRobotOutput { + s.LastDeploymentTime = &v return s } -type DeleteSimulationApplicationOutput struct { - _ struct{} `type:"structure"` +// SetName sets the Name field's value. +func (s *DescribeRobotOutput) SetName(v string) *DescribeRobotOutput { + s.Name = &v + return s } -// String returns the string representation -func (s DeleteSimulationApplicationOutput) String() string { - return awsutil.Prettify(s) +// SetStatus sets the Status field's value. +func (s *DescribeRobotOutput) SetStatus(v string) *DescribeRobotOutput { + s.Status = &v + return s } -// GoString returns the string representation -func (s DeleteSimulationApplicationOutput) GoString() string { - return s.String() +// SetTags sets the Tags field's value. +func (s *DescribeRobotOutput) SetTags(v map[string]*string) *DescribeRobotOutput { + s.Tags = v + return s } -// Information about a deployment application configuration. -type DeploymentApplicationConfig struct { +type DescribeSimulationApplicationInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the robot application. + // The application information for the simulation application. // // Application is a required field Application *string `locationName:"application" min:"1" type:"string" required:"true"` - // The version of the application. - // - // ApplicationVersion is a required field - ApplicationVersion *string `locationName:"applicationVersion" min:"1" type:"string" required:"true"` - - // The launch configuration. - // - // LaunchConfig is a required field - LaunchConfig *DeploymentLaunchConfig `locationName:"launchConfig" type:"structure" required:"true"` + // The version of the simulation application to describe. + ApplicationVersion *string `locationName:"applicationVersion" min:"1" type:"string"` } // String returns the string representation -func (s DeploymentApplicationConfig) String() string { +func (s DescribeSimulationApplicationInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DeploymentApplicationConfig) GoString() string { +func (s DescribeSimulationApplicationInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeploymentApplicationConfig) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeploymentApplicationConfig"} +func (s *DescribeSimulationApplicationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeSimulationApplicationInput"} if s.Application == nil { invalidParams.Add(request.NewErrParamRequired("Application")) } if s.Application != nil && len(*s.Application) < 1 { invalidParams.Add(request.NewErrParamMinLen("Application", 1)) } - if s.ApplicationVersion == nil { - invalidParams.Add(request.NewErrParamRequired("ApplicationVersion")) - } if s.ApplicationVersion != nil && len(*s.ApplicationVersion) < 1 { invalidParams.Add(request.NewErrParamMinLen("ApplicationVersion", 1)) } - if s.LaunchConfig == nil { - invalidParams.Add(request.NewErrParamRequired("LaunchConfig")) - } - if s.LaunchConfig != nil { - if err := s.LaunchConfig.Validate(); err != nil { - invalidParams.AddNested("LaunchConfig", err.(request.ErrInvalidParams)) - } - } if invalidParams.Len() > 0 { return invalidParams @@ -6601,241 +10166,149 @@ func (s *DeploymentApplicationConfig) Validate() error { } // SetApplication sets the Application field's value. -func (s *DeploymentApplicationConfig) SetApplication(v string) *DeploymentApplicationConfig { +func (s *DescribeSimulationApplicationInput) SetApplication(v string) *DescribeSimulationApplicationInput { s.Application = &v return s } // SetApplicationVersion sets the ApplicationVersion field's value. -func (s *DeploymentApplicationConfig) SetApplicationVersion(v string) *DeploymentApplicationConfig { +func (s *DescribeSimulationApplicationInput) SetApplicationVersion(v string) *DescribeSimulationApplicationInput { s.ApplicationVersion = &v return s } -// SetLaunchConfig sets the LaunchConfig field's value. -func (s *DeploymentApplicationConfig) SetLaunchConfig(v *DeploymentLaunchConfig) *DeploymentApplicationConfig { - s.LaunchConfig = v - return s -} - -// Information about a deployment configuration. -type DeploymentConfig struct { - _ struct{} `type:"structure"` - - // The percentage of robots receiving the deployment at the same time. - ConcurrentDeploymentPercentage *int64 `locationName:"concurrentDeploymentPercentage" min:"1" type:"integer"` - - // The download condition file. - DownloadConditionFile *S3Object `locationName:"downloadConditionFile" type:"structure"` - - // The percentage of deployments that need to fail before stopping deployment. - FailureThresholdPercentage *int64 `locationName:"failureThresholdPercentage" min:"1" type:"integer"` - - // The amount of time, in seconds, to wait for deployment to a single robot - // to complete. Choose a time between 1 minute and 7 days. The default is 5 - // hours. - RobotDeploymentTimeoutInSeconds *int64 `locationName:"robotDeploymentTimeoutInSeconds" type:"long"` -} - -// String returns the string representation -func (s DeploymentConfig) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s DeploymentConfig) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *DeploymentConfig) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeploymentConfig"} - if s.ConcurrentDeploymentPercentage != nil && *s.ConcurrentDeploymentPercentage < 1 { - invalidParams.Add(request.NewErrParamMinValue("ConcurrentDeploymentPercentage", 1)) - } - if s.FailureThresholdPercentage != nil && *s.FailureThresholdPercentage < 1 { - invalidParams.Add(request.NewErrParamMinValue("FailureThresholdPercentage", 1)) - } - if s.DownloadConditionFile != nil { - if err := s.DownloadConditionFile.Validate(); err != nil { - invalidParams.AddNested("DownloadConditionFile", err.(request.ErrInvalidParams)) - } - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetConcurrentDeploymentPercentage sets the ConcurrentDeploymentPercentage field's value. -func (s *DeploymentConfig) SetConcurrentDeploymentPercentage(v int64) *DeploymentConfig { - s.ConcurrentDeploymentPercentage = &v - return s -} - -// SetDownloadConditionFile sets the DownloadConditionFile field's value. -func (s *DeploymentConfig) SetDownloadConditionFile(v *S3Object) *DeploymentConfig { - s.DownloadConditionFile = v - return s -} - -// SetFailureThresholdPercentage sets the FailureThresholdPercentage field's value. -func (s *DeploymentConfig) SetFailureThresholdPercentage(v int64) *DeploymentConfig { - s.FailureThresholdPercentage = &v - return s -} - -// SetRobotDeploymentTimeoutInSeconds sets the RobotDeploymentTimeoutInSeconds field's value. -func (s *DeploymentConfig) SetRobotDeploymentTimeoutInSeconds(v int64) *DeploymentConfig { - s.RobotDeploymentTimeoutInSeconds = &v - return s -} - -// Information about a deployment job. -type DeploymentJob struct { +type DescribeSimulationApplicationOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the deployment job. + // The Amazon Resource Name (ARN) of the robot simulation application. Arn *string `locationName:"arn" min:"1" type:"string"` - // The time, in milliseconds since the epoch, when the deployment job was created. - CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + // The time, in milliseconds since the epoch, when the simulation application + // was last updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` + + // The name of the simulation application. + Name *string `locationName:"name" min:"1" type:"string"` - // The deployment application configuration. - DeploymentApplicationConfigs []*DeploymentApplicationConfig `locationName:"deploymentApplicationConfigs" min:"1" type:"list"` + // The rendering engine for the simulation application. + RenderingEngine *RenderingEngine `locationName:"renderingEngine" type:"structure"` - // The deployment configuration. - DeploymentConfig *DeploymentConfig `locationName:"deploymentConfig" type:"structure"` + // The revision id of the simulation application. + RevisionId *string `locationName:"revisionId" min:"1" type:"string"` - // The deployment job failure code. - FailureCode *string `locationName:"failureCode" type:"string" enum:"DeploymentJobErrorCode"` + // Information about the robot software suite (ROS distribution). + RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` - // A short description of the reason why the deployment job failed. - FailureReason *string `locationName:"failureReason" type:"string"` + // The simulation software suite used by the simulation application. + SimulationSoftwareSuite *SimulationSoftwareSuite `locationName:"simulationSoftwareSuite" type:"structure"` - // The Amazon Resource Name (ARN) of the fleet. - Fleet *string `locationName:"fleet" min:"1" type:"string"` + // The sources of the simulation application. + Sources []*Source `locationName:"sources" type:"list"` - // The status of the deployment job. - Status *string `locationName:"status" type:"string" enum:"DeploymentStatus"` + // The list of all tags added to the specified simulation application. + Tags map[string]*string `locationName:"tags" type:"map"` + + // The version of the simulation application. + Version *string `locationName:"version" min:"1" type:"string"` } // String returns the string representation -func (s DeploymentJob) String() string { +func (s DescribeSimulationApplicationOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DeploymentJob) GoString() string { +func (s DescribeSimulationApplicationOutput) GoString() string { return s.String() } // SetArn sets the Arn field's value. -func (s *DeploymentJob) SetArn(v string) *DeploymentJob { +func (s *DescribeSimulationApplicationOutput) SetArn(v string) *DescribeSimulationApplicationOutput { s.Arn = &v return s } -// SetCreatedAt sets the CreatedAt field's value. -func (s *DeploymentJob) SetCreatedAt(v time.Time) *DeploymentJob { - s.CreatedAt = &v +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *DescribeSimulationApplicationOutput) SetLastUpdatedAt(v time.Time) *DescribeSimulationApplicationOutput { + s.LastUpdatedAt = &v return s } -// SetDeploymentApplicationConfigs sets the DeploymentApplicationConfigs field's value. -func (s *DeploymentJob) SetDeploymentApplicationConfigs(v []*DeploymentApplicationConfig) *DeploymentJob { - s.DeploymentApplicationConfigs = v +// SetName sets the Name field's value. +func (s *DescribeSimulationApplicationOutput) SetName(v string) *DescribeSimulationApplicationOutput { + s.Name = &v return s } -// SetDeploymentConfig sets the DeploymentConfig field's value. -func (s *DeploymentJob) SetDeploymentConfig(v *DeploymentConfig) *DeploymentJob { - s.DeploymentConfig = v +// SetRenderingEngine sets the RenderingEngine field's value. +func (s *DescribeSimulationApplicationOutput) SetRenderingEngine(v *RenderingEngine) *DescribeSimulationApplicationOutput { + s.RenderingEngine = v return s } -// SetFailureCode sets the FailureCode field's value. -func (s *DeploymentJob) SetFailureCode(v string) *DeploymentJob { - s.FailureCode = &v +// SetRevisionId sets the RevisionId field's value. +func (s *DescribeSimulationApplicationOutput) SetRevisionId(v string) *DescribeSimulationApplicationOutput { + s.RevisionId = &v return s } -// SetFailureReason sets the FailureReason field's value. -func (s *DeploymentJob) SetFailureReason(v string) *DeploymentJob { - s.FailureReason = &v +// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. +func (s *DescribeSimulationApplicationOutput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *DescribeSimulationApplicationOutput { + s.RobotSoftwareSuite = v return s } -// SetFleet sets the Fleet field's value. -func (s *DeploymentJob) SetFleet(v string) *DeploymentJob { - s.Fleet = &v +// SetSimulationSoftwareSuite sets the SimulationSoftwareSuite field's value. +func (s *DescribeSimulationApplicationOutput) SetSimulationSoftwareSuite(v *SimulationSoftwareSuite) *DescribeSimulationApplicationOutput { + s.SimulationSoftwareSuite = v return s } -// SetStatus sets the Status field's value. -func (s *DeploymentJob) SetStatus(v string) *DeploymentJob { - s.Status = &v +// SetSources sets the Sources field's value. +func (s *DescribeSimulationApplicationOutput) SetSources(v []*Source) *DescribeSimulationApplicationOutput { + s.Sources = v return s } -// Configuration information for a deployment launch. -type DeploymentLaunchConfig struct { - _ struct{} `type:"structure"` +// SetTags sets the Tags field's value. +func (s *DescribeSimulationApplicationOutput) SetTags(v map[string]*string) *DescribeSimulationApplicationOutput { + s.Tags = v + return s +} - // An array of key/value pairs specifying environment variables for the robot - // application - EnvironmentVariables map[string]*string `locationName:"environmentVariables" type:"map"` +// SetVersion sets the Version field's value. +func (s *DescribeSimulationApplicationOutput) SetVersion(v string) *DescribeSimulationApplicationOutput { + s.Version = &v + return s +} - // The launch file name. - // - // LaunchFile is a required field - LaunchFile *string `locationName:"launchFile" min:"1" type:"string" required:"true"` +type DescribeSimulationJobBatchInput struct { + _ struct{} `type:"structure"` - // The package name. + // The id of the batch to describe. // - // PackageName is a required field - PackageName *string `locationName:"packageName" min:"1" type:"string" required:"true"` - - // The deployment post-launch file. This file will be executed after the launch - // file. - PostLaunchFile *string `locationName:"postLaunchFile" min:"1" type:"string"` - - // The deployment pre-launch file. This file will be executed prior to the launch - // file. - PreLaunchFile *string `locationName:"preLaunchFile" min:"1" type:"string"` + // Batch is a required field + Batch *string `locationName:"batch" min:"1" type:"string" required:"true"` } // String returns the string representation -func (s DeploymentLaunchConfig) String() string { +func (s DescribeSimulationJobBatchInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DeploymentLaunchConfig) GoString() string { +func (s DescribeSimulationJobBatchInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeploymentLaunchConfig) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeploymentLaunchConfig"} - if s.LaunchFile == nil { - invalidParams.Add(request.NewErrParamRequired("LaunchFile")) - } - if s.LaunchFile != nil && len(*s.LaunchFile) < 1 { - invalidParams.Add(request.NewErrParamMinLen("LaunchFile", 1)) - } - if s.PackageName == nil { - invalidParams.Add(request.NewErrParamRequired("PackageName")) - } - if s.PackageName != nil && len(*s.PackageName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("PackageName", 1)) - } - if s.PostLaunchFile != nil && len(*s.PostLaunchFile) < 1 { - invalidParams.Add(request.NewErrParamMinLen("PostLaunchFile", 1)) +func (s *DescribeSimulationJobBatchInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeSimulationJobBatchInput"} + if s.Batch == nil { + invalidParams.Add(request.NewErrParamRequired("Batch")) } - if s.PreLaunchFile != nil && len(*s.PreLaunchFile) < 1 { - invalidParams.Add(request.NewErrParamMinLen("PreLaunchFile", 1)) + if s.Batch != nil && len(*s.Batch) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Batch", 1)) } if invalidParams.Len() > 0 { @@ -6844,148 +10317,209 @@ func (s *DeploymentLaunchConfig) Validate() error { return nil } -// SetEnvironmentVariables sets the EnvironmentVariables field's value. -func (s *DeploymentLaunchConfig) SetEnvironmentVariables(v map[string]*string) *DeploymentLaunchConfig { - s.EnvironmentVariables = v +// SetBatch sets the Batch field's value. +func (s *DescribeSimulationJobBatchInput) SetBatch(v string) *DescribeSimulationJobBatchInput { + s.Batch = &v return s } -// SetLaunchFile sets the LaunchFile field's value. -func (s *DeploymentLaunchConfig) SetLaunchFile(v string) *DeploymentLaunchConfig { - s.LaunchFile = &v - return s -} +type DescribeSimulationJobBatchOutput struct { + _ struct{} `type:"structure"` -// SetPackageName sets the PackageName field's value. -func (s *DeploymentLaunchConfig) SetPackageName(v string) *DeploymentLaunchConfig { - s.PackageName = &v - return s -} + // The Amazon Resource Name (ARN) of the batch. + Arn *string `locationName:"arn" min:"1" type:"string"` -// SetPostLaunchFile sets the PostLaunchFile field's value. -func (s *DeploymentLaunchConfig) SetPostLaunchFile(v string) *DeploymentLaunchConfig { - s.PostLaunchFile = &v - return s -} + // The batch policy. + BatchPolicy *BatchPolicy `locationName:"batchPolicy" type:"structure"` -// SetPreLaunchFile sets the PreLaunchFile field's value. -func (s *DeploymentLaunchConfig) SetPreLaunchFile(v string) *DeploymentLaunchConfig { - s.PreLaunchFile = &v - return s -} + // Unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"` -type DeregisterRobotInput struct { - _ struct{} `type:"structure"` + // The time, in milliseconds since the epoch, when the simulation job batch + // was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The Amazon Resource Name (ARN) of the fleet. - // - // Fleet is a required field - Fleet *string `locationName:"fleet" min:"1" type:"string" required:"true"` + // A list of created simulation job summaries. + CreatedRequests []*SimulationJobSummary `locationName:"createdRequests" type:"list"` - // The Amazon Resource Name (ARN) of the robot. + // A list of failed create simulation job requests. The request failed to be + // created into a simulation job. Failed requests do not have a simulation job + // ID. + FailedRequests []*FailedCreateSimulationJobRequest `locationName:"failedRequests" type:"list"` + + // The failure code of the simulation job batch. + FailureCode *string `locationName:"failureCode" type:"string" enum:"SimulationJobBatchErrorCode"` + + // The reason the simulation job batch failed. + FailureReason *string `locationName:"failureReason" type:"string"` + + // The time, in milliseconds since the epoch, when the simulation job batch + // was last updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` + + // A list of pending simulation job requests. These requests have not yet been + // created into simulation jobs. + PendingRequests []*SimulationJobRequest `locationName:"pendingRequests" min:"1" type:"list"` + + // The status of the batch. // - // Robot is a required field - Robot *string `locationName:"robot" min:"1" type:"string" required:"true"` + // Pending + // + // The simulation job batch request is pending. + // + // InProgress + // + // The simulation job batch is in progress. + // + // Failed + // + // The simulation job batch failed. One or more simulation job requests could + // not be completed due to an internal failure (like InternalServiceError). + // See failureCode and failureReason for more information. + // + // Completed + // + // The simulation batch job completed. A batch is complete when (1) there are + // no pending simulation job requests in the batch and none of the failed simulation + // job requests are due to InternalServiceError and (2) when all created simulation + // jobs have reached a terminal state (for example, Completed or Failed). + // + // Canceled + // + // The simulation batch job was cancelled. + // + // Canceling + // + // The simulation batch job is being cancelled. + // + // Completing + // + // The simulation batch job is completing. + // + // TimingOut + // + // The simulation job batch is timing out. + // + // If a batch timing out, and there are pending requests that were failing due + // to an internal failure (like InternalServiceError), the batch status will + // be Failed. If there are no such failing request, the batch status will be + // TimedOut. + // + // TimedOut + // + // The simulation batch job timed out. + Status *string `locationName:"status" type:"string" enum:"SimulationJobBatchStatus"` + + // A map that contains tag keys and tag values that are attached to the simulation + // job batch. + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation -func (s DeregisterRobotInput) String() string { +func (s DescribeSimulationJobBatchOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DeregisterRobotInput) GoString() string { +func (s DescribeSimulationJobBatchOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DeregisterRobotInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeregisterRobotInput"} - if s.Fleet == nil { - invalidParams.Add(request.NewErrParamRequired("Fleet")) - } - if s.Fleet != nil && len(*s.Fleet) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Fleet", 1)) - } - if s.Robot == nil { - invalidParams.Add(request.NewErrParamRequired("Robot")) - } - if s.Robot != nil && len(*s.Robot) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Robot", 1)) - } +// SetArn sets the Arn field's value. +func (s *DescribeSimulationJobBatchOutput) SetArn(v string) *DescribeSimulationJobBatchOutput { + s.Arn = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetBatchPolicy sets the BatchPolicy field's value. +func (s *DescribeSimulationJobBatchOutput) SetBatchPolicy(v *BatchPolicy) *DescribeSimulationJobBatchOutput { + s.BatchPolicy = v + return s } -// SetFleet sets the Fleet field's value. -func (s *DeregisterRobotInput) SetFleet(v string) *DeregisterRobotInput { - s.Fleet = &v +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *DescribeSimulationJobBatchOutput) SetClientRequestToken(v string) *DescribeSimulationJobBatchOutput { + s.ClientRequestToken = &v return s } -// SetRobot sets the Robot field's value. -func (s *DeregisterRobotInput) SetRobot(v string) *DeregisterRobotInput { - s.Robot = &v +// SetCreatedAt sets the CreatedAt field's value. +func (s *DescribeSimulationJobBatchOutput) SetCreatedAt(v time.Time) *DescribeSimulationJobBatchOutput { + s.CreatedAt = &v return s } -type DeregisterRobotOutput struct { - _ struct{} `type:"structure"` +// SetCreatedRequests sets the CreatedRequests field's value. +func (s *DescribeSimulationJobBatchOutput) SetCreatedRequests(v []*SimulationJobSummary) *DescribeSimulationJobBatchOutput { + s.CreatedRequests = v + return s +} - // The Amazon Resource Name (ARN) of the fleet. - Fleet *string `locationName:"fleet" min:"1" type:"string"` +// SetFailedRequests sets the FailedRequests field's value. +func (s *DescribeSimulationJobBatchOutput) SetFailedRequests(v []*FailedCreateSimulationJobRequest) *DescribeSimulationJobBatchOutput { + s.FailedRequests = v + return s +} - // The Amazon Resource Name (ARN) of the robot. - Robot *string `locationName:"robot" min:"1" type:"string"` +// SetFailureCode sets the FailureCode field's value. +func (s *DescribeSimulationJobBatchOutput) SetFailureCode(v string) *DescribeSimulationJobBatchOutput { + s.FailureCode = &v + return s } -// String returns the string representation -func (s DeregisterRobotOutput) String() string { - return awsutil.Prettify(s) +// SetFailureReason sets the FailureReason field's value. +func (s *DescribeSimulationJobBatchOutput) SetFailureReason(v string) *DescribeSimulationJobBatchOutput { + s.FailureReason = &v + return s } -// GoString returns the string representation -func (s DeregisterRobotOutput) GoString() string { - return s.String() +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *DescribeSimulationJobBatchOutput) SetLastUpdatedAt(v time.Time) *DescribeSimulationJobBatchOutput { + s.LastUpdatedAt = &v + return s } -// SetFleet sets the Fleet field's value. -func (s *DeregisterRobotOutput) SetFleet(v string) *DeregisterRobotOutput { - s.Fleet = &v +// SetPendingRequests sets the PendingRequests field's value. +func (s *DescribeSimulationJobBatchOutput) SetPendingRequests(v []*SimulationJobRequest) *DescribeSimulationJobBatchOutput { + s.PendingRequests = v return s } -// SetRobot sets the Robot field's value. -func (s *DeregisterRobotOutput) SetRobot(v string) *DeregisterRobotOutput { - s.Robot = &v +// SetStatus sets the Status field's value. +func (s *DescribeSimulationJobBatchOutput) SetStatus(v string) *DescribeSimulationJobBatchOutput { + s.Status = &v return s } -type DescribeDeploymentJobInput struct { +// SetTags sets the Tags field's value. +func (s *DescribeSimulationJobBatchOutput) SetTags(v map[string]*string) *DescribeSimulationJobBatchOutput { + s.Tags = v + return s +} + +type DescribeSimulationJobInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the deployment job. + // The Amazon Resource Name (ARN) of the simulation job to be described. // // Job is a required field Job *string `locationName:"job" min:"1" type:"string" required:"true"` } // String returns the string representation -func (s DescribeDeploymentJobInput) String() string { +func (s DescribeSimulationJobInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DescribeDeploymentJobInput) GoString() string { +func (s DescribeSimulationJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeDeploymentJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeDeploymentJobInput"} +func (s *DescribeSimulationJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeSimulationJobInput"} if s.Job == nil { invalidParams.Add(request.NewErrParamRequired("Job")) } @@ -7000,275 +10534,305 @@ func (s *DescribeDeploymentJobInput) Validate() error { } // SetJob sets the Job field's value. -func (s *DescribeDeploymentJobInput) SetJob(v string) *DescribeDeploymentJobInput { +func (s *DescribeSimulationJobInput) SetJob(v string) *DescribeSimulationJobInput { s.Job = &v return s } -type DescribeDeploymentJobOutput struct { +type DescribeSimulationJobOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the deployment job. + // The Amazon Resource Name (ARN) of the simulation job. Arn *string `locationName:"arn" min:"1" type:"string"` - // The time, in milliseconds since the epoch, when the deployment job was created. - CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + // Unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"` - // The deployment application configuration. - DeploymentApplicationConfigs []*DeploymentApplicationConfig `locationName:"deploymentApplicationConfigs" min:"1" type:"list"` + // Compute information for the simulation job. + Compute *ComputeResponse `locationName:"compute" type:"structure"` - // The deployment configuration. - DeploymentConfig *DeploymentConfig `locationName:"deploymentConfig" type:"structure"` + // The data sources for the simulation job. + DataSources []*DataSource `locationName:"dataSources" type:"list"` - // The deployment job failure code. - FailureCode *string `locationName:"failureCode" type:"string" enum:"DeploymentJobErrorCode"` + // The failure behavior for the simulation job. + FailureBehavior *string `locationName:"failureBehavior" type:"string" enum:"FailureBehavior"` - // A short description of the reason why the deployment job failed. + // The failure code of the simulation job if it failed: + // + // InternalServiceError + // + // Internal service error. + // + // RobotApplicationCrash + // + // Robot application exited abnormally. + // + // SimulationApplicationCrash + // + // Simulation application exited abnormally. + // + // BadPermissionsRobotApplication + // + // Robot application bundle could not be downloaded. + // + // BadPermissionsSimulationApplication + // + // Simulation application bundle could not be downloaded. + // + // BadPermissionsS3Output + // + // Unable to publish outputs to customer-provided S3 bucket. + // + // BadPermissionsCloudwatchLogs + // + // Unable to publish logs to customer-provided CloudWatch Logs resource. + // + // SubnetIpLimitExceeded + // + // Subnet IP limit exceeded. + // + // ENILimitExceeded + // + // ENI limit exceeded. + // + // BadPermissionsUserCredentials + // + // Unable to use the Role provided. + // + // InvalidBundleRobotApplication + // + // Robot bundle cannot be extracted (invalid format, bundling error, or other + // issue). + // + // InvalidBundleSimulationApplication + // + // Simulation bundle cannot be extracted (invalid format, bundling error, or + // other issue). + // + // RobotApplicationVersionMismatchedEtag + // + // Etag for RobotApplication does not match value during version creation. + // + // SimulationApplicationVersionMismatchedEtag + // + // Etag for SimulationApplication does not match value during version creation. + FailureCode *string `locationName:"failureCode" type:"string" enum:"SimulationJobErrorCode"` + + // Details about why the simulation job failed. For more information about troubleshooting, + // see Troubleshooting (https://docs.aws.amazon.com/robomaker/latest/dg/troubleshooting.html). FailureReason *string `locationName:"failureReason" type:"string"` - // The Amazon Resource Name (ARN) of the fleet. - Fleet *string `locationName:"fleet" min:"1" type:"string"` + // The IAM role that allows the simulation instance to call the AWS APIs that + // are specified in its associated policies on your behalf. + IamRole *string `locationName:"iamRole" min:"1" type:"string"` - // A list of robot deployment summaries. - RobotDeploymentSummary []*RobotDeployment `locationName:"robotDeploymentSummary" type:"list"` + // The time, in milliseconds since the epoch, when the simulation job was last + // started. + LastStartedAt *time.Time `locationName:"lastStartedAt" type:"timestamp"` - // The status of the deployment job. - Status *string `locationName:"status" type:"string" enum:"DeploymentStatus"` + // The time, in milliseconds since the epoch, when the simulation job was last + // updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` - // The list of all tags added to the specified deployment job. + // The logging configuration. + LoggingConfig *LoggingConfig `locationName:"loggingConfig" type:"structure"` + + // The maximum job duration in seconds. The value must be 8 days (691,200 seconds) + // or less. + MaxJobDurationInSeconds *int64 `locationName:"maxJobDurationInSeconds" type:"long"` + + // The name of the simulation job. + Name *string `locationName:"name" min:"1" type:"string"` + + // The network interface information for the simulation job. + NetworkInterface *NetworkInterface `locationName:"networkInterface" type:"structure"` + + // Location for output files generated by the simulation job. + OutputLocation *OutputLocation `locationName:"outputLocation" type:"structure"` + + // A list of robot applications. + RobotApplications []*RobotApplicationConfig `locationName:"robotApplications" min:"1" type:"list"` + + // A list of simulation applications. + SimulationApplications []*SimulationApplicationConfig `locationName:"simulationApplications" min:"1" type:"list"` + + // The simulation job execution duration in milliseconds. + SimulationTimeMillis *int64 `locationName:"simulationTimeMillis" type:"long"` + + // The status of the simulation job. + Status *string `locationName:"status" type:"string" enum:"SimulationJobStatus"` + + // The list of all tags added to the specified simulation job. Tags map[string]*string `locationName:"tags" type:"map"` + + // The VPC configuration. + VpcConfig *VPCConfigResponse `locationName:"vpcConfig" type:"structure"` } // String returns the string representation -func (s DescribeDeploymentJobOutput) String() string { +func (s DescribeSimulationJobOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DescribeDeploymentJobOutput) GoString() string { +func (s DescribeSimulationJobOutput) GoString() string { return s.String() } // SetArn sets the Arn field's value. -func (s *DescribeDeploymentJobOutput) SetArn(v string) *DescribeDeploymentJobOutput { +func (s *DescribeSimulationJobOutput) SetArn(v string) *DescribeSimulationJobOutput { s.Arn = &v return s } -// SetCreatedAt sets the CreatedAt field's value. -func (s *DescribeDeploymentJobOutput) SetCreatedAt(v time.Time) *DescribeDeploymentJobOutput { - s.CreatedAt = &v +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *DescribeSimulationJobOutput) SetClientRequestToken(v string) *DescribeSimulationJobOutput { + s.ClientRequestToken = &v + return s +} + +// SetCompute sets the Compute field's value. +func (s *DescribeSimulationJobOutput) SetCompute(v *ComputeResponse) *DescribeSimulationJobOutput { + s.Compute = v return s } -// SetDeploymentApplicationConfigs sets the DeploymentApplicationConfigs field's value. -func (s *DescribeDeploymentJobOutput) SetDeploymentApplicationConfigs(v []*DeploymentApplicationConfig) *DescribeDeploymentJobOutput { - s.DeploymentApplicationConfigs = v +// SetDataSources sets the DataSources field's value. +func (s *DescribeSimulationJobOutput) SetDataSources(v []*DataSource) *DescribeSimulationJobOutput { + s.DataSources = v return s } -// SetDeploymentConfig sets the DeploymentConfig field's value. -func (s *DescribeDeploymentJobOutput) SetDeploymentConfig(v *DeploymentConfig) *DescribeDeploymentJobOutput { - s.DeploymentConfig = v +// SetFailureBehavior sets the FailureBehavior field's value. +func (s *DescribeSimulationJobOutput) SetFailureBehavior(v string) *DescribeSimulationJobOutput { + s.FailureBehavior = &v return s } // SetFailureCode sets the FailureCode field's value. -func (s *DescribeDeploymentJobOutput) SetFailureCode(v string) *DescribeDeploymentJobOutput { +func (s *DescribeSimulationJobOutput) SetFailureCode(v string) *DescribeSimulationJobOutput { s.FailureCode = &v return s } // SetFailureReason sets the FailureReason field's value. -func (s *DescribeDeploymentJobOutput) SetFailureReason(v string) *DescribeDeploymentJobOutput { +func (s *DescribeSimulationJobOutput) SetFailureReason(v string) *DescribeSimulationJobOutput { s.FailureReason = &v return s } -// SetFleet sets the Fleet field's value. -func (s *DescribeDeploymentJobOutput) SetFleet(v string) *DescribeDeploymentJobOutput { - s.Fleet = &v +// SetIamRole sets the IamRole field's value. +func (s *DescribeSimulationJobOutput) SetIamRole(v string) *DescribeSimulationJobOutput { + s.IamRole = &v return s } -// SetRobotDeploymentSummary sets the RobotDeploymentSummary field's value. -func (s *DescribeDeploymentJobOutput) SetRobotDeploymentSummary(v []*RobotDeployment) *DescribeDeploymentJobOutput { - s.RobotDeploymentSummary = v +// SetLastStartedAt sets the LastStartedAt field's value. +func (s *DescribeSimulationJobOutput) SetLastStartedAt(v time.Time) *DescribeSimulationJobOutput { + s.LastStartedAt = &v return s } -// SetStatus sets the Status field's value. -func (s *DescribeDeploymentJobOutput) SetStatus(v string) *DescribeDeploymentJobOutput { - s.Status = &v +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *DescribeSimulationJobOutput) SetLastUpdatedAt(v time.Time) *DescribeSimulationJobOutput { + s.LastUpdatedAt = &v return s } -// SetTags sets the Tags field's value. -func (s *DescribeDeploymentJobOutput) SetTags(v map[string]*string) *DescribeDeploymentJobOutput { - s.Tags = v +// SetLoggingConfig sets the LoggingConfig field's value. +func (s *DescribeSimulationJobOutput) SetLoggingConfig(v *LoggingConfig) *DescribeSimulationJobOutput { + s.LoggingConfig = v return s } -type DescribeFleetInput struct { - _ struct{} `type:"structure"` - - // The Amazon Resource Name (ARN) of the fleet. - // - // Fleet is a required field - Fleet *string `locationName:"fleet" min:"1" type:"string" required:"true"` -} - -// String returns the string representation -func (s DescribeFleetInput) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s DescribeFleetInput) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeFleetInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeFleetInput"} - if s.Fleet == nil { - invalidParams.Add(request.NewErrParamRequired("Fleet")) - } - if s.Fleet != nil && len(*s.Fleet) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Fleet", 1)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetFleet sets the Fleet field's value. -func (s *DescribeFleetInput) SetFleet(v string) *DescribeFleetInput { - s.Fleet = &v +// SetMaxJobDurationInSeconds sets the MaxJobDurationInSeconds field's value. +func (s *DescribeSimulationJobOutput) SetMaxJobDurationInSeconds(v int64) *DescribeSimulationJobOutput { + s.MaxJobDurationInSeconds = &v return s } -type DescribeFleetOutput struct { - _ struct{} `type:"structure"` - - // The Amazon Resource Name (ARN) of the fleet. - Arn *string `locationName:"arn" min:"1" type:"string"` - - // The time, in milliseconds since the epoch, when the fleet was created. - CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - - // The Amazon Resource Name (ARN) of the last deployment job. - LastDeploymentJob *string `locationName:"lastDeploymentJob" min:"1" type:"string"` - - // The status of the last deployment. - LastDeploymentStatus *string `locationName:"lastDeploymentStatus" type:"string" enum:"DeploymentStatus"` - - // The time of the last deployment. - LastDeploymentTime *time.Time `locationName:"lastDeploymentTime" type:"timestamp"` - - // The name of the fleet. - Name *string `locationName:"name" min:"1" type:"string"` - - // A list of robots. - Robots []*Robot `locationName:"robots" type:"list"` - - // The list of all tags added to the specified fleet. - Tags map[string]*string `locationName:"tags" type:"map"` -} - -// String returns the string representation -func (s DescribeFleetOutput) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s DescribeFleetOutput) GoString() string { - return s.String() -} - -// SetArn sets the Arn field's value. -func (s *DescribeFleetOutput) SetArn(v string) *DescribeFleetOutput { - s.Arn = &v +// SetName sets the Name field's value. +func (s *DescribeSimulationJobOutput) SetName(v string) *DescribeSimulationJobOutput { + s.Name = &v return s } -// SetCreatedAt sets the CreatedAt field's value. -func (s *DescribeFleetOutput) SetCreatedAt(v time.Time) *DescribeFleetOutput { - s.CreatedAt = &v +// SetNetworkInterface sets the NetworkInterface field's value. +func (s *DescribeSimulationJobOutput) SetNetworkInterface(v *NetworkInterface) *DescribeSimulationJobOutput { + s.NetworkInterface = v return s } -// SetLastDeploymentJob sets the LastDeploymentJob field's value. -func (s *DescribeFleetOutput) SetLastDeploymentJob(v string) *DescribeFleetOutput { - s.LastDeploymentJob = &v +// SetOutputLocation sets the OutputLocation field's value. +func (s *DescribeSimulationJobOutput) SetOutputLocation(v *OutputLocation) *DescribeSimulationJobOutput { + s.OutputLocation = v return s } -// SetLastDeploymentStatus sets the LastDeploymentStatus field's value. -func (s *DescribeFleetOutput) SetLastDeploymentStatus(v string) *DescribeFleetOutput { - s.LastDeploymentStatus = &v +// SetRobotApplications sets the RobotApplications field's value. +func (s *DescribeSimulationJobOutput) SetRobotApplications(v []*RobotApplicationConfig) *DescribeSimulationJobOutput { + s.RobotApplications = v return s } -// SetLastDeploymentTime sets the LastDeploymentTime field's value. -func (s *DescribeFleetOutput) SetLastDeploymentTime(v time.Time) *DescribeFleetOutput { - s.LastDeploymentTime = &v +// SetSimulationApplications sets the SimulationApplications field's value. +func (s *DescribeSimulationJobOutput) SetSimulationApplications(v []*SimulationApplicationConfig) *DescribeSimulationJobOutput { + s.SimulationApplications = v return s } -// SetName sets the Name field's value. -func (s *DescribeFleetOutput) SetName(v string) *DescribeFleetOutput { - s.Name = &v +// SetSimulationTimeMillis sets the SimulationTimeMillis field's value. +func (s *DescribeSimulationJobOutput) SetSimulationTimeMillis(v int64) *DescribeSimulationJobOutput { + s.SimulationTimeMillis = &v return s } -// SetRobots sets the Robots field's value. -func (s *DescribeFleetOutput) SetRobots(v []*Robot) *DescribeFleetOutput { - s.Robots = v +// SetStatus sets the Status field's value. +func (s *DescribeSimulationJobOutput) SetStatus(v string) *DescribeSimulationJobOutput { + s.Status = &v return s } // SetTags sets the Tags field's value. -func (s *DescribeFleetOutput) SetTags(v map[string]*string) *DescribeFleetOutput { +func (s *DescribeSimulationJobOutput) SetTags(v map[string]*string) *DescribeSimulationJobOutput { s.Tags = v return s } -type DescribeRobotApplicationInput struct { +// SetVpcConfig sets the VpcConfig field's value. +func (s *DescribeSimulationJobOutput) SetVpcConfig(v *VPCConfigResponse) *DescribeSimulationJobOutput { + s.VpcConfig = v + return s +} + +type DescribeWorldExportJobInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the robot application. + // The Amazon Resource Name (arn) of the world export job to describe. // - // Application is a required field - Application *string `locationName:"application" min:"1" type:"string" required:"true"` - - // The version of the robot application to describe. - ApplicationVersion *string `locationName:"applicationVersion" min:"1" type:"string"` + // Job is a required field + Job *string `locationName:"job" min:"1" type:"string" required:"true"` } // String returns the string representation -func (s DescribeRobotApplicationInput) String() string { +func (s DescribeWorldExportJobInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DescribeRobotApplicationInput) GoString() string { +func (s DescribeWorldExportJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeRobotApplicationInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeRobotApplicationInput"} - if s.Application == nil { - invalidParams.Add(request.NewErrParamRequired("Application")) - } - if s.Application != nil && len(*s.Application) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Application", 1)) +func (s *DescribeWorldExportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeWorldExportJobInput"} + if s.Job == nil { + invalidParams.Add(request.NewErrParamRequired("Job")) } - if s.ApplicationVersion != nil && len(*s.ApplicationVersion) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ApplicationVersion", 1)) + if s.Job != nil && len(*s.Job) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Job", 1)) } if invalidParams.Len() > 0 { @@ -7277,132 +10841,192 @@ func (s *DescribeRobotApplicationInput) Validate() error { return nil } -// SetApplication sets the Application field's value. -func (s *DescribeRobotApplicationInput) SetApplication(v string) *DescribeRobotApplicationInput { - s.Application = &v - return s -} - -// SetApplicationVersion sets the ApplicationVersion field's value. -func (s *DescribeRobotApplicationInput) SetApplicationVersion(v string) *DescribeRobotApplicationInput { - s.ApplicationVersion = &v +// SetJob sets the Job field's value. +func (s *DescribeWorldExportJobInput) SetJob(v string) *DescribeWorldExportJobInput { + s.Job = &v return s } -type DescribeRobotApplicationOutput struct { +type DescribeWorldExportJobOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the robot application. + // The Amazon Resource Name (ARN) of the world export job. Arn *string `locationName:"arn" min:"1" type:"string"` - // The time, in milliseconds since the epoch, when the robot application was - // last updated. - LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` + // Unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"` - // The name of the robot application. - Name *string `locationName:"name" min:"1" type:"string"` + // The time, in milliseconds since the epoch, when the world export job was + // created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The revision id of the robot application. - RevisionId *string `locationName:"revisionId" min:"1" type:"string"` + // The failure code of the world export job if it failed: + // + // InternalServiceError + // + // Internal service error. + // + // LimitExceeded + // + // The requested resource exceeds the maximum number allowed, or the number + // of concurrent stream requests exceeds the maximum number allowed. + // + // ResourceNotFound + // + // The specified resource could not be found. + // + // RequestThrottled + // + // The request was throttled. + // + // InvalidInput + // + // An input parameter in the request is not valid. + FailureCode *string `locationName:"failureCode" type:"string" enum:"WorldExportJobErrorCode"` - // The robot software suite (ROS distribution) used by the robot application. - RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` + // The reason why the world export job failed. + FailureReason *string `locationName:"failureReason" type:"string"` - // The sources of the robot application. - Sources []*Source `locationName:"sources" type:"list"` + // The IAM role that the world export process uses to access the Amazon S3 bucket + // and put the export. + IamRole *string `locationName:"iamRole" min:"1" type:"string"` + + // The output location. + OutputLocation *OutputLocation `locationName:"outputLocation" type:"structure"` + + // The status of the world export job. + // + // Pending + // + // The world export job request is pending. + // + // Running + // + // The world export job is running. + // + // Completed + // + // The world export job completed. + // + // Failed + // + // The world export job failed. See failureCode and failureReason for more information. + // + // Canceled + // + // The world export job was cancelled. + // + // Canceling + // + // The world export job is being cancelled. + Status *string `locationName:"status" type:"string" enum:"WorldExportJobStatus"` - // The list of all tags added to the specified robot application. + // A map that contains tag keys and tag values that are attached to the world + // export job. Tags map[string]*string `locationName:"tags" type:"map"` - // The version of the robot application. - Version *string `locationName:"version" min:"1" type:"string"` + // A list of Amazon Resource Names (arns) that correspond to worlds to be exported. + Worlds []*string `locationName:"worlds" min:"1" type:"list"` } // String returns the string representation -func (s DescribeRobotApplicationOutput) String() string { +func (s DescribeWorldExportJobOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DescribeRobotApplicationOutput) GoString() string { +func (s DescribeWorldExportJobOutput) GoString() string { return s.String() } // SetArn sets the Arn field's value. -func (s *DescribeRobotApplicationOutput) SetArn(v string) *DescribeRobotApplicationOutput { +func (s *DescribeWorldExportJobOutput) SetArn(v string) *DescribeWorldExportJobOutput { s.Arn = &v return s } -// SetLastUpdatedAt sets the LastUpdatedAt field's value. -func (s *DescribeRobotApplicationOutput) SetLastUpdatedAt(v time.Time) *DescribeRobotApplicationOutput { - s.LastUpdatedAt = &v +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *DescribeWorldExportJobOutput) SetClientRequestToken(v string) *DescribeWorldExportJobOutput { + s.ClientRequestToken = &v return s } -// SetName sets the Name field's value. -func (s *DescribeRobotApplicationOutput) SetName(v string) *DescribeRobotApplicationOutput { - s.Name = &v +// SetCreatedAt sets the CreatedAt field's value. +func (s *DescribeWorldExportJobOutput) SetCreatedAt(v time.Time) *DescribeWorldExportJobOutput { + s.CreatedAt = &v return s } -// SetRevisionId sets the RevisionId field's value. -func (s *DescribeRobotApplicationOutput) SetRevisionId(v string) *DescribeRobotApplicationOutput { - s.RevisionId = &v +// SetFailureCode sets the FailureCode field's value. +func (s *DescribeWorldExportJobOutput) SetFailureCode(v string) *DescribeWorldExportJobOutput { + s.FailureCode = &v return s } -// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. -func (s *DescribeRobotApplicationOutput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *DescribeRobotApplicationOutput { - s.RobotSoftwareSuite = v +// SetFailureReason sets the FailureReason field's value. +func (s *DescribeWorldExportJobOutput) SetFailureReason(v string) *DescribeWorldExportJobOutput { + s.FailureReason = &v return s } -// SetSources sets the Sources field's value. -func (s *DescribeRobotApplicationOutput) SetSources(v []*Source) *DescribeRobotApplicationOutput { - s.Sources = v +// SetIamRole sets the IamRole field's value. +func (s *DescribeWorldExportJobOutput) SetIamRole(v string) *DescribeWorldExportJobOutput { + s.IamRole = &v + return s +} + +// SetOutputLocation sets the OutputLocation field's value. +func (s *DescribeWorldExportJobOutput) SetOutputLocation(v *OutputLocation) *DescribeWorldExportJobOutput { + s.OutputLocation = v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeWorldExportJobOutput) SetStatus(v string) *DescribeWorldExportJobOutput { + s.Status = &v return s } // SetTags sets the Tags field's value. -func (s *DescribeRobotApplicationOutput) SetTags(v map[string]*string) *DescribeRobotApplicationOutput { +func (s *DescribeWorldExportJobOutput) SetTags(v map[string]*string) *DescribeWorldExportJobOutput { s.Tags = v return s } -// SetVersion sets the Version field's value. -func (s *DescribeRobotApplicationOutput) SetVersion(v string) *DescribeRobotApplicationOutput { - s.Version = &v +// SetWorlds sets the Worlds field's value. +func (s *DescribeWorldExportJobOutput) SetWorlds(v []*string) *DescribeWorldExportJobOutput { + s.Worlds = v return s } -type DescribeRobotInput struct { +type DescribeWorldGenerationJobInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the robot to be described. + // The Amazon Resource Name (arn) of the world generation job to describe. // - // Robot is a required field - Robot *string `locationName:"robot" min:"1" type:"string" required:"true"` + // Job is a required field + Job *string `locationName:"job" min:"1" type:"string" required:"true"` } // String returns the string representation -func (s DescribeRobotInput) String() string { +func (s DescribeWorldGenerationJobInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DescribeRobotInput) GoString() string { +func (s DescribeWorldGenerationJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeRobotInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeRobotInput"} - if s.Robot == nil { - invalidParams.Add(request.NewErrParamRequired("Robot")) +func (s *DescribeWorldGenerationJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeWorldGenerationJobInput"} + if s.Job == nil { + invalidParams.Add(request.NewErrParamRequired("Job")) } - if s.Robot != nil && len(*s.Robot) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Robot", 1)) + if s.Job != nil && len(*s.Job) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Job", 1)) } if invalidParams.Len() > 0 { @@ -7411,301 +11035,296 @@ func (s *DescribeRobotInput) Validate() error { return nil } -// SetRobot sets the Robot field's value. -func (s *DescribeRobotInput) SetRobot(v string) *DescribeRobotInput { - s.Robot = &v +// SetJob sets the Job field's value. +func (s *DescribeWorldGenerationJobInput) SetJob(v string) *DescribeWorldGenerationJobInput { + s.Job = &v return s } -type DescribeRobotOutput struct { +type DescribeWorldGenerationJobOutput struct { _ struct{} `type:"structure"` - // The target architecture of the robot application. - Architecture *string `locationName:"architecture" type:"string" enum:"Architecture"` - - // The Amazon Resource Name (ARN) of the robot. + // The Amazon Resource Name (ARN) of the world generation job. Arn *string `locationName:"arn" min:"1" type:"string"` - // The time, in milliseconds since the epoch, when the robot was created. + // Unique, case-sensitive identifier that you provide to ensure the idempotency + // of the request. + ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"` + + // The time, in milliseconds since the epoch, when the world generation job + // was created. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The Amazon Resource Name (ARN) of the fleet. - FleetArn *string `locationName:"fleetArn" min:"1" type:"string"` + // The failure code of the world generation job if it failed: + // + // InternalServiceError + // + // Internal service error. + // + // LimitExceeded + // + // The requested resource exceeds the maximum number allowed, or the number + // of concurrent stream requests exceeds the maximum number allowed. + // + // ResourceNotFound + // + // The specified resource could not be found. + // + // RequestThrottled + // + // The request was throttled. + // + // InvalidInput + // + // An input parameter in the request is not valid. + FailureCode *string `locationName:"failureCode" type:"string" enum:"WorldGenerationJobErrorCode"` - // The Greengrass group id. - GreengrassGroupId *string `locationName:"greengrassGroupId" min:"1" type:"string"` + // The reason why the world generation job failed. + FailureReason *string `locationName:"failureReason" type:"string"` - // The Amazon Resource Name (ARN) of the last deployment job. - LastDeploymentJob *string `locationName:"lastDeploymentJob" min:"1" type:"string"` + // Summary information about finished worlds. + FinishedWorldsSummary *FinishedWorldsSummary `locationName:"finishedWorldsSummary" type:"structure"` - // The time of the last deployment job. - LastDeploymentTime *time.Time `locationName:"lastDeploymentTime" type:"timestamp"` + // The status of the world generation job: + // + // Pending + // + // The world generation job request is pending. + // + // Running + // + // The world generation job is running. + // + // Completed + // + // The world generation job completed. + // + // Failed + // + // The world generation job failed. See failureCode for more information. + // + // PartialFailed + // + // Some worlds did not generate. + // + // Canceled + // + // The world generation job was cancelled. + // + // Canceling + // + // The world generation job is being cancelled. + Status *string `locationName:"status" type:"string" enum:"WorldGenerationJobStatus"` - // The name of the robot. - Name *string `locationName:"name" min:"1" type:"string"` + // A map that contains tag keys and tag values that are attached to the world + // generation job. + Tags map[string]*string `locationName:"tags" type:"map"` - // The status of the fleet. - Status *string `locationName:"status" type:"string" enum:"RobotStatus"` + // The Amazon Resource Name (arn) of the world template. + Template *string `locationName:"template" min:"1" type:"string"` - // The list of all tags added to the specified robot. - Tags map[string]*string `locationName:"tags" type:"map"` + // Information about the world count. + WorldCount *WorldCount `locationName:"worldCount" type:"structure"` } // String returns the string representation -func (s DescribeRobotOutput) String() string { +func (s DescribeWorldGenerationJobOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DescribeRobotOutput) GoString() string { +func (s DescribeWorldGenerationJobOutput) GoString() string { return s.String() } -// SetArchitecture sets the Architecture field's value. -func (s *DescribeRobotOutput) SetArchitecture(v string) *DescribeRobotOutput { - s.Architecture = &v - return s -} - // SetArn sets the Arn field's value. -func (s *DescribeRobotOutput) SetArn(v string) *DescribeRobotOutput { +func (s *DescribeWorldGenerationJobOutput) SetArn(v string) *DescribeWorldGenerationJobOutput { s.Arn = &v return s } -// SetCreatedAt sets the CreatedAt field's value. -func (s *DescribeRobotOutput) SetCreatedAt(v time.Time) *DescribeRobotOutput { - s.CreatedAt = &v - return s -} - -// SetFleetArn sets the FleetArn field's value. -func (s *DescribeRobotOutput) SetFleetArn(v string) *DescribeRobotOutput { - s.FleetArn = &v +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *DescribeWorldGenerationJobOutput) SetClientRequestToken(v string) *DescribeWorldGenerationJobOutput { + s.ClientRequestToken = &v return s } -// SetGreengrassGroupId sets the GreengrassGroupId field's value. -func (s *DescribeRobotOutput) SetGreengrassGroupId(v string) *DescribeRobotOutput { - s.GreengrassGroupId = &v +// SetCreatedAt sets the CreatedAt field's value. +func (s *DescribeWorldGenerationJobOutput) SetCreatedAt(v time.Time) *DescribeWorldGenerationJobOutput { + s.CreatedAt = &v return s } -// SetLastDeploymentJob sets the LastDeploymentJob field's value. -func (s *DescribeRobotOutput) SetLastDeploymentJob(v string) *DescribeRobotOutput { - s.LastDeploymentJob = &v +// SetFailureCode sets the FailureCode field's value. +func (s *DescribeWorldGenerationJobOutput) SetFailureCode(v string) *DescribeWorldGenerationJobOutput { + s.FailureCode = &v return s } -// SetLastDeploymentTime sets the LastDeploymentTime field's value. -func (s *DescribeRobotOutput) SetLastDeploymentTime(v time.Time) *DescribeRobotOutput { - s.LastDeploymentTime = &v +// SetFailureReason sets the FailureReason field's value. +func (s *DescribeWorldGenerationJobOutput) SetFailureReason(v string) *DescribeWorldGenerationJobOutput { + s.FailureReason = &v return s } -// SetName sets the Name field's value. -func (s *DescribeRobotOutput) SetName(v string) *DescribeRobotOutput { - s.Name = &v +// SetFinishedWorldsSummary sets the FinishedWorldsSummary field's value. +func (s *DescribeWorldGenerationJobOutput) SetFinishedWorldsSummary(v *FinishedWorldsSummary) *DescribeWorldGenerationJobOutput { + s.FinishedWorldsSummary = v return s } // SetStatus sets the Status field's value. -func (s *DescribeRobotOutput) SetStatus(v string) *DescribeRobotOutput { +func (s *DescribeWorldGenerationJobOutput) SetStatus(v string) *DescribeWorldGenerationJobOutput { s.Status = &v return s } // SetTags sets the Tags field's value. -func (s *DescribeRobotOutput) SetTags(v map[string]*string) *DescribeRobotOutput { +func (s *DescribeWorldGenerationJobOutput) SetTags(v map[string]*string) *DescribeWorldGenerationJobOutput { s.Tags = v return s } -type DescribeSimulationApplicationInput struct { - _ struct{} `type:"structure"` - - // The application information for the simulation application. - // - // Application is a required field - Application *string `locationName:"application" min:"1" type:"string" required:"true"` - - // The version of the simulation application to describe. - ApplicationVersion *string `locationName:"applicationVersion" min:"1" type:"string"` -} - -// String returns the string representation -func (s DescribeSimulationApplicationInput) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s DescribeSimulationApplicationInput) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeSimulationApplicationInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeSimulationApplicationInput"} - if s.Application == nil { - invalidParams.Add(request.NewErrParamRequired("Application")) - } - if s.Application != nil && len(*s.Application) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Application", 1)) - } - if s.ApplicationVersion != nil && len(*s.ApplicationVersion) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ApplicationVersion", 1)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetApplication sets the Application field's value. -func (s *DescribeSimulationApplicationInput) SetApplication(v string) *DescribeSimulationApplicationInput { - s.Application = &v +// SetTemplate sets the Template field's value. +func (s *DescribeWorldGenerationJobOutput) SetTemplate(v string) *DescribeWorldGenerationJobOutput { + s.Template = &v return s } -// SetApplicationVersion sets the ApplicationVersion field's value. -func (s *DescribeSimulationApplicationInput) SetApplicationVersion(v string) *DescribeSimulationApplicationInput { - s.ApplicationVersion = &v +// SetWorldCount sets the WorldCount field's value. +func (s *DescribeWorldGenerationJobOutput) SetWorldCount(v *WorldCount) *DescribeWorldGenerationJobOutput { + s.WorldCount = v return s } -type DescribeSimulationApplicationOutput struct { - _ struct{} `type:"structure"` - - // The Amazon Resource Name (ARN) of the robot simulation application. - Arn *string `locationName:"arn" min:"1" type:"string"` - - // The time, in milliseconds since the epoch, when the simulation application - // was last updated. - LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` - - // The name of the simulation application. - Name *string `locationName:"name" min:"1" type:"string"` - - // The rendering engine for the simulation application. - RenderingEngine *RenderingEngine `locationName:"renderingEngine" type:"structure"` - - // The revision id of the simulation application. - RevisionId *string `locationName:"revisionId" min:"1" type:"string"` - - // Information about the robot software suite (ROS distribution). - RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` - - // The simulation software suite used by the simulation application. - SimulationSoftwareSuite *SimulationSoftwareSuite `locationName:"simulationSoftwareSuite" type:"structure"` - - // The sources of the simulation application. - Sources []*Source `locationName:"sources" type:"list"` - - // The list of all tags added to the specified simulation application. - Tags map[string]*string `locationName:"tags" type:"map"` +type DescribeWorldInput struct { + _ struct{} `type:"structure"` - // The version of the simulation application. - Version *string `locationName:"version" min:"1" type:"string"` + // The Amazon Resource Name (arn) of the world you want to describe. + // + // World is a required field + World *string `locationName:"world" min:"1" type:"string" required:"true"` } // String returns the string representation -func (s DescribeSimulationApplicationOutput) String() string { +func (s DescribeWorldInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DescribeSimulationApplicationOutput) GoString() string { +func (s DescribeWorldInput) GoString() string { return s.String() } -// SetArn sets the Arn field's value. -func (s *DescribeSimulationApplicationOutput) SetArn(v string) *DescribeSimulationApplicationOutput { - s.Arn = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeWorldInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeWorldInput"} + if s.World == nil { + invalidParams.Add(request.NewErrParamRequired("World")) + } + if s.World != nil && len(*s.World) < 1 { + invalidParams.Add(request.NewErrParamMinLen("World", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetLastUpdatedAt sets the LastUpdatedAt field's value. -func (s *DescribeSimulationApplicationOutput) SetLastUpdatedAt(v time.Time) *DescribeSimulationApplicationOutput { - s.LastUpdatedAt = &v +// SetWorld sets the World field's value. +func (s *DescribeWorldInput) SetWorld(v string) *DescribeWorldInput { + s.World = &v return s } -// SetName sets the Name field's value. -func (s *DescribeSimulationApplicationOutput) SetName(v string) *DescribeSimulationApplicationOutput { - s.Name = &v - return s +type DescribeWorldOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (arn) of the world. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // The time, in milliseconds since the epoch, when the world was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + + // The Amazon Resource Name (arn) of the world generation job that generated + // the world. + GenerationJob *string `locationName:"generationJob" min:"1" type:"string"` + + // A map that contains tag keys and tag values that are attached to the world. + Tags map[string]*string `locationName:"tags" type:"map"` + + // The world template. + Template *string `locationName:"template" min:"1" type:"string"` } -// SetRenderingEngine sets the RenderingEngine field's value. -func (s *DescribeSimulationApplicationOutput) SetRenderingEngine(v *RenderingEngine) *DescribeSimulationApplicationOutput { - s.RenderingEngine = v - return s +// String returns the string representation +func (s DescribeWorldOutput) String() string { + return awsutil.Prettify(s) } -// SetRevisionId sets the RevisionId field's value. -func (s *DescribeSimulationApplicationOutput) SetRevisionId(v string) *DescribeSimulationApplicationOutput { - s.RevisionId = &v - return s +// GoString returns the string representation +func (s DescribeWorldOutput) GoString() string { + return s.String() } -// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. -func (s *DescribeSimulationApplicationOutput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *DescribeSimulationApplicationOutput { - s.RobotSoftwareSuite = v +// SetArn sets the Arn field's value. +func (s *DescribeWorldOutput) SetArn(v string) *DescribeWorldOutput { + s.Arn = &v return s } -// SetSimulationSoftwareSuite sets the SimulationSoftwareSuite field's value. -func (s *DescribeSimulationApplicationOutput) SetSimulationSoftwareSuite(v *SimulationSoftwareSuite) *DescribeSimulationApplicationOutput { - s.SimulationSoftwareSuite = v +// SetCreatedAt sets the CreatedAt field's value. +func (s *DescribeWorldOutput) SetCreatedAt(v time.Time) *DescribeWorldOutput { + s.CreatedAt = &v return s } -// SetSources sets the Sources field's value. -func (s *DescribeSimulationApplicationOutput) SetSources(v []*Source) *DescribeSimulationApplicationOutput { - s.Sources = v +// SetGenerationJob sets the GenerationJob field's value. +func (s *DescribeWorldOutput) SetGenerationJob(v string) *DescribeWorldOutput { + s.GenerationJob = &v return s } // SetTags sets the Tags field's value. -func (s *DescribeSimulationApplicationOutput) SetTags(v map[string]*string) *DescribeSimulationApplicationOutput { +func (s *DescribeWorldOutput) SetTags(v map[string]*string) *DescribeWorldOutput { s.Tags = v return s } -// SetVersion sets the Version field's value. -func (s *DescribeSimulationApplicationOutput) SetVersion(v string) *DescribeSimulationApplicationOutput { - s.Version = &v +// SetTemplate sets the Template field's value. +func (s *DescribeWorldOutput) SetTemplate(v string) *DescribeWorldOutput { + s.Template = &v return s } -type DescribeSimulationJobBatchInput struct { +type DescribeWorldTemplateInput struct { _ struct{} `type:"structure"` - // The id of the batch to describe. + // The Amazon Resource Name (arn) of the world template you want to describe. // - // Batch is a required field - Batch *string `locationName:"batch" min:"1" type:"string" required:"true"` + // Template is a required field + Template *string `locationName:"template" min:"1" type:"string" required:"true"` } // String returns the string representation -func (s DescribeSimulationJobBatchInput) String() string { +func (s DescribeWorldTemplateInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DescribeSimulationJobBatchInput) GoString() string { +func (s DescribeWorldTemplateInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeSimulationJobBatchInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeSimulationJobBatchInput"} - if s.Batch == nil { - invalidParams.Add(request.NewErrParamRequired("Batch")) +func (s *DescribeWorldTemplateInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeWorldTemplateInput"} + if s.Template == nil { + invalidParams.Add(request.NewErrParamRequired("Template")) } - if s.Batch != nil && len(*s.Batch) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Batch", 1)) + if s.Template != nil && len(*s.Template) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Template", 1)) } if invalidParams.Len() > 0 { @@ -7714,214 +11333,197 @@ func (s *DescribeSimulationJobBatchInput) Validate() error { return nil } -// SetBatch sets the Batch field's value. -func (s *DescribeSimulationJobBatchInput) SetBatch(v string) *DescribeSimulationJobBatchInput { - s.Batch = &v +// SetTemplate sets the Template field's value. +func (s *DescribeWorldTemplateInput) SetTemplate(v string) *DescribeWorldTemplateInput { + s.Template = &v return s } -type DescribeSimulationJobBatchOutput struct { +type DescribeWorldTemplateOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the batch. + // The Amazon Resource Name (ARN) of the world template. Arn *string `locationName:"arn" min:"1" type:"string"` - // The batch policy. - BatchPolicy *BatchPolicy `locationName:"batchPolicy" type:"structure"` - // Unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"` - // The time, in milliseconds since the epoch, when the simulation job batch - // was created. + // The time, in milliseconds since the epoch, when the world template was created. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // A list of created simulation job summaries. - CreatedRequests []*SimulationJobSummary `locationName:"createdRequests" type:"list"` - - // A list of failed create simulation job requests. The request failed to be - // created into a simulation job. Failed requests do not have a simulation job - // ID. - FailedRequests []*FailedCreateSimulationJobRequest `locationName:"failedRequests" type:"list"` - - // The failure code of the simulation job batch. - FailureCode *string `locationName:"failureCode" type:"string" enum:"SimulationJobBatchErrorCode"` - - // The reason the simulation job batch failed. - FailureReason *string `locationName:"failureReason" type:"string"` - - // The time, in milliseconds since the epoch, when the simulation job batch - // was last updated. + // The time, in milliseconds since the epoch, when the world template was last + // updated. LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` - // A list of pending simulation job requests. These requests have not yet been - // created into simulation jobs. - PendingRequests []*SimulationJobRequest `locationName:"pendingRequests" min:"1" type:"list"` - - // The status of the batch. - // - // Pending - // - // The simulation job batch request is pending. - // - // InProgress - // - // The simulation job batch is in progress. - // - // Failed - // - // The simulation job batch failed. One or more simulation job requests could - // not be completed due to an internal failure (like InternalServiceError). - // See failureCode and failureReason for more information. - // - // Completed - // - // The simulation batch job completed. A batch is complete when (1) there are - // no pending simulation job requests in the batch and none of the failed simulation - // job requests are due to InternalServiceError and (2) when all created simulation - // jobs have reached a terminal state (for example, Completed or Failed). - // - // Canceled - // - // The simulation batch job was cancelled. - // - // Canceling - // - // The simulation batch job is being cancelled. - // - // Completing - // - // The simulation batch job is completing. - // - // TimingOut - // - // The simulation job batch is timing out. - // - // If a batch timing out, and there are pending requests that were failing due - // to an internal failure (like InternalServiceError), the batch status will - // be Failed. If there are no such failing request, the batch status will be - // TimedOut. - // - // TimedOut - // - // The simulation batch job timed out. - Status *string `locationName:"status" type:"string" enum:"SimulationJobBatchStatus"` + // The name of the world template. + Name *string `locationName:"name" type:"string"` - // A map that contains tag keys and tag values that are attached to the simulation - // job batch. + // A map that contains tag keys and tag values that are attached to the world + // template. Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation -func (s DescribeSimulationJobBatchOutput) String() string { +func (s DescribeWorldTemplateOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DescribeSimulationJobBatchOutput) GoString() string { +func (s DescribeWorldTemplateOutput) GoString() string { return s.String() } // SetArn sets the Arn field's value. -func (s *DescribeSimulationJobBatchOutput) SetArn(v string) *DescribeSimulationJobBatchOutput { +func (s *DescribeWorldTemplateOutput) SetArn(v string) *DescribeWorldTemplateOutput { s.Arn = &v return s } -// SetBatchPolicy sets the BatchPolicy field's value. -func (s *DescribeSimulationJobBatchOutput) SetBatchPolicy(v *BatchPolicy) *DescribeSimulationJobBatchOutput { - s.BatchPolicy = v - return s -} - // SetClientRequestToken sets the ClientRequestToken field's value. -func (s *DescribeSimulationJobBatchOutput) SetClientRequestToken(v string) *DescribeSimulationJobBatchOutput { +func (s *DescribeWorldTemplateOutput) SetClientRequestToken(v string) *DescribeWorldTemplateOutput { s.ClientRequestToken = &v return s } // SetCreatedAt sets the CreatedAt field's value. -func (s *DescribeSimulationJobBatchOutput) SetCreatedAt(v time.Time) *DescribeSimulationJobBatchOutput { +func (s *DescribeWorldTemplateOutput) SetCreatedAt(v time.Time) *DescribeWorldTemplateOutput { s.CreatedAt = &v return s } -// SetCreatedRequests sets the CreatedRequests field's value. -func (s *DescribeSimulationJobBatchOutput) SetCreatedRequests(v []*SimulationJobSummary) *DescribeSimulationJobBatchOutput { - s.CreatedRequests = v +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *DescribeWorldTemplateOutput) SetLastUpdatedAt(v time.Time) *DescribeWorldTemplateOutput { + s.LastUpdatedAt = &v return s } -// SetFailedRequests sets the FailedRequests field's value. -func (s *DescribeSimulationJobBatchOutput) SetFailedRequests(v []*FailedCreateSimulationJobRequest) *DescribeSimulationJobBatchOutput { - s.FailedRequests = v +// SetName sets the Name field's value. +func (s *DescribeWorldTemplateOutput) SetName(v string) *DescribeWorldTemplateOutput { + s.Name = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *DescribeWorldTemplateOutput) SetTags(v map[string]*string) *DescribeWorldTemplateOutput { + s.Tags = v + return s +} + +// Information about a failed create simulation job request. +type FailedCreateSimulationJobRequest struct { + _ struct{} `type:"structure"` + + // The time, in milliseconds since the epoch, when the simulation job batch + // failed. + FailedAt *time.Time `locationName:"failedAt" type:"timestamp"` + + // The failure code. + FailureCode *string `locationName:"failureCode" type:"string" enum:"SimulationJobErrorCode"` + + // The failure reason of the simulation job request. + FailureReason *string `locationName:"failureReason" type:"string"` + + // The simulation job request. + Request *SimulationJobRequest `locationName:"request" type:"structure"` +} + +// String returns the string representation +func (s FailedCreateSimulationJobRequest) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s FailedCreateSimulationJobRequest) GoString() string { + return s.String() +} + +// SetFailedAt sets the FailedAt field's value. +func (s *FailedCreateSimulationJobRequest) SetFailedAt(v time.Time) *FailedCreateSimulationJobRequest { + s.FailedAt = &v return s } // SetFailureCode sets the FailureCode field's value. -func (s *DescribeSimulationJobBatchOutput) SetFailureCode(v string) *DescribeSimulationJobBatchOutput { +func (s *FailedCreateSimulationJobRequest) SetFailureCode(v string) *FailedCreateSimulationJobRequest { s.FailureCode = &v return s } // SetFailureReason sets the FailureReason field's value. -func (s *DescribeSimulationJobBatchOutput) SetFailureReason(v string) *DescribeSimulationJobBatchOutput { +func (s *FailedCreateSimulationJobRequest) SetFailureReason(v string) *FailedCreateSimulationJobRequest { s.FailureReason = &v return s } -// SetLastUpdatedAt sets the LastUpdatedAt field's value. -func (s *DescribeSimulationJobBatchOutput) SetLastUpdatedAt(v time.Time) *DescribeSimulationJobBatchOutput { - s.LastUpdatedAt = &v +// SetRequest sets the Request field's value. +func (s *FailedCreateSimulationJobRequest) SetRequest(v *SimulationJobRequest) *FailedCreateSimulationJobRequest { + s.Request = v return s } -// SetPendingRequests sets the PendingRequests field's value. -func (s *DescribeSimulationJobBatchOutput) SetPendingRequests(v []*SimulationJobRequest) *DescribeSimulationJobBatchOutput { - s.PendingRequests = v - return s +// Information about worlds that failed. +type FailureSummary struct { + _ struct{} `type:"structure"` + + // The worlds that failed. + Failures []*WorldFailure `locationName:"failures" type:"list"` + + // The total number of failures. + TotalFailureCount *int64 `locationName:"totalFailureCount" type:"integer"` } -// SetStatus sets the Status field's value. -func (s *DescribeSimulationJobBatchOutput) SetStatus(v string) *DescribeSimulationJobBatchOutput { - s.Status = &v +// String returns the string representation +func (s FailureSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s FailureSummary) GoString() string { + return s.String() +} + +// SetFailures sets the Failures field's value. +func (s *FailureSummary) SetFailures(v []*WorldFailure) *FailureSummary { + s.Failures = v return s } -// SetTags sets the Tags field's value. -func (s *DescribeSimulationJobBatchOutput) SetTags(v map[string]*string) *DescribeSimulationJobBatchOutput { - s.Tags = v +// SetTotalFailureCount sets the TotalFailureCount field's value. +func (s *FailureSummary) SetTotalFailureCount(v int64) *FailureSummary { + s.TotalFailureCount = &v return s } -type DescribeSimulationJobInput struct { +// Information about a filter. +type Filter struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the simulation job to be described. - // - // Job is a required field - Job *string `locationName:"job" min:"1" type:"string" required:"true"` + // The name of the filter. + Name *string `locationName:"name" min:"1" type:"string"` + + // A list of values. + Values []*string `locationName:"values" min:"1" type:"list"` } // String returns the string representation -func (s DescribeSimulationJobInput) String() string { +func (s Filter) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DescribeSimulationJobInput) GoString() string { +func (s Filter) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeSimulationJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeSimulationJobInput"} - if s.Job == nil { - invalidParams.Add(request.NewErrParamRequired("Job")) +func (s *Filter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Filter"} + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } - if s.Job != nil && len(*s.Job) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Job", 1)) + if s.Values != nil && len(s.Values) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Values", 1)) } if invalidParams.Len() > 0 { @@ -7930,453 +11532,468 @@ func (s *DescribeSimulationJobInput) Validate() error { return nil } -// SetJob sets the Job field's value. -func (s *DescribeSimulationJobInput) SetJob(v string) *DescribeSimulationJobInput { - s.Job = &v +// SetName sets the Name field's value. +func (s *Filter) SetName(v string) *Filter { + s.Name = &v return s } -type DescribeSimulationJobOutput struct { - _ struct{} `type:"structure"` - - // The Amazon Resource Name (ARN) of the simulation job. - Arn *string `locationName:"arn" min:"1" type:"string"` - - // Unique, case-sensitive identifier that you provide to ensure the idempotency - // of the request. - ClientRequestToken *string `locationName:"clientRequestToken" min:"1" type:"string"` - - // Compute information for the simulation job. - Compute *ComputeResponse `locationName:"compute" type:"structure"` - - // The data sources for the simulation job. - DataSources []*DataSource `locationName:"dataSources" type:"list"` - - // The failure behavior for the simulation job. - FailureBehavior *string `locationName:"failureBehavior" type:"string" enum:"FailureBehavior"` +// SetValues sets the Values field's value. +func (s *Filter) SetValues(v []*string) *Filter { + s.Values = v + return s +} - // The failure code of the simulation job if it failed: - // - // InternalServiceError - // - // Internal service error. - // - // RobotApplicationCrash - // - // Robot application exited abnormally. - // - // SimulationApplicationCrash - // - // Simulation application exited abnormally. - // - // BadPermissionsRobotApplication - // - // Robot application bundle could not be downloaded. - // - // BadPermissionsSimulationApplication - // - // Simulation application bundle could not be downloaded. - // - // BadPermissionsS3Output - // - // Unable to publish outputs to customer-provided S3 bucket. - // - // BadPermissionsCloudwatchLogs - // - // Unable to publish logs to customer-provided CloudWatch Logs resource. - // - // SubnetIpLimitExceeded - // - // Subnet IP limit exceeded. - // - // ENILimitExceeded - // - // ENI limit exceeded. - // - // BadPermissionsUserCredentials - // - // Unable to use the Role provided. - // - // InvalidBundleRobotApplication - // - // Robot bundle cannot be extracted (invalid format, bundling error, or other - // issue). - // - // InvalidBundleSimulationApplication - // - // Simulation bundle cannot be extracted (invalid format, bundling error, or - // other issue). - // - // RobotApplicationVersionMismatchedEtag - // - // Etag for RobotApplication does not match value during version creation. - // - // SimulationApplicationVersionMismatchedEtag - // - // Etag for SimulationApplication does not match value during version creation. - FailureCode *string `locationName:"failureCode" type:"string" enum:"SimulationJobErrorCode"` +// Information about worlds that finished. +type FinishedWorldsSummary struct { + _ struct{} `type:"structure"` - // Details about why the simulation job failed. For more information about troubleshooting, - // see Troubleshooting (https://docs.aws.amazon.com/robomaker/latest/dg/troubleshooting.html). - FailureReason *string `locationName:"failureReason" type:"string"` + // Information about worlds that failed. + FailureSummary *FailureSummary `locationName:"failureSummary" type:"structure"` - // The IAM role that allows the simulation instance to call the AWS APIs that - // are specified in its associated policies on your behalf. - IamRole *string `locationName:"iamRole" min:"1" type:"string"` + // The total number of finished worlds. + FinishedCount *int64 `locationName:"finishedCount" type:"integer"` - // The time, in milliseconds since the epoch, when the simulation job was last - // started. - LastStartedAt *time.Time `locationName:"lastStartedAt" type:"timestamp"` + // A list of worlds that succeeded. + SucceededWorlds []*string `locationName:"succeededWorlds" min:"1" type:"list"` +} - // The time, in milliseconds since the epoch, when the simulation job was last - // updated. - LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` +// String returns the string representation +func (s FinishedWorldsSummary) String() string { + return awsutil.Prettify(s) +} - // The logging configuration. - LoggingConfig *LoggingConfig `locationName:"loggingConfig" type:"structure"` +// GoString returns the string representation +func (s FinishedWorldsSummary) GoString() string { + return s.String() +} - // The maximum job duration in seconds. The value must be 8 days (691,200 seconds) - // or less. - MaxJobDurationInSeconds *int64 `locationName:"maxJobDurationInSeconds" type:"long"` +// SetFailureSummary sets the FailureSummary field's value. +func (s *FinishedWorldsSummary) SetFailureSummary(v *FailureSummary) *FinishedWorldsSummary { + s.FailureSummary = v + return s +} - // The name of the simulation job. - Name *string `locationName:"name" min:"1" type:"string"` +// SetFinishedCount sets the FinishedCount field's value. +func (s *FinishedWorldsSummary) SetFinishedCount(v int64) *FinishedWorldsSummary { + s.FinishedCount = &v + return s +} - // The network interface information for the simulation job. - NetworkInterface *NetworkInterface `locationName:"networkInterface" type:"structure"` +// SetSucceededWorlds sets the SucceededWorlds field's value. +func (s *FinishedWorldsSummary) SetSucceededWorlds(v []*string) *FinishedWorldsSummary { + s.SucceededWorlds = v + return s +} - // Location for output files generated by the simulation job. - OutputLocation *OutputLocation `locationName:"outputLocation" type:"structure"` +// Information about a fleet. +type Fleet struct { + _ struct{} `type:"structure"` - // A list of robot applications. - RobotApplications []*RobotApplicationConfig `locationName:"robotApplications" min:"1" type:"list"` + // The Amazon Resource Name (ARN) of the fleet. + Arn *string `locationName:"arn" min:"1" type:"string"` - // A list of simulation applications. - SimulationApplications []*SimulationApplicationConfig `locationName:"simulationApplications" min:"1" type:"list"` + // The time, in milliseconds since the epoch, when the fleet was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The simulation job execution duration in milliseconds. - SimulationTimeMillis *int64 `locationName:"simulationTimeMillis" type:"long"` + // The Amazon Resource Name (ARN) of the last deployment job. + LastDeploymentJob *string `locationName:"lastDeploymentJob" min:"1" type:"string"` - // The status of the simulation job. - Status *string `locationName:"status" type:"string" enum:"SimulationJobStatus"` + // The status of the last fleet deployment. + LastDeploymentStatus *string `locationName:"lastDeploymentStatus" type:"string" enum:"DeploymentStatus"` - // The list of all tags added to the specified simulation job. - Tags map[string]*string `locationName:"tags" type:"map"` + // The time of the last deployment. + LastDeploymentTime *time.Time `locationName:"lastDeploymentTime" type:"timestamp"` - // The VPC configuration. - VpcConfig *VPCConfigResponse `locationName:"vpcConfig" type:"structure"` + // The name of the fleet. + Name *string `locationName:"name" min:"1" type:"string"` } // String returns the string representation -func (s DescribeSimulationJobOutput) String() string { +func (s Fleet) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DescribeSimulationJobOutput) GoString() string { +func (s Fleet) GoString() string { return s.String() } // SetArn sets the Arn field's value. -func (s *DescribeSimulationJobOutput) SetArn(v string) *DescribeSimulationJobOutput { +func (s *Fleet) SetArn(v string) *Fleet { s.Arn = &v return s } -// SetClientRequestToken sets the ClientRequestToken field's value. -func (s *DescribeSimulationJobOutput) SetClientRequestToken(v string) *DescribeSimulationJobOutput { - s.ClientRequestToken = &v +// SetCreatedAt sets the CreatedAt field's value. +func (s *Fleet) SetCreatedAt(v time.Time) *Fleet { + s.CreatedAt = &v return s } -// SetCompute sets the Compute field's value. -func (s *DescribeSimulationJobOutput) SetCompute(v *ComputeResponse) *DescribeSimulationJobOutput { - s.Compute = v +// SetLastDeploymentJob sets the LastDeploymentJob field's value. +func (s *Fleet) SetLastDeploymentJob(v string) *Fleet { + s.LastDeploymentJob = &v return s } -// SetDataSources sets the DataSources field's value. -func (s *DescribeSimulationJobOutput) SetDataSources(v []*DataSource) *DescribeSimulationJobOutput { - s.DataSources = v +// SetLastDeploymentStatus sets the LastDeploymentStatus field's value. +func (s *Fleet) SetLastDeploymentStatus(v string) *Fleet { + s.LastDeploymentStatus = &v return s } -// SetFailureBehavior sets the FailureBehavior field's value. -func (s *DescribeSimulationJobOutput) SetFailureBehavior(v string) *DescribeSimulationJobOutput { - s.FailureBehavior = &v +// SetLastDeploymentTime sets the LastDeploymentTime field's value. +func (s *Fleet) SetLastDeploymentTime(v time.Time) *Fleet { + s.LastDeploymentTime = &v return s } -// SetFailureCode sets the FailureCode field's value. -func (s *DescribeSimulationJobOutput) SetFailureCode(v string) *DescribeSimulationJobOutput { - s.FailureCode = &v +// SetName sets the Name field's value. +func (s *Fleet) SetName(v string) *Fleet { + s.Name = &v return s } -// SetFailureReason sets the FailureReason field's value. -func (s *DescribeSimulationJobOutput) SetFailureReason(v string) *DescribeSimulationJobOutput { - s.FailureReason = &v - return s +type GetWorldTemplateBodyInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (arn) of the world generator job. + GenerationJob *string `locationName:"generationJob" min:"1" type:"string"` + + // The Amazon Resource Name (arn) of the world template. + Template *string `locationName:"template" min:"1" type:"string"` } -// SetIamRole sets the IamRole field's value. -func (s *DescribeSimulationJobOutput) SetIamRole(v string) *DescribeSimulationJobOutput { - s.IamRole = &v - return s +// String returns the string representation +func (s GetWorldTemplateBodyInput) String() string { + return awsutil.Prettify(s) } -// SetLastStartedAt sets the LastStartedAt field's value. -func (s *DescribeSimulationJobOutput) SetLastStartedAt(v time.Time) *DescribeSimulationJobOutput { - s.LastStartedAt = &v - return s +// GoString returns the string representation +func (s GetWorldTemplateBodyInput) GoString() string { + return s.String() } -// SetLastUpdatedAt sets the LastUpdatedAt field's value. -func (s *DescribeSimulationJobOutput) SetLastUpdatedAt(v time.Time) *DescribeSimulationJobOutput { - s.LastUpdatedAt = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetWorldTemplateBodyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetWorldTemplateBodyInput"} + if s.GenerationJob != nil && len(*s.GenerationJob) < 1 { + invalidParams.Add(request.NewErrParamMinLen("GenerationJob", 1)) + } + if s.Template != nil && len(*s.Template) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Template", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetLoggingConfig sets the LoggingConfig field's value. -func (s *DescribeSimulationJobOutput) SetLoggingConfig(v *LoggingConfig) *DescribeSimulationJobOutput { - s.LoggingConfig = v +// SetGenerationJob sets the GenerationJob field's value. +func (s *GetWorldTemplateBodyInput) SetGenerationJob(v string) *GetWorldTemplateBodyInput { + s.GenerationJob = &v return s } -// SetMaxJobDurationInSeconds sets the MaxJobDurationInSeconds field's value. -func (s *DescribeSimulationJobOutput) SetMaxJobDurationInSeconds(v int64) *DescribeSimulationJobOutput { - s.MaxJobDurationInSeconds = &v +// SetTemplate sets the Template field's value. +func (s *GetWorldTemplateBodyInput) SetTemplate(v string) *GetWorldTemplateBodyInput { + s.Template = &v return s } -// SetName sets the Name field's value. -func (s *DescribeSimulationJobOutput) SetName(v string) *DescribeSimulationJobOutput { - s.Name = &v - return s +type GetWorldTemplateBodyOutput struct { + _ struct{} `type:"structure"` + + // The world template body. + TemplateBody *string `locationName:"templateBody" min:"1" type:"string"` +} + +// String returns the string representation +func (s GetWorldTemplateBodyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetWorldTemplateBodyOutput) GoString() string { + return s.String() } -// SetNetworkInterface sets the NetworkInterface field's value. -func (s *DescribeSimulationJobOutput) SetNetworkInterface(v *NetworkInterface) *DescribeSimulationJobOutput { - s.NetworkInterface = v +// SetTemplateBody sets the TemplateBody field's value. +func (s *GetWorldTemplateBodyOutput) SetTemplateBody(v string) *GetWorldTemplateBodyOutput { + s.TemplateBody = &v return s } -// SetOutputLocation sets the OutputLocation field's value. -func (s *DescribeSimulationJobOutput) SetOutputLocation(v *OutputLocation) *DescribeSimulationJobOutput { - s.OutputLocation = v - return s +// The request uses the same client token as a previous, but non-identical request. +// Do not reuse a client token with different requests, unless the requests +// are identical. +type IdempotentParameterMismatchException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` } -// SetRobotApplications sets the RobotApplications field's value. -func (s *DescribeSimulationJobOutput) SetRobotApplications(v []*RobotApplicationConfig) *DescribeSimulationJobOutput { - s.RobotApplications = v - return s +// String returns the string representation +func (s IdempotentParameterMismatchException) String() string { + return awsutil.Prettify(s) } -// SetSimulationApplications sets the SimulationApplications field's value. -func (s *DescribeSimulationJobOutput) SetSimulationApplications(v []*SimulationApplicationConfig) *DescribeSimulationJobOutput { - s.SimulationApplications = v - return s +// GoString returns the string representation +func (s IdempotentParameterMismatchException) GoString() string { + return s.String() } -// SetSimulationTimeMillis sets the SimulationTimeMillis field's value. -func (s *DescribeSimulationJobOutput) SetSimulationTimeMillis(v int64) *DescribeSimulationJobOutput { - s.SimulationTimeMillis = &v - return s +func newErrorIdempotentParameterMismatchException(v protocol.ResponseMetadata) error { + return &IdempotentParameterMismatchException{ + RespMetadata: v, + } } -// SetStatus sets the Status field's value. -func (s *DescribeSimulationJobOutput) SetStatus(v string) *DescribeSimulationJobOutput { - s.Status = &v - return s +// Code returns the exception type name. +func (s *IdempotentParameterMismatchException) Code() string { + return "IdempotentParameterMismatchException" } -// SetTags sets the Tags field's value. -func (s *DescribeSimulationJobOutput) SetTags(v map[string]*string) *DescribeSimulationJobOutput { - s.Tags = v - return s +// Message returns the exception's message. +func (s *IdempotentParameterMismatchException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" } -// SetVpcConfig sets the VpcConfig field's value. -func (s *DescribeSimulationJobOutput) SetVpcConfig(v *VPCConfigResponse) *DescribeSimulationJobOutput { - s.VpcConfig = v - return s +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *IdempotentParameterMismatchException) OrigErr() error { + return nil } -// Information about a failed create simulation job request. -type FailedCreateSimulationJobRequest struct { - _ struct{} `type:"structure"` +func (s *IdempotentParameterMismatchException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} - // The time, in milliseconds since the epoch, when the simulation job batch - // failed. - FailedAt *time.Time `locationName:"failedAt" type:"timestamp"` +// Status code returns the HTTP status code for the request's response error. +func (s *IdempotentParameterMismatchException) StatusCode() int { + return s.RespMetadata.StatusCode +} - // The failure code. - FailureCode *string `locationName:"failureCode" type:"string" enum:"SimulationJobErrorCode"` +// RequestID returns the service's response RequestID for request. +func (s *IdempotentParameterMismatchException) RequestID() string { + return s.RespMetadata.RequestID +} - // The failure reason of the simulation job request. - FailureReason *string `locationName:"failureReason" type:"string"` +// AWS RoboMaker experienced a service issue. Try your call again. +type InternalServerException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - // The simulation job request. - Request *SimulationJobRequest `locationName:"request" type:"structure"` + Message_ *string `locationName:"message" type:"string"` } // String returns the string representation -func (s FailedCreateSimulationJobRequest) String() string { +func (s InternalServerException) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s FailedCreateSimulationJobRequest) GoString() string { +func (s InternalServerException) GoString() string { return s.String() } -// SetFailedAt sets the FailedAt field's value. -func (s *FailedCreateSimulationJobRequest) SetFailedAt(v time.Time) *FailedCreateSimulationJobRequest { - s.FailedAt = &v - return s +func newErrorInternalServerException(v protocol.ResponseMetadata) error { + return &InternalServerException{ + RespMetadata: v, + } } -// SetFailureCode sets the FailureCode field's value. -func (s *FailedCreateSimulationJobRequest) SetFailureCode(v string) *FailedCreateSimulationJobRequest { - s.FailureCode = &v - return s +// Code returns the exception type name. +func (s *InternalServerException) Code() string { + return "InternalServerException" } -// SetFailureReason sets the FailureReason field's value. -func (s *FailedCreateSimulationJobRequest) SetFailureReason(v string) *FailedCreateSimulationJobRequest { - s.FailureReason = &v - return s +// Message returns the exception's message. +func (s *InternalServerException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" } -// SetRequest sets the Request field's value. -func (s *FailedCreateSimulationJobRequest) SetRequest(v *SimulationJobRequest) *FailedCreateSimulationJobRequest { - s.Request = v - return s +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InternalServerException) OrigErr() error { + return nil } -// Information about a filter. -type Filter struct { - _ struct{} `type:"structure"` +func (s *InternalServerException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} - // The name of the filter. - Name *string `locationName:"name" min:"1" type:"string"` +// Status code returns the HTTP status code for the request's response error. +func (s *InternalServerException) StatusCode() int { + return s.RespMetadata.StatusCode +} - // A list of values. - Values []*string `locationName:"values" min:"1" type:"list"` +// RequestID returns the service's response RequestID for request. +func (s *InternalServerException) RequestID() string { + return s.RespMetadata.RequestID +} + +// A parameter specified in a request is not valid, is unsupported, or cannot +// be used. The returned message provides an explanation of the error value. +type InvalidParameterException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` } // String returns the string representation -func (s Filter) String() string { +func (s InvalidParameterException) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s Filter) GoString() string { +func (s InvalidParameterException) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *Filter) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "Filter"} - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) - } - if s.Values != nil && len(s.Values) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Values", 1)) +func newErrorInvalidParameterException(v protocol.ResponseMetadata) error { + return &InvalidParameterException{ + RespMetadata: v, } +} - if invalidParams.Len() > 0 { - return invalidParams +// Code returns the exception type name. +func (s *InvalidParameterException) Code() string { + return "InvalidParameterException" +} + +// Message returns the exception's message. +func (s *InvalidParameterException) Message() string { + if s.Message_ != nil { + return *s.Message_ } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InvalidParameterException) OrigErr() error { return nil } -// SetName sets the Name field's value. -func (s *Filter) SetName(v string) *Filter { - s.Name = &v - return s +func (s *InvalidParameterException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) } -// SetValues sets the Values field's value. -func (s *Filter) SetValues(v []*string) *Filter { - s.Values = v - return s +// Status code returns the HTTP status code for the request's response error. +func (s *InvalidParameterException) StatusCode() int { + return s.RespMetadata.StatusCode } -// Information about a fleet. -type Fleet struct { - _ struct{} `type:"structure"` +// RequestID returns the service's response RequestID for request. +func (s *InvalidParameterException) RequestID() string { + return s.RespMetadata.RequestID +} - // The Amazon Resource Name (ARN) of the fleet. - Arn *string `locationName:"arn" min:"1" type:"string"` +// Information about a launch configuration. +type LaunchConfig struct { + _ struct{} `type:"structure"` - // The time, in milliseconds since the epoch, when the fleet was created. - CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + // The environment variables for the application launch. + EnvironmentVariables map[string]*string `locationName:"environmentVariables" type:"map"` - // The Amazon Resource Name (ARN) of the last deployment job. - LastDeploymentJob *string `locationName:"lastDeploymentJob" min:"1" type:"string"` + // The launch file name. + // + // LaunchFile is a required field + LaunchFile *string `locationName:"launchFile" min:"1" type:"string" required:"true"` - // The status of the last fleet deployment. - LastDeploymentStatus *string `locationName:"lastDeploymentStatus" type:"string" enum:"DeploymentStatus"` + // The package name. + // + // PackageName is a required field + PackageName *string `locationName:"packageName" min:"1" type:"string" required:"true"` - // The time of the last deployment. - LastDeploymentTime *time.Time `locationName:"lastDeploymentTime" type:"timestamp"` + // The port forwarding configuration. + PortForwardingConfig *PortForwardingConfig `locationName:"portForwardingConfig" type:"structure"` - // The name of the fleet. - Name *string `locationName:"name" min:"1" type:"string"` + // Boolean indicating whether a streaming session will be configured for the + // application. If True, AWS RoboMaker will configure a connection so you can + // interact with your application as it is running in the simulation. You must + // configure and luanch the component. It must have a graphical user interface. + StreamUI *bool `locationName:"streamUI" type:"boolean"` } // String returns the string representation -func (s Fleet) String() string { +func (s LaunchConfig) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s Fleet) GoString() string { +func (s LaunchConfig) GoString() string { return s.String() } -// SetArn sets the Arn field's value. -func (s *Fleet) SetArn(v string) *Fleet { - s.Arn = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *LaunchConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "LaunchConfig"} + if s.LaunchFile == nil { + invalidParams.Add(request.NewErrParamRequired("LaunchFile")) + } + if s.LaunchFile != nil && len(*s.LaunchFile) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LaunchFile", 1)) + } + if s.PackageName == nil { + invalidParams.Add(request.NewErrParamRequired("PackageName")) + } + if s.PackageName != nil && len(*s.PackageName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PackageName", 1)) + } + if s.PortForwardingConfig != nil { + if err := s.PortForwardingConfig.Validate(); err != nil { + invalidParams.AddNested("PortForwardingConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetCreatedAt sets the CreatedAt field's value. -func (s *Fleet) SetCreatedAt(v time.Time) *Fleet { - s.CreatedAt = &v +// SetEnvironmentVariables sets the EnvironmentVariables field's value. +func (s *LaunchConfig) SetEnvironmentVariables(v map[string]*string) *LaunchConfig { + s.EnvironmentVariables = v return s } -// SetLastDeploymentJob sets the LastDeploymentJob field's value. -func (s *Fleet) SetLastDeploymentJob(v string) *Fleet { - s.LastDeploymentJob = &v +// SetLaunchFile sets the LaunchFile field's value. +func (s *LaunchConfig) SetLaunchFile(v string) *LaunchConfig { + s.LaunchFile = &v return s } -// SetLastDeploymentStatus sets the LastDeploymentStatus field's value. -func (s *Fleet) SetLastDeploymentStatus(v string) *Fleet { - s.LastDeploymentStatus = &v +// SetPackageName sets the PackageName field's value. +func (s *LaunchConfig) SetPackageName(v string) *LaunchConfig { + s.PackageName = &v return s } -// SetLastDeploymentTime sets the LastDeploymentTime field's value. -func (s *Fleet) SetLastDeploymentTime(v time.Time) *Fleet { - s.LastDeploymentTime = &v +// SetPortForwardingConfig sets the PortForwardingConfig field's value. +func (s *LaunchConfig) SetPortForwardingConfig(v *PortForwardingConfig) *LaunchConfig { + s.PortForwardingConfig = v return s } -// SetName sets the Name field's value. -func (s *Fleet) SetName(v string) *Fleet { - s.Name = &v +// SetStreamUI sets the StreamUI field's value. +func (s *LaunchConfig) SetStreamUI(v bool) *LaunchConfig { + s.StreamUI = &v return s } -// The request uses the same client token as a previous, but non-identical request. -// Do not reuse a client token with different requests, unless the requests -// are identical. -type IdempotentParameterMismatchException struct { +// The requested resource exceeds the maximum number allowed, or the number +// of concurrent stream requests exceeds the maximum number allowed. +type LimitExceededException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -8384,28 +12001,28 @@ type IdempotentParameterMismatchException struct { } // String returns the string representation -func (s IdempotentParameterMismatchException) String() string { +func (s LimitExceededException) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s IdempotentParameterMismatchException) GoString() string { +func (s LimitExceededException) GoString() string { return s.String() } -func newErrorIdempotentParameterMismatchException(v protocol.ResponseMetadata) error { - return &IdempotentParameterMismatchException{ +func newErrorLimitExceededException(v protocol.ResponseMetadata) error { + return &LimitExceededException{ RespMetadata: v, } } // Code returns the exception type name. -func (s *IdempotentParameterMismatchException) Code() string { - return "IdempotentParameterMismatchException" +func (s *LimitExceededException) Code() string { + return "LimitExceededException" } // Message returns the exception's message. -func (s *IdempotentParameterMismatchException) Message() string { +func (s *LimitExceededException) Message() string { if s.Message_ != nil { return *s.Message_ } @@ -8413,192 +12030,317 @@ func (s *IdempotentParameterMismatchException) Message() string { } // OrigErr always returns nil, satisfies awserr.Error interface. -func (s *IdempotentParameterMismatchException) OrigErr() error { +func (s *LimitExceededException) OrigErr() error { return nil } -func (s *IdempotentParameterMismatchException) Error() string { +func (s *LimitExceededException) Error() string { return fmt.Sprintf("%s: %s", s.Code(), s.Message()) } // Status code returns the HTTP status code for the request's response error. -func (s *IdempotentParameterMismatchException) StatusCode() int { +func (s *LimitExceededException) StatusCode() int { return s.RespMetadata.StatusCode } // RequestID returns the service's response RequestID for request. -func (s *IdempotentParameterMismatchException) RequestID() string { +func (s *LimitExceededException) RequestID() string { return s.RespMetadata.RequestID } -// AWS RoboMaker experienced a service issue. Try your call again. -type InternalServerException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` +type ListDeploymentJobsInput struct { + _ struct{} `type:"structure"` - Message_ *string `locationName:"message" type:"string"` + // Optional filters to limit results. + // + // The filter names status and fleetName are supported. When filtering, you + // must use the complete value of the filtered item. You can use up to three + // filters, but they must be for the same named item. For example, if you are + // looking for items with the status InProgress or the status Pending. + Filters []*Filter `locationName:"filters" min:"1" type:"list"` + + // When this parameter is used, ListDeploymentJobs only returns maxResults results + // in a single page along with a nextToken response element. The remaining results + // of the initial request can be seen by sending another ListDeploymentJobs + // request with the returned nextToken value. This value can be between 1 and + // 200. If this parameter is not used, then ListDeploymentJobs returns up to + // 200 results and a nextToken value if applicable. + MaxResults *int64 `locationName:"maxResults" type:"integer"` + + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListDeploymentJobs again and assign that token + // to the request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation -func (s InternalServerException) String() string { +func (s ListDeploymentJobsInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s InternalServerException) GoString() string { +func (s ListDeploymentJobsInput) GoString() string { return s.String() } -func newErrorInternalServerException(v protocol.ResponseMetadata) error { - return &InternalServerException{ - RespMetadata: v, +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListDeploymentJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListDeploymentJobsInput"} + if s.Filters != nil && len(s.Filters) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Filters", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.Filters != nil { + for i, v := range s.Filters { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams } + return nil } -// Code returns the exception type name. -func (s *InternalServerException) Code() string { - return "InternalServerException" +// SetFilters sets the Filters field's value. +func (s *ListDeploymentJobsInput) SetFilters(v []*Filter) *ListDeploymentJobsInput { + s.Filters = v + return s } -// Message returns the exception's message. -func (s *InternalServerException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" +// SetMaxResults sets the MaxResults field's value. +func (s *ListDeploymentJobsInput) SetMaxResults(v int64) *ListDeploymentJobsInput { + s.MaxResults = &v + return s } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *InternalServerException) OrigErr() error { - return nil +// SetNextToken sets the NextToken field's value. +func (s *ListDeploymentJobsInput) SetNextToken(v string) *ListDeploymentJobsInput { + s.NextToken = &v + return s } -func (s *InternalServerException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +type ListDeploymentJobsOutput struct { + _ struct{} `type:"structure"` + + // A list of deployment jobs that meet the criteria of the request. + DeploymentJobs []*DeploymentJob `locationName:"deploymentJobs" type:"list"` + + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListDeploymentJobs again and assign that token + // to the request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` } -// Status code returns the HTTP status code for the request's response error. -func (s *InternalServerException) StatusCode() int { - return s.RespMetadata.StatusCode +// String returns the string representation +func (s ListDeploymentJobsOutput) String() string { + return awsutil.Prettify(s) } -// RequestID returns the service's response RequestID for request. -func (s *InternalServerException) RequestID() string { - return s.RespMetadata.RequestID +// GoString returns the string representation +func (s ListDeploymentJobsOutput) GoString() string { + return s.String() } -// A parameter specified in a request is not valid, is unsupported, or cannot -// be used. The returned message provides an explanation of the error value. -type InvalidParameterException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` +// SetDeploymentJobs sets the DeploymentJobs field's value. +func (s *ListDeploymentJobsOutput) SetDeploymentJobs(v []*DeploymentJob) *ListDeploymentJobsOutput { + s.DeploymentJobs = v + return s +} - Message_ *string `locationName:"message" type:"string"` +// SetNextToken sets the NextToken field's value. +func (s *ListDeploymentJobsOutput) SetNextToken(v string) *ListDeploymentJobsOutput { + s.NextToken = &v + return s +} + +type ListFleetsInput struct { + _ struct{} `type:"structure"` + + // Optional filters to limit results. + // + // The filter name name is supported. When filtering, you must use the complete + // value of the filtered item. You can use up to three filters. + Filters []*Filter `locationName:"filters" min:"1" type:"list"` + + // When this parameter is used, ListFleets only returns maxResults results in + // a single page along with a nextToken response element. The remaining results + // of the initial request can be seen by sending another ListFleets request + // with the returned nextToken value. This value can be between 1 and 200. If + // this parameter is not used, then ListFleets returns up to 200 results and + // a nextToken value if applicable. + MaxResults *int64 `locationName:"maxResults" type:"integer"` + + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListFleets again and assign that token to the + // request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. + // + // This token should be treated as an opaque identifier that is only used to + // retrieve the next items in a list and not for other programmatic purposes. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation -func (s InvalidParameterException) String() string { +func (s ListFleetsInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s InvalidParameterException) GoString() string { +func (s ListFleetsInput) GoString() string { return s.String() } -func newErrorInvalidParameterException(v protocol.ResponseMetadata) error { - return &InvalidParameterException{ - RespMetadata: v, +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListFleetsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListFleetsInput"} + if s.Filters != nil && len(s.Filters) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Filters", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.Filters != nil { + for i, v := range s.Filters { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams } + return nil +} + +// SetFilters sets the Filters field's value. +func (s *ListFleetsInput) SetFilters(v []*Filter) *ListFleetsInput { + s.Filters = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListFleetsInput) SetMaxResults(v int64) *ListFleetsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListFleetsInput) SetNextToken(v string) *ListFleetsInput { + s.NextToken = &v + return s } -// Code returns the exception type name. -func (s *InvalidParameterException) Code() string { - return "InvalidParameterException" -} +type ListFleetsOutput struct { + _ struct{} `type:"structure"` -// Message returns the exception's message. -func (s *InvalidParameterException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" + // A list of fleet details meeting the request criteria. + FleetDetails []*Fleet `locationName:"fleetDetails" type:"list"` + + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListFleets again and assign that token to the + // request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *InvalidParameterException) OrigErr() error { - return nil +// String returns the string representation +func (s ListFleetsOutput) String() string { + return awsutil.Prettify(s) } -func (s *InvalidParameterException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// GoString returns the string representation +func (s ListFleetsOutput) GoString() string { + return s.String() } -// Status code returns the HTTP status code for the request's response error. -func (s *InvalidParameterException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetFleetDetails sets the FleetDetails field's value. +func (s *ListFleetsOutput) SetFleetDetails(v []*Fleet) *ListFleetsOutput { + s.FleetDetails = v + return s } -// RequestID returns the service's response RequestID for request. -func (s *InvalidParameterException) RequestID() string { - return s.RespMetadata.RequestID +// SetNextToken sets the NextToken field's value. +func (s *ListFleetsOutput) SetNextToken(v string) *ListFleetsOutput { + s.NextToken = &v + return s } -// Information about a launch configuration. -type LaunchConfig struct { +type ListRobotApplicationsInput struct { _ struct{} `type:"structure"` - // The environment variables for the application launch. - EnvironmentVariables map[string]*string `locationName:"environmentVariables" type:"map"` - - // The launch file name. + // Optional filters to limit results. // - // LaunchFile is a required field - LaunchFile *string `locationName:"launchFile" min:"1" type:"string" required:"true"` + // The filter name name is supported. When filtering, you must use the complete + // value of the filtered item. You can use up to three filters. + Filters []*Filter `locationName:"filters" min:"1" type:"list"` - // The package name. - // - // PackageName is a required field - PackageName *string `locationName:"packageName" min:"1" type:"string" required:"true"` + // When this parameter is used, ListRobotApplications only returns maxResults + // results in a single page along with a nextToken response element. The remaining + // results of the initial request can be seen by sending another ListRobotApplications + // request with the returned nextToken value. This value can be between 1 and + // 100. If this parameter is not used, then ListRobotApplications returns up + // to 100 results and a nextToken value if applicable. + MaxResults *int64 `locationName:"maxResults" type:"integer"` - // The port forwarding configuration. - PortForwardingConfig *PortForwardingConfig `locationName:"portForwardingConfig" type:"structure"` + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListRobotApplications again and assign that + // token to the request object's nextToken parameter. If there are no remaining + // results, the previous response object's NextToken parameter is set to null. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` - // Boolean indicating whether a streaming session will be configured for the - // application. If True, AWS RoboMaker will configure a connection so you can - // interact with your application as it is running in the simulation. You must - // configure and luanch the component. It must have a graphical user interface. - StreamUI *bool `locationName:"streamUI" type:"boolean"` + // The version qualifier of the robot application. + VersionQualifier *string `locationName:"versionQualifier" min:"1" type:"string"` } // String returns the string representation -func (s LaunchConfig) String() string { +func (s ListRobotApplicationsInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s LaunchConfig) GoString() string { +func (s ListRobotApplicationsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *LaunchConfig) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "LaunchConfig"} - if s.LaunchFile == nil { - invalidParams.Add(request.NewErrParamRequired("LaunchFile")) - } - if s.LaunchFile != nil && len(*s.LaunchFile) < 1 { - invalidParams.Add(request.NewErrParamMinLen("LaunchFile", 1)) +func (s *ListRobotApplicationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListRobotApplicationsInput"} + if s.Filters != nil && len(s.Filters) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Filters", 1)) } - if s.PackageName == nil { - invalidParams.Add(request.NewErrParamRequired("PackageName")) + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } - if s.PackageName != nil && len(*s.PackageName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("PackageName", 1)) + if s.VersionQualifier != nil && len(*s.VersionQualifier) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VersionQualifier", 1)) } - if s.PortForwardingConfig != nil { - if err := s.PortForwardingConfig.Validate(); err != nil { - invalidParams.AddNested("PortForwardingConfig", err.(request.ErrInvalidParams)) + if s.Filters != nil { + for i, v := range s.Filters { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams)) + } } } @@ -8608,138 +12350,233 @@ func (s *LaunchConfig) Validate() error { return nil } -// SetEnvironmentVariables sets the EnvironmentVariables field's value. -func (s *LaunchConfig) SetEnvironmentVariables(v map[string]*string) *LaunchConfig { - s.EnvironmentVariables = v +// SetFilters sets the Filters field's value. +func (s *ListRobotApplicationsInput) SetFilters(v []*Filter) *ListRobotApplicationsInput { + s.Filters = v return s } -// SetLaunchFile sets the LaunchFile field's value. -func (s *LaunchConfig) SetLaunchFile(v string) *LaunchConfig { - s.LaunchFile = &v +// SetMaxResults sets the MaxResults field's value. +func (s *ListRobotApplicationsInput) SetMaxResults(v int64) *ListRobotApplicationsInput { + s.MaxResults = &v return s } -// SetPackageName sets the PackageName field's value. -func (s *LaunchConfig) SetPackageName(v string) *LaunchConfig { - s.PackageName = &v +// SetNextToken sets the NextToken field's value. +func (s *ListRobotApplicationsInput) SetNextToken(v string) *ListRobotApplicationsInput { + s.NextToken = &v return s } -// SetPortForwardingConfig sets the PortForwardingConfig field's value. -func (s *LaunchConfig) SetPortForwardingConfig(v *PortForwardingConfig) *LaunchConfig { - s.PortForwardingConfig = v +// SetVersionQualifier sets the VersionQualifier field's value. +func (s *ListRobotApplicationsInput) SetVersionQualifier(v string) *ListRobotApplicationsInput { + s.VersionQualifier = &v return s } -// SetStreamUI sets the StreamUI field's value. -func (s *LaunchConfig) SetStreamUI(v bool) *LaunchConfig { - s.StreamUI = &v +type ListRobotApplicationsOutput struct { + _ struct{} `type:"structure"` + + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListRobotApplications again and assign that + // token to the request object's nextToken parameter. If there are no remaining + // results, the previous response object's NextToken parameter is set to null. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` + + // A list of robot application summaries that meet the criteria of the request. + RobotApplicationSummaries []*RobotApplicationSummary `locationName:"robotApplicationSummaries" type:"list"` +} + +// String returns the string representation +func (s ListRobotApplicationsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListRobotApplicationsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListRobotApplicationsOutput) SetNextToken(v string) *ListRobotApplicationsOutput { + s.NextToken = &v return s } -// The requested resource exceeds the maximum number allowed, or the number -// of concurrent stream requests exceeds the maximum number allowed. -type LimitExceededException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` +// SetRobotApplicationSummaries sets the RobotApplicationSummaries field's value. +func (s *ListRobotApplicationsOutput) SetRobotApplicationSummaries(v []*RobotApplicationSummary) *ListRobotApplicationsOutput { + s.RobotApplicationSummaries = v + return s +} - Message_ *string `locationName:"message" type:"string"` +type ListRobotsInput struct { + _ struct{} `type:"structure"` + + // Optional filters to limit results. + // + // The filter names status and fleetName are supported. When filtering, you + // must use the complete value of the filtered item. You can use up to three + // filters, but they must be for the same named item. For example, if you are + // looking for items with the status Registered or the status Available. + Filters []*Filter `locationName:"filters" min:"1" type:"list"` + + // When this parameter is used, ListRobots only returns maxResults results in + // a single page along with a nextToken response element. The remaining results + // of the initial request can be seen by sending another ListRobots request + // with the returned nextToken value. This value can be between 1 and 200. If + // this parameter is not used, then ListRobots returns up to 200 results and + // a nextToken value if applicable. + MaxResults *int64 `locationName:"maxResults" type:"integer"` + + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListRobots again and assign that token to the + // request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation -func (s LimitExceededException) String() string { +func (s ListRobotsInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s LimitExceededException) GoString() string { +func (s ListRobotsInput) GoString() string { return s.String() } -func newErrorLimitExceededException(v protocol.ResponseMetadata) error { - return &LimitExceededException{ - RespMetadata: v, +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListRobotsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListRobotsInput"} + if s.Filters != nil && len(s.Filters) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Filters", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.Filters != nil { + for i, v := range s.Filters { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams } + return nil } -// Code returns the exception type name. -func (s *LimitExceededException) Code() string { - return "LimitExceededException" +// SetFilters sets the Filters field's value. +func (s *ListRobotsInput) SetFilters(v []*Filter) *ListRobotsInput { + s.Filters = v + return s } -// Message returns the exception's message. -func (s *LimitExceededException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" +// SetMaxResults sets the MaxResults field's value. +func (s *ListRobotsInput) SetMaxResults(v int64) *ListRobotsInput { + s.MaxResults = &v + return s } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *LimitExceededException) OrigErr() error { - return nil +// SetNextToken sets the NextToken field's value. +func (s *ListRobotsInput) SetNextToken(v string) *ListRobotsInput { + s.NextToken = &v + return s +} + +type ListRobotsOutput struct { + _ struct{} `type:"structure"` + + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListRobots again and assign that token to the + // request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` + + // A list of robots that meet the criteria of the request. + Robots []*Robot `locationName:"robots" type:"list"` +} + +// String returns the string representation +func (s ListRobotsOutput) String() string { + return awsutil.Prettify(s) } -func (s *LimitExceededException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// GoString returns the string representation +func (s ListRobotsOutput) GoString() string { + return s.String() } -// Status code returns the HTTP status code for the request's response error. -func (s *LimitExceededException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetNextToken sets the NextToken field's value. +func (s *ListRobotsOutput) SetNextToken(v string) *ListRobotsOutput { + s.NextToken = &v + return s } -// RequestID returns the service's response RequestID for request. -func (s *LimitExceededException) RequestID() string { - return s.RespMetadata.RequestID +// SetRobots sets the Robots field's value. +func (s *ListRobotsOutput) SetRobots(v []*Robot) *ListRobotsOutput { + s.Robots = v + return s } -type ListDeploymentJobsInput struct { +type ListSimulationApplicationsInput struct { _ struct{} `type:"structure"` - // Optional filters to limit results. + // Optional list of filters to limit results. // - // The filter names status and fleetName are supported. When filtering, you - // must use the complete value of the filtered item. You can use up to three - // filters, but they must be for the same named item. For example, if you are - // looking for items with the status InProgress or the status Pending. + // The filter name name is supported. When filtering, you must use the complete + // value of the filtered item. You can use up to three filters. Filters []*Filter `locationName:"filters" min:"1" type:"list"` - // When this parameter is used, ListDeploymentJobs only returns maxResults results - // in a single page along with a nextToken response element. The remaining results - // of the initial request can be seen by sending another ListDeploymentJobs + // When this parameter is used, ListSimulationApplications only returns maxResults + // results in a single page along with a nextToken response element. The remaining + // results of the initial request can be seen by sending another ListSimulationApplications // request with the returned nextToken value. This value can be between 1 and - // 200. If this parameter is not used, then ListDeploymentJobs returns up to - // 200 results and a nextToken value if applicable. + // 100. If this parameter is not used, then ListSimulationApplications returns + // up to 100 results and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` - // The nextToken value returned from a previous paginated ListDeploymentJobs - // request where maxResults was used and the results exceeded the value of that - // parameter. Pagination continues from the end of the previous results that - // returned the nextToken value. + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListSimulationApplications again and assign + // that token to the request object's nextToken parameter. If there are no remaining + // results, the previous response object's NextToken parameter is set to null. NextToken *string `locationName:"nextToken" min:"1" type:"string"` + + // The version qualifier of the simulation application. + VersionQualifier *string `locationName:"versionQualifier" min:"1" type:"string"` } // String returns the string representation -func (s ListDeploymentJobsInput) String() string { +func (s ListSimulationApplicationsInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ListDeploymentJobsInput) GoString() string { +func (s ListSimulationApplicationsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListDeploymentJobsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListDeploymentJobsInput"} +func (s *ListSimulationApplicationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListSimulationApplicationsInput"} if s.Filters != nil && len(s.Filters) < 1 { invalidParams.Add(request.NewErrParamMinLen("Filters", 1)) } if s.NextToken != nil && len(*s.NextToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } + if s.VersionQualifier != nil && len(*s.VersionQualifier) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VersionQualifier", 1)) + } if s.Filters != nil { for i, v := range s.Filters { if v == nil { @@ -8758,98 +12595,99 @@ func (s *ListDeploymentJobsInput) Validate() error { } // SetFilters sets the Filters field's value. -func (s *ListDeploymentJobsInput) SetFilters(v []*Filter) *ListDeploymentJobsInput { +func (s *ListSimulationApplicationsInput) SetFilters(v []*Filter) *ListSimulationApplicationsInput { s.Filters = v return s } // SetMaxResults sets the MaxResults field's value. -func (s *ListDeploymentJobsInput) SetMaxResults(v int64) *ListDeploymentJobsInput { +func (s *ListSimulationApplicationsInput) SetMaxResults(v int64) *ListSimulationApplicationsInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListDeploymentJobsInput) SetNextToken(v string) *ListDeploymentJobsInput { +func (s *ListSimulationApplicationsInput) SetNextToken(v string) *ListSimulationApplicationsInput { s.NextToken = &v return s } -type ListDeploymentJobsOutput struct { - _ struct{} `type:"structure"` +// SetVersionQualifier sets the VersionQualifier field's value. +func (s *ListSimulationApplicationsInput) SetVersionQualifier(v string) *ListSimulationApplicationsInput { + s.VersionQualifier = &v + return s +} - // A list of deployment jobs that meet the criteria of the request. - DeploymentJobs []*DeploymentJob `locationName:"deploymentJobs" type:"list"` +type ListSimulationApplicationsOutput struct { + _ struct{} `type:"structure"` - // The nextToken value to include in a future ListDeploymentJobs request. When - // the results of a ListDeploymentJobs request exceed maxResults, this value - // can be used to retrieve the next page of results. This value is null when - // there are no more results to return. + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListSimulationApplications again and assign + // that token to the request object's nextToken parameter. If there are no remaining + // results, the previous response object's NextToken parameter is set to null. NextToken *string `locationName:"nextToken" min:"1" type:"string"` + + // A list of simulation application summaries that meet the criteria of the + // request. + SimulationApplicationSummaries []*SimulationApplicationSummary `locationName:"simulationApplicationSummaries" type:"list"` } // String returns the string representation -func (s ListDeploymentJobsOutput) String() string { +func (s ListSimulationApplicationsOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ListDeploymentJobsOutput) GoString() string { +func (s ListSimulationApplicationsOutput) GoString() string { return s.String() } -// SetDeploymentJobs sets the DeploymentJobs field's value. -func (s *ListDeploymentJobsOutput) SetDeploymentJobs(v []*DeploymentJob) *ListDeploymentJobsOutput { - s.DeploymentJobs = v +// SetNextToken sets the NextToken field's value. +func (s *ListSimulationApplicationsOutput) SetNextToken(v string) *ListSimulationApplicationsOutput { + s.NextToken = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListDeploymentJobsOutput) SetNextToken(v string) *ListDeploymentJobsOutput { - s.NextToken = &v +// SetSimulationApplicationSummaries sets the SimulationApplicationSummaries field's value. +func (s *ListSimulationApplicationsOutput) SetSimulationApplicationSummaries(v []*SimulationApplicationSummary) *ListSimulationApplicationsOutput { + s.SimulationApplicationSummaries = v return s } -type ListFleetsInput struct { +type ListSimulationJobBatchesInput struct { _ struct{} `type:"structure"` // Optional filters to limit results. - // - // The filter name name is supported. When filtering, you must use the complete - // value of the filtered item. You can use up to three filters. Filters []*Filter `locationName:"filters" min:"1" type:"list"` - // When this parameter is used, ListFleets only returns maxResults results in - // a single page along with a nextToken response element. The remaining results - // of the initial request can be seen by sending another ListFleets request - // with the returned nextToken value. This value can be between 1 and 200. If - // this parameter is not used, then ListFleets returns up to 200 results and - // a nextToken value if applicable. + // When this parameter is used, ListSimulationJobBatches only returns maxResults + // results in a single page along with a nextToken response element. The remaining + // results of the initial request can be seen by sending another ListSimulationJobBatches + // request with the returned nextToken value. MaxResults *int64 `locationName:"maxResults" type:"integer"` - // The nextToken value returned from a previous paginated ListFleets request - // where maxResults was used and the results exceeded the value of that parameter. - // Pagination continues from the end of the previous results that returned the - // nextToken value. - // - // This token should be treated as an opaque identifier that is only used to - // retrieve the next items in a list and not for other programmatic purposes. + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListSimulationJobBatches again and assign that + // token to the request object's nextToken parameter. If there are no remaining + // results, the previous response object's NextToken parameter is set to null. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation -func (s ListFleetsInput) String() string { +func (s ListSimulationJobBatchesInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ListFleetsInput) GoString() string { +func (s ListSimulationJobBatchesInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListFleetsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListFleetsInput"} +func (s *ListSimulationJobBatchesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListSimulationJobBatchesInput"} if s.Filters != nil && len(s.Filters) < 1 { invalidParams.Add(request.NewErrParamMinLen("Filters", 1)) } @@ -8874,107 +12712,106 @@ func (s *ListFleetsInput) Validate() error { } // SetFilters sets the Filters field's value. -func (s *ListFleetsInput) SetFilters(v []*Filter) *ListFleetsInput { +func (s *ListSimulationJobBatchesInput) SetFilters(v []*Filter) *ListSimulationJobBatchesInput { s.Filters = v return s } // SetMaxResults sets the MaxResults field's value. -func (s *ListFleetsInput) SetMaxResults(v int64) *ListFleetsInput { +func (s *ListSimulationJobBatchesInput) SetMaxResults(v int64) *ListSimulationJobBatchesInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListFleetsInput) SetNextToken(v string) *ListFleetsInput { +func (s *ListSimulationJobBatchesInput) SetNextToken(v string) *ListSimulationJobBatchesInput { s.NextToken = &v return s } -type ListFleetsOutput struct { +type ListSimulationJobBatchesOutput struct { _ struct{} `type:"structure"` - // A list of fleet details meeting the request criteria. - FleetDetails []*Fleet `locationName:"fleetDetails" type:"list"` - - // The nextToken value to include in a future ListDeploymentJobs request. When - // the results of a ListFleets request exceed maxResults, this value can be - // used to retrieve the next page of results. This value is null when there - // are no more results to return. + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListSimulationJobBatches again and assign that + // token to the request object's nextToken parameter. If there are no remaining + // results, the previous response object's NextToken parameter is set to null. NextToken *string `locationName:"nextToken" min:"1" type:"string"` + + // A list of simulation job batch summaries. + SimulationJobBatchSummaries []*SimulationJobBatchSummary `locationName:"simulationJobBatchSummaries" type:"list"` } // String returns the string representation -func (s ListFleetsOutput) String() string { +func (s ListSimulationJobBatchesOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ListFleetsOutput) GoString() string { +func (s ListSimulationJobBatchesOutput) GoString() string { return s.String() } -// SetFleetDetails sets the FleetDetails field's value. -func (s *ListFleetsOutput) SetFleetDetails(v []*Fleet) *ListFleetsOutput { - s.FleetDetails = v +// SetNextToken sets the NextToken field's value. +func (s *ListSimulationJobBatchesOutput) SetNextToken(v string) *ListSimulationJobBatchesOutput { + s.NextToken = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListFleetsOutput) SetNextToken(v string) *ListFleetsOutput { - s.NextToken = &v +// SetSimulationJobBatchSummaries sets the SimulationJobBatchSummaries field's value. +func (s *ListSimulationJobBatchesOutput) SetSimulationJobBatchSummaries(v []*SimulationJobBatchSummary) *ListSimulationJobBatchesOutput { + s.SimulationJobBatchSummaries = v return s } -type ListRobotApplicationsInput struct { +type ListSimulationJobsInput struct { _ struct{} `type:"structure"` // Optional filters to limit results. // - // The filter name name is supported. When filtering, you must use the complete - // value of the filtered item. You can use up to three filters. + // The filter names status and simulationApplicationName and robotApplicationName + // are supported. When filtering, you must use the complete value of the filtered + // item. You can use up to three filters, but they must be for the same named + // item. For example, if you are looking for items with the status Preparing + // or the status Running. Filters []*Filter `locationName:"filters" min:"1" type:"list"` - // When this parameter is used, ListRobotApplications only returns maxResults - // results in a single page along with a nextToken response element. The remaining - // results of the initial request can be seen by sending another ListRobotApplications + // When this parameter is used, ListSimulationJobs only returns maxResults results + // in a single page along with a nextToken response element. The remaining results + // of the initial request can be seen by sending another ListSimulationJobs // request with the returned nextToken value. This value can be between 1 and - // 100. If this parameter is not used, then ListRobotApplications returns up - // to 100 results and a nextToken value if applicable. + // 1000. If this parameter is not used, then ListSimulationJobs returns up to + // 1000 results and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` - // The nextToken value returned from a previous paginated ListRobotApplications - // request where maxResults was used and the results exceeded the value of that - // parameter. Pagination continues from the end of the previous results that - // returned the nextToken value. + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListSimulationJobs again and assign that token + // to the request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. NextToken *string `locationName:"nextToken" min:"1" type:"string"` - - // The version qualifier of the robot application. - VersionQualifier *string `locationName:"versionQualifier" min:"1" type:"string"` } // String returns the string representation -func (s ListRobotApplicationsInput) String() string { +func (s ListSimulationJobsInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ListRobotApplicationsInput) GoString() string { +func (s ListSimulationJobsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListRobotApplicationsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListRobotApplicationsInput"} +func (s *ListSimulationJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListSimulationJobsInput"} if s.Filters != nil && len(s.Filters) < 1 { invalidParams.Add(request.NewErrParamMinLen("Filters", 1)) } if s.NextToken != nil && len(*s.NextToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } - if s.VersionQualifier != nil && len(*s.VersionQualifier) < 1 { - invalidParams.Add(request.NewErrParamMinLen("VersionQualifier", 1)) - } if s.Filters != nil { for i, v := range s.Filters { if v == nil { @@ -8993,103 +12830,160 @@ func (s *ListRobotApplicationsInput) Validate() error { } // SetFilters sets the Filters field's value. -func (s *ListRobotApplicationsInput) SetFilters(v []*Filter) *ListRobotApplicationsInput { +func (s *ListSimulationJobsInput) SetFilters(v []*Filter) *ListSimulationJobsInput { s.Filters = v return s } // SetMaxResults sets the MaxResults field's value. -func (s *ListRobotApplicationsInput) SetMaxResults(v int64) *ListRobotApplicationsInput { +func (s *ListSimulationJobsInput) SetMaxResults(v int64) *ListSimulationJobsInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListRobotApplicationsInput) SetNextToken(v string) *ListRobotApplicationsInput { +func (s *ListSimulationJobsInput) SetNextToken(v string) *ListSimulationJobsInput { + s.NextToken = &v + return s +} + +type ListSimulationJobsOutput struct { + _ struct{} `type:"structure"` + + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListSimulationJobs again and assign that token + // to the request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` + + // A list of simulation job summaries that meet the criteria of the request. + // + // SimulationJobSummaries is a required field + SimulationJobSummaries []*SimulationJobSummary `locationName:"simulationJobSummaries" type:"list" required:"true"` +} + +// String returns the string representation +func (s ListSimulationJobsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListSimulationJobsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSimulationJobsOutput) SetNextToken(v string) *ListSimulationJobsOutput { s.NextToken = &v return s } -// SetVersionQualifier sets the VersionQualifier field's value. -func (s *ListRobotApplicationsInput) SetVersionQualifier(v string) *ListRobotApplicationsInput { - s.VersionQualifier = &v +// SetSimulationJobSummaries sets the SimulationJobSummaries field's value. +func (s *ListSimulationJobsOutput) SetSimulationJobSummaries(v []*SimulationJobSummary) *ListSimulationJobsOutput { + s.SimulationJobSummaries = v + return s +} + +type ListTagsForResourceInput struct { + _ struct{} `type:"structure"` + + // The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s ListTagsForResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListTagsForResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { + s.ResourceArn = &v return s } -type ListRobotApplicationsOutput struct { +type ListTagsForResourceOutput struct { _ struct{} `type:"structure"` - // The nextToken value to include in a future ListRobotApplications request. - // When the results of a ListRobotApplications request exceed maxResults, this - // value can be used to retrieve the next page of results. This value is null - // when there are no more results to return. - NextToken *string `locationName:"nextToken" min:"1" type:"string"` - - // A list of robot application summaries that meet the criteria of the request. - RobotApplicationSummaries []*RobotApplicationSummary `locationName:"robotApplicationSummaries" type:"list"` + // The list of all tags added to the specified resource. + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation -func (s ListRobotApplicationsOutput) String() string { +func (s ListTagsForResourceOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ListRobotApplicationsOutput) GoString() string { +func (s ListTagsForResourceOutput) GoString() string { return s.String() } -// SetNextToken sets the NextToken field's value. -func (s *ListRobotApplicationsOutput) SetNextToken(v string) *ListRobotApplicationsOutput { - s.NextToken = &v - return s -} - -// SetRobotApplicationSummaries sets the RobotApplicationSummaries field's value. -func (s *ListRobotApplicationsOutput) SetRobotApplicationSummaries(v []*RobotApplicationSummary) *ListRobotApplicationsOutput { - s.RobotApplicationSummaries = v +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput { + s.Tags = v return s } -type ListRobotsInput struct { +type ListWorldExportJobsInput struct { _ struct{} `type:"structure"` - // Optional filters to limit results. - // - // The filter names status and fleetName are supported. When filtering, you - // must use the complete value of the filtered item. You can use up to three - // filters, but they must be for the same named item. For example, if you are - // looking for items with the status Registered or the status Available. + // Optional filters to limit results. You can use generationJobId and templateId. Filters []*Filter `locationName:"filters" min:"1" type:"list"` - // When this parameter is used, ListRobots only returns maxResults results in - // a single page along with a nextToken response element. The remaining results - // of the initial request can be seen by sending another ListRobots request - // with the returned nextToken value. This value can be between 1 and 200. If - // this parameter is not used, then ListRobots returns up to 200 results and - // a nextToken value if applicable. + // When this parameter is used, ListWorldExportJobs only returns maxResults + // results in a single page along with a nextToken response element. The remaining + // results of the initial request can be seen by sending another ListWorldExportJobs + // request with the returned nextToken value. This value can be between 1 and + // 100. If this parameter is not used, then ListWorldExportJobs returns up to + // 100 results and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` - // The nextToken value returned from a previous paginated ListRobots request - // where maxResults was used and the results exceeded the value of that parameter. - // Pagination continues from the end of the previous results that returned the - // nextToken value. + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListWorldExportJobs again and assign that token + // to the request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation -func (s ListRobotsInput) String() string { +func (s ListWorldExportJobsInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ListRobotsInput) GoString() string { +func (s ListWorldExportJobsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListRobotsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListRobotsInput"} +func (s *ListWorldExportJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListWorldExportJobsInput"} if s.Filters != nil && len(s.Filters) < 1 { invalidParams.Add(request.NewErrParamMinLen("Filters", 1)) } @@ -9114,107 +13008,102 @@ func (s *ListRobotsInput) Validate() error { } // SetFilters sets the Filters field's value. -func (s *ListRobotsInput) SetFilters(v []*Filter) *ListRobotsInput { +func (s *ListWorldExportJobsInput) SetFilters(v []*Filter) *ListWorldExportJobsInput { s.Filters = v return s } // SetMaxResults sets the MaxResults field's value. -func (s *ListRobotsInput) SetMaxResults(v int64) *ListRobotsInput { +func (s *ListWorldExportJobsInput) SetMaxResults(v int64) *ListWorldExportJobsInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListRobotsInput) SetNextToken(v string) *ListRobotsInput { +func (s *ListWorldExportJobsInput) SetNextToken(v string) *ListWorldExportJobsInput { s.NextToken = &v return s } -type ListRobotsOutput struct { +type ListWorldExportJobsOutput struct { _ struct{} `type:"structure"` - // The nextToken value to include in a future ListRobots request. When the results - // of a ListRobot request exceed maxResults, this value can be used to retrieve - // the next page of results. This value is null when there are no more results - // to return. + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListWorldExportJobsRequest again and assign + // that token to the request object's nextToken parameter. If there are no remaining + // results, the previous response object's NextToken parameter is set to null. NextToken *string `locationName:"nextToken" min:"1" type:"string"` - // A list of robots that meet the criteria of the request. - Robots []*Robot `locationName:"robots" type:"list"` + // Summary information for world export jobs. + // + // WorldExportJobSummaries is a required field + WorldExportJobSummaries []*WorldExportJobSummary `locationName:"worldExportJobSummaries" type:"list" required:"true"` } // String returns the string representation -func (s ListRobotsOutput) String() string { +func (s ListWorldExportJobsOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ListRobotsOutput) GoString() string { +func (s ListWorldExportJobsOutput) GoString() string { return s.String() } // SetNextToken sets the NextToken field's value. -func (s *ListRobotsOutput) SetNextToken(v string) *ListRobotsOutput { +func (s *ListWorldExportJobsOutput) SetNextToken(v string) *ListWorldExportJobsOutput { s.NextToken = &v return s } -// SetRobots sets the Robots field's value. -func (s *ListRobotsOutput) SetRobots(v []*Robot) *ListRobotsOutput { - s.Robots = v +// SetWorldExportJobSummaries sets the WorldExportJobSummaries field's value. +func (s *ListWorldExportJobsOutput) SetWorldExportJobSummaries(v []*WorldExportJobSummary) *ListWorldExportJobsOutput { + s.WorldExportJobSummaries = v return s } -type ListSimulationApplicationsInput struct { +type ListWorldGenerationJobsInput struct { _ struct{} `type:"structure"` - // Optional list of filters to limit results. - // - // The filter name name is supported. When filtering, you must use the complete - // value of the filtered item. You can use up to three filters. + // Optional filters to limit results. You can use status and templateId. Filters []*Filter `locationName:"filters" min:"1" type:"list"` - // When this parameter is used, ListSimulationApplications only returns maxResults + // When this parameter is used, ListWorldGeneratorJobs only returns maxResults // results in a single page along with a nextToken response element. The remaining - // results of the initial request can be seen by sending another ListSimulationApplications + // results of the initial request can be seen by sending another ListWorldGeneratorJobs // request with the returned nextToken value. This value can be between 1 and - // 100. If this parameter is not used, then ListSimulationApplications returns - // up to 100 results and a nextToken value if applicable. + // 100. If this parameter is not used, then ListWorldGeneratorJobs returns up + // to 100 results and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` - // The nextToken value returned from a previous paginated ListSimulationApplications - // request where maxResults was used and the results exceeded the value of that - // parameter. Pagination continues from the end of the previous results that - // returned the nextToken value. + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListWorldGenerationJobsRequest again and assign + // that token to the request object's nextToken parameter. If there are no remaining + // results, the previous response object's NextToken parameter is set to null. NextToken *string `locationName:"nextToken" min:"1" type:"string"` - - // The version qualifier of the simulation application. - VersionQualifier *string `locationName:"versionQualifier" min:"1" type:"string"` } // String returns the string representation -func (s ListSimulationApplicationsInput) String() string { +func (s ListWorldGenerationJobsInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ListSimulationApplicationsInput) GoString() string { +func (s ListWorldGenerationJobsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListSimulationApplicationsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListSimulationApplicationsInput"} +func (s *ListWorldGenerationJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListWorldGenerationJobsInput"} if s.Filters != nil && len(s.Filters) < 1 { invalidParams.Add(request.NewErrParamMinLen("Filters", 1)) } if s.NextToken != nil && len(*s.NextToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } - if s.VersionQualifier != nil && len(*s.VersionQualifier) < 1 { - invalidParams.Add(request.NewErrParamMinLen("VersionQualifier", 1)) - } if s.Filters != nil { for i, v := range s.Filters { if v == nil { @@ -9233,113 +13122,96 @@ func (s *ListSimulationApplicationsInput) Validate() error { } // SetFilters sets the Filters field's value. -func (s *ListSimulationApplicationsInput) SetFilters(v []*Filter) *ListSimulationApplicationsInput { +func (s *ListWorldGenerationJobsInput) SetFilters(v []*Filter) *ListWorldGenerationJobsInput { s.Filters = v return s } // SetMaxResults sets the MaxResults field's value. -func (s *ListSimulationApplicationsInput) SetMaxResults(v int64) *ListSimulationApplicationsInput { +func (s *ListWorldGenerationJobsInput) SetMaxResults(v int64) *ListWorldGenerationJobsInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListSimulationApplicationsInput) SetNextToken(v string) *ListSimulationApplicationsInput { +func (s *ListWorldGenerationJobsInput) SetNextToken(v string) *ListWorldGenerationJobsInput { s.NextToken = &v return s } -// SetVersionQualifier sets the VersionQualifier field's value. -func (s *ListSimulationApplicationsInput) SetVersionQualifier(v string) *ListSimulationApplicationsInput { - s.VersionQualifier = &v - return s -} - -type ListSimulationApplicationsOutput struct { +type ListWorldGenerationJobsOutput struct { _ struct{} `type:"structure"` - // The nextToken value to include in a future ListSimulationApplications request. - // When the results of a ListRobot request exceed maxResults, this value can - // be used to retrieve the next page of results. This value is null when there - // are no more results to return. + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListWorldGeneratorJobsRequest again and assign + // that token to the request object's nextToken parameter. If there are no remaining + // results, the previous response object's NextToken parameter is set to null. NextToken *string `locationName:"nextToken" min:"1" type:"string"` - // A list of simulation application summaries that meet the criteria of the - // request. - SimulationApplicationSummaries []*SimulationApplicationSummary `locationName:"simulationApplicationSummaries" type:"list"` + // Summary information for world generator jobs. + // + // WorldGenerationJobSummaries is a required field + WorldGenerationJobSummaries []*WorldGenerationJobSummary `locationName:"worldGenerationJobSummaries" type:"list" required:"true"` } // String returns the string representation -func (s ListSimulationApplicationsOutput) String() string { +func (s ListWorldGenerationJobsOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ListSimulationApplicationsOutput) GoString() string { +func (s ListWorldGenerationJobsOutput) GoString() string { return s.String() } // SetNextToken sets the NextToken field's value. -func (s *ListSimulationApplicationsOutput) SetNextToken(v string) *ListSimulationApplicationsOutput { +func (s *ListWorldGenerationJobsOutput) SetNextToken(v string) *ListWorldGenerationJobsOutput { s.NextToken = &v return s } -// SetSimulationApplicationSummaries sets the SimulationApplicationSummaries field's value. -func (s *ListSimulationApplicationsOutput) SetSimulationApplicationSummaries(v []*SimulationApplicationSummary) *ListSimulationApplicationsOutput { - s.SimulationApplicationSummaries = v +// SetWorldGenerationJobSummaries sets the WorldGenerationJobSummaries field's value. +func (s *ListWorldGenerationJobsOutput) SetWorldGenerationJobSummaries(v []*WorldGenerationJobSummary) *ListWorldGenerationJobsOutput { + s.WorldGenerationJobSummaries = v return s } -type ListSimulationJobBatchesInput struct { +type ListWorldTemplatesInput struct { _ struct{} `type:"structure"` - // Optional filters to limit results. - Filters []*Filter `locationName:"filters" min:"1" type:"list"` - - // When this parameter is used, ListSimulationJobBatches only returns maxResults - // results in a single page along with a nextToken response element. The remaining - // results of the initial request can be seen by sending another ListSimulationJobBatches - // request with the returned nextToken value. + // When this parameter is used, ListWorldTemplates only returns maxResults results + // in a single page along with a nextToken response element. The remaining results + // of the initial request can be seen by sending another ListWorldTemplates + // request with the returned nextToken value. This value can be between 1 and + // 100. If this parameter is not used, then ListWorldTemplates returns up to + // 100 results and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` - // The nextToken value returned from a previous paginated ListSimulationJobBatches - // request where maxResults was used and the results exceeded the value of that - // parameter. Pagination continues from the end of the previous results that - // returned the nextToken value. + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListWorldTemplates again and assign that token + // to the request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation -func (s ListSimulationJobBatchesInput) String() string { +func (s ListWorldTemplatesInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ListSimulationJobBatchesInput) GoString() string { +func (s ListWorldTemplatesInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListSimulationJobBatchesInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListSimulationJobBatchesInput"} - if s.Filters != nil && len(s.Filters) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Filters", 1)) - } +func (s *ListWorldTemplatesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListWorldTemplatesInput"} if s.NextToken != nil && len(*s.NextToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } - if s.Filters != nil { - for i, v := range s.Filters { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams)) - } - } - } if invalidParams.Len() > 0 { return invalidParams @@ -9347,102 +13219,89 @@ func (s *ListSimulationJobBatchesInput) Validate() error { return nil } -// SetFilters sets the Filters field's value. -func (s *ListSimulationJobBatchesInput) SetFilters(v []*Filter) *ListSimulationJobBatchesInput { - s.Filters = v - return s -} - // SetMaxResults sets the MaxResults field's value. -func (s *ListSimulationJobBatchesInput) SetMaxResults(v int64) *ListSimulationJobBatchesInput { +func (s *ListWorldTemplatesInput) SetMaxResults(v int64) *ListWorldTemplatesInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListSimulationJobBatchesInput) SetNextToken(v string) *ListSimulationJobBatchesInput { +func (s *ListWorldTemplatesInput) SetNextToken(v string) *ListWorldTemplatesInput { s.NextToken = &v return s } -type ListSimulationJobBatchesOutput struct { +type ListWorldTemplatesOutput struct { _ struct{} `type:"structure"` - // The nextToken value to include in a future ListSimulationJobBatches request. - // When the results of a ListSimulationJobBatches request exceed maxResults, - // this value can be used to retrieve the next page of results. This value is - // null when there are no more results to return. + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListWorldTemplates again and assign that token + // to the request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. NextToken *string `locationName:"nextToken" min:"1" type:"string"` - // A list of simulation job batch summaries. - SimulationJobBatchSummaries []*SimulationJobBatchSummary `locationName:"simulationJobBatchSummaries" type:"list"` + // Summary information for templates. + TemplateSummaries []*TemplateSummary `locationName:"templateSummaries" type:"list"` } // String returns the string representation -func (s ListSimulationJobBatchesOutput) String() string { +func (s ListWorldTemplatesOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ListSimulationJobBatchesOutput) GoString() string { +func (s ListWorldTemplatesOutput) GoString() string { return s.String() } // SetNextToken sets the NextToken field's value. -func (s *ListSimulationJobBatchesOutput) SetNextToken(v string) *ListSimulationJobBatchesOutput { +func (s *ListWorldTemplatesOutput) SetNextToken(v string) *ListWorldTemplatesOutput { s.NextToken = &v return s } -// SetSimulationJobBatchSummaries sets the SimulationJobBatchSummaries field's value. -func (s *ListSimulationJobBatchesOutput) SetSimulationJobBatchSummaries(v []*SimulationJobBatchSummary) *ListSimulationJobBatchesOutput { - s.SimulationJobBatchSummaries = v +// SetTemplateSummaries sets the TemplateSummaries field's value. +func (s *ListWorldTemplatesOutput) SetTemplateSummaries(v []*TemplateSummary) *ListWorldTemplatesOutput { + s.TemplateSummaries = v return s } -type ListSimulationJobsInput struct { +type ListWorldsInput struct { _ struct{} `type:"structure"` - // Optional filters to limit results. - // - // The filter names status and simulationApplicationName and robotApplicationName - // are supported. When filtering, you must use the complete value of the filtered - // item. You can use up to three filters, but they must be for the same named - // item. For example, if you are looking for items with the status Preparing - // or the status Running. + // Optional filters to limit results. You can use status. Filters []*Filter `locationName:"filters" min:"1" type:"list"` - // When this parameter is used, ListSimulationJobs only returns maxResults results - // in a single page along with a nextToken response element. The remaining results - // of the initial request can be seen by sending another ListSimulationJobs - // request with the returned nextToken value. This value can be between 1 and - // 1000. If this parameter is not used, then ListSimulationJobs returns up to - // 1000 results and a nextToken value if applicable. + // When this parameter is used, ListWorlds only returns maxResults results in + // a single page along with a nextToken response element. The remaining results + // of the initial request can be seen by sending another ListWorlds request + // with the returned nextToken value. This value can be between 1 and 100. If + // this parameter is not used, then ListWorlds returns up to 100 results and + // a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` - // The nextToken value returned from a previous paginated ListSimulationJobs - // request where maxResults was used and the results exceeded the value of that - // parameter. Pagination continues from the end of the previous results that - // returned the nextToken value. - // - // This token should be treated as an opaque identifier that is only used to - // retrieve the next items in a list and not for other programmatic purposes. + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListWorlds again and assign that token to the + // request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation -func (s ListSimulationJobsInput) String() string { +func (s ListWorldsInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ListSimulationJobsInput) GoString() string { +func (s ListWorldsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListSimulationJobsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListSimulationJobsInput"} +func (s *ListWorldsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListWorldsInput"} if s.Filters != nil && len(s.Filters) < 1 { invalidParams.Add(request.NewErrParamMinLen("Filters", 1)) } @@ -9467,121 +13326,56 @@ func (s *ListSimulationJobsInput) Validate() error { } // SetFilters sets the Filters field's value. -func (s *ListSimulationJobsInput) SetFilters(v []*Filter) *ListSimulationJobsInput { +func (s *ListWorldsInput) SetFilters(v []*Filter) *ListWorldsInput { s.Filters = v return s } // SetMaxResults sets the MaxResults field's value. -func (s *ListSimulationJobsInput) SetMaxResults(v int64) *ListSimulationJobsInput { +func (s *ListWorldsInput) SetMaxResults(v int64) *ListWorldsInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListSimulationJobsInput) SetNextToken(v string) *ListSimulationJobsInput { +func (s *ListWorldsInput) SetNextToken(v string) *ListWorldsInput { s.NextToken = &v return s } -type ListSimulationJobsOutput struct { +type ListWorldsOutput struct { _ struct{} `type:"structure"` - // The nextToken value to include in a future ListSimulationJobs request. When - // the results of a ListRobot request exceed maxResults, this value can be used - // to retrieve the next page of results. This value is null when there are no - // more results to return. + // If the previous paginated request did not return all of the remaining results, + // the response object's nextToken parameter value is set to a token. To retrieve + // the next set of results, call ListWorlds again and assign that token to the + // request object's nextToken parameter. If there are no remaining results, + // the previous response object's NextToken parameter is set to null. NextToken *string `locationName:"nextToken" min:"1" type:"string"` - // A list of simulation job summaries that meet the criteria of the request. - // - // SimulationJobSummaries is a required field - SimulationJobSummaries []*SimulationJobSummary `locationName:"simulationJobSummaries" type:"list" required:"true"` + // Summary information for worlds. + WorldSummaries []*WorldSummary `locationName:"worldSummaries" type:"list"` } // String returns the string representation -func (s ListSimulationJobsOutput) String() string { +func (s ListWorldsOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s ListSimulationJobsOutput) GoString() string { +func (s ListWorldsOutput) GoString() string { return s.String() } // SetNextToken sets the NextToken field's value. -func (s *ListSimulationJobsOutput) SetNextToken(v string) *ListSimulationJobsOutput { +func (s *ListWorldsOutput) SetNextToken(v string) *ListWorldsOutput { s.NextToken = &v return s } -// SetSimulationJobSummaries sets the SimulationJobSummaries field's value. -func (s *ListSimulationJobsOutput) SetSimulationJobSummaries(v []*SimulationJobSummary) *ListSimulationJobsOutput { - s.SimulationJobSummaries = v - return s -} - -type ListTagsForResourceInput struct { - _ struct{} `type:"structure"` - - // The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed. - // - // ResourceArn is a required field - ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"` -} - -// String returns the string representation -func (s ListTagsForResourceInput) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s ListTagsForResourceInput) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *ListTagsForResourceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} - if s.ResourceArn == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceArn")) - } - if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetResourceArn sets the ResourceArn field's value. -func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { - s.ResourceArn = &v - return s -} - -type ListTagsForResourceOutput struct { - _ struct{} `type:"structure"` - - // The list of all tags added to the specified resource. - Tags map[string]*string `locationName:"tags" type:"map"` -} - -// String returns the string representation -func (s ListTagsForResourceOutput) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation -func (s ListTagsForResourceOutput) GoString() string { - return s.String() -} - -// SetTags sets the Tags field's value. -func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput { - s.Tags = v +// SetWorldSummaries sets the WorldSummaries field's value. +func (s *ListWorldsOutput) SetWorldSummaries(v []*WorldSummary) *ListWorldsOutput { + s.WorldSummaries = v return s } @@ -10723,6 +14517,9 @@ type SimulationApplicationConfig struct { // // LaunchConfig is a required field LaunchConfig *LaunchConfig `locationName:"launchConfig" type:"structure" required:"true"` + + // A list of world configurations. + WorldConfigs []*WorldConfig `locationName:"worldConfigs" type:"list"` } // String returns the string representation @@ -10755,6 +14552,16 @@ func (s *SimulationApplicationConfig) Validate() error { invalidParams.AddNested("LaunchConfig", err.(request.ErrInvalidParams)) } } + if s.WorldConfigs != nil { + for i, v := range s.WorldConfigs { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "WorldConfigs", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -10780,6 +14587,12 @@ func (s *SimulationApplicationConfig) SetLaunchConfig(v *LaunchConfig) *Simulati return s } +// SetWorldConfigs sets the WorldConfigs field's value. +func (s *SimulationApplicationConfig) SetWorldConfigs(v []*WorldConfig) *SimulationApplicationConfig { + s.WorldConfigs = v + return s +} + // Summary information for a simulation application. type SimulationApplicationSummary struct { _ struct{} `type:"structure"` @@ -12148,6 +15961,116 @@ func (s TagResourceOutput) GoString() string { return s.String() } +// Information about a template location. +type TemplateLocation struct { + _ struct{} `type:"structure"` + + // The Amazon S3 bucket name. + // + // S3Bucket is a required field + S3Bucket *string `locationName:"s3Bucket" min:"3" type:"string" required:"true"` + + // The list of S3 keys identifying the data source files. + // + // S3Key is a required field + S3Key *string `locationName:"s3Key" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s TemplateLocation) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TemplateLocation) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TemplateLocation) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TemplateLocation"} + if s.S3Bucket == nil { + invalidParams.Add(request.NewErrParamRequired("S3Bucket")) + } + if s.S3Bucket != nil && len(*s.S3Bucket) < 3 { + invalidParams.Add(request.NewErrParamMinLen("S3Bucket", 3)) + } + if s.S3Key == nil { + invalidParams.Add(request.NewErrParamRequired("S3Key")) + } + if s.S3Key != nil && len(*s.S3Key) < 1 { + invalidParams.Add(request.NewErrParamMinLen("S3Key", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetS3Bucket sets the S3Bucket field's value. +func (s *TemplateLocation) SetS3Bucket(v string) *TemplateLocation { + s.S3Bucket = &v + return s +} + +// SetS3Key sets the S3Key field's value. +func (s *TemplateLocation) SetS3Key(v string) *TemplateLocation { + s.S3Key = &v + return s +} + +// Summary information for a template. +type TemplateSummary struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the template. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // The time, in milliseconds since the epoch, when the template was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + + // The time, in milliseconds since the epoch, when the template was last updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` + + // The name of the template. + Name *string `locationName:"name" type:"string"` +} + +// String returns the string representation +func (s TemplateSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TemplateSummary) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *TemplateSummary) SetArn(v string) *TemplateSummary { + s.Arn = &v + return s +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *TemplateSummary) SetCreatedAt(v time.Time) *TemplateSummary { + s.CreatedAt = &v + return s +} + +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *TemplateSummary) SetLastUpdatedAt(v time.Time) *TemplateSummary { + s.LastUpdatedAt = &v + return s +} + +// SetName sets the Name field's value. +func (s *TemplateSummary) SetName(v string) *TemplateSummary { + s.Name = &v + return s +} + // AWS RoboMaker is temporarily unable to process the request. Try your call // again. type ThrottlingException struct { @@ -12222,64 +16145,233 @@ type UntagResourceInput struct { } // String returns the string representation -func (s UntagResourceInput) String() string { +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UntagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UntagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UntagResourceOutput) GoString() string { + return s.String() +} + +type UpdateRobotApplicationInput struct { + _ struct{} `type:"structure"` + + // The application information for the robot application. + // + // Application is a required field + Application *string `locationName:"application" min:"1" type:"string" required:"true"` + + // The revision id for the robot application. + CurrentRevisionId *string `locationName:"currentRevisionId" min:"1" type:"string"` + + // The robot software suite (ROS distribution) used by the robot application. + // + // RobotSoftwareSuite is a required field + RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure" required:"true"` + + // The sources of the robot application. + // + // Sources is a required field + Sources []*SourceConfig `locationName:"sources" type:"list" required:"true"` +} + +// String returns the string representation +func (s UpdateRobotApplicationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateRobotApplicationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateRobotApplicationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateRobotApplicationInput"} + if s.Application == nil { + invalidParams.Add(request.NewErrParamRequired("Application")) + } + if s.Application != nil && len(*s.Application) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Application", 1)) + } + if s.CurrentRevisionId != nil && len(*s.CurrentRevisionId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CurrentRevisionId", 1)) + } + if s.RobotSoftwareSuite == nil { + invalidParams.Add(request.NewErrParamRequired("RobotSoftwareSuite")) + } + if s.Sources == nil { + invalidParams.Add(request.NewErrParamRequired("Sources")) + } + if s.Sources != nil { + for i, v := range s.Sources { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Sources", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplication sets the Application field's value. +func (s *UpdateRobotApplicationInput) SetApplication(v string) *UpdateRobotApplicationInput { + s.Application = &v + return s +} + +// SetCurrentRevisionId sets the CurrentRevisionId field's value. +func (s *UpdateRobotApplicationInput) SetCurrentRevisionId(v string) *UpdateRobotApplicationInput { + s.CurrentRevisionId = &v + return s +} + +// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. +func (s *UpdateRobotApplicationInput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *UpdateRobotApplicationInput { + s.RobotSoftwareSuite = v + return s +} + +// SetSources sets the Sources field's value. +func (s *UpdateRobotApplicationInput) SetSources(v []*SourceConfig) *UpdateRobotApplicationInput { + s.Sources = v + return s +} + +type UpdateRobotApplicationOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the updated robot application. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // The time, in milliseconds since the epoch, when the robot application was + // last updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` + + // The name of the robot application. + Name *string `locationName:"name" min:"1" type:"string"` + + // The revision id of the robot application. + RevisionId *string `locationName:"revisionId" min:"1" type:"string"` + + // The robot software suite (ROS distribution) used by the robot application. + RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` + + // The sources of the robot application. + Sources []*Source `locationName:"sources" type:"list"` + + // The version of the robot application. + Version *string `locationName:"version" min:"1" type:"string"` +} + +// String returns the string representation +func (s UpdateRobotApplicationOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s UntagResourceInput) GoString() string { +func (s UpdateRobotApplicationOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *UntagResourceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} - if s.ResourceArn == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceArn")) - } - if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) - } - if s.TagKeys == nil { - invalidParams.Add(request.NewErrParamRequired("TagKeys")) - } +// SetArn sets the Arn field's value. +func (s *UpdateRobotApplicationOutput) SetArn(v string) *UpdateRobotApplicationOutput { + s.Arn = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *UpdateRobotApplicationOutput) SetLastUpdatedAt(v time.Time) *UpdateRobotApplicationOutput { + s.LastUpdatedAt = &v + return s } -// SetResourceArn sets the ResourceArn field's value. -func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { - s.ResourceArn = &v +// SetName sets the Name field's value. +func (s *UpdateRobotApplicationOutput) SetName(v string) *UpdateRobotApplicationOutput { + s.Name = &v return s } -// SetTagKeys sets the TagKeys field's value. -func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { - s.TagKeys = v +// SetRevisionId sets the RevisionId field's value. +func (s *UpdateRobotApplicationOutput) SetRevisionId(v string) *UpdateRobotApplicationOutput { + s.RevisionId = &v return s } -type UntagResourceOutput struct { - _ struct{} `type:"structure"` +// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. +func (s *UpdateRobotApplicationOutput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *UpdateRobotApplicationOutput { + s.RobotSoftwareSuite = v + return s } -// String returns the string representation -func (s UntagResourceOutput) String() string { - return awsutil.Prettify(s) +// SetSources sets the Sources field's value. +func (s *UpdateRobotApplicationOutput) SetSources(v []*Source) *UpdateRobotApplicationOutput { + s.Sources = v + return s } -// GoString returns the string representation -func (s UntagResourceOutput) GoString() string { - return s.String() +// SetVersion sets the Version field's value. +func (s *UpdateRobotApplicationOutput) SetVersion(v string) *UpdateRobotApplicationOutput { + s.Version = &v + return s } -type UpdateRobotApplicationInput struct { +type UpdateSimulationApplicationInput struct { _ struct{} `type:"structure"` - // The application information for the robot application. + // The application information for the simulation application. // // Application is a required field Application *string `locationName:"application" min:"1" type:"string" required:"true"` @@ -12287,30 +16379,38 @@ type UpdateRobotApplicationInput struct { // The revision id for the robot application. CurrentRevisionId *string `locationName:"currentRevisionId" min:"1" type:"string"` - // The robot software suite (ROS distribution) used by the robot application. + // The rendering engine for the simulation application. + RenderingEngine *RenderingEngine `locationName:"renderingEngine" type:"structure"` + + // Information about the robot software suite (ROS distribution). // // RobotSoftwareSuite is a required field RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure" required:"true"` - // The sources of the robot application. + // The simulation software suite used by the simulation application. + // + // SimulationSoftwareSuite is a required field + SimulationSoftwareSuite *SimulationSoftwareSuite `locationName:"simulationSoftwareSuite" type:"structure" required:"true"` + + // The sources of the simulation application. // // Sources is a required field Sources []*SourceConfig `locationName:"sources" type:"list" required:"true"` } // String returns the string representation -func (s UpdateRobotApplicationInput) String() string { +func (s UpdateSimulationApplicationInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s UpdateRobotApplicationInput) GoString() string { +func (s UpdateSimulationApplicationInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *UpdateRobotApplicationInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "UpdateRobotApplicationInput"} +func (s *UpdateSimulationApplicationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateSimulationApplicationInput"} if s.Application == nil { invalidParams.Add(request.NewErrParamRequired("Application")) } @@ -12323,9 +16423,17 @@ func (s *UpdateRobotApplicationInput) Validate() error { if s.RobotSoftwareSuite == nil { invalidParams.Add(request.NewErrParamRequired("RobotSoftwareSuite")) } + if s.SimulationSoftwareSuite == nil { + invalidParams.Add(request.NewErrParamRequired("SimulationSoftwareSuite")) + } if s.Sources == nil { invalidParams.Add(request.NewErrParamRequired("Sources")) } + if s.RenderingEngine != nil { + if err := s.RenderingEngine.Validate(); err != nil { + invalidParams.AddNested("RenderingEngine", err.(request.ErrInvalidParams)) + } + } if s.Sources != nil { for i, v := range s.Sources { if v == nil { @@ -12343,183 +16451,305 @@ func (s *UpdateRobotApplicationInput) Validate() error { return nil } -// SetApplication sets the Application field's value. -func (s *UpdateRobotApplicationInput) SetApplication(v string) *UpdateRobotApplicationInput { - s.Application = &v +// SetApplication sets the Application field's value. +func (s *UpdateSimulationApplicationInput) SetApplication(v string) *UpdateSimulationApplicationInput { + s.Application = &v + return s +} + +// SetCurrentRevisionId sets the CurrentRevisionId field's value. +func (s *UpdateSimulationApplicationInput) SetCurrentRevisionId(v string) *UpdateSimulationApplicationInput { + s.CurrentRevisionId = &v + return s +} + +// SetRenderingEngine sets the RenderingEngine field's value. +func (s *UpdateSimulationApplicationInput) SetRenderingEngine(v *RenderingEngine) *UpdateSimulationApplicationInput { + s.RenderingEngine = v + return s +} + +// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. +func (s *UpdateSimulationApplicationInput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *UpdateSimulationApplicationInput { + s.RobotSoftwareSuite = v + return s +} + +// SetSimulationSoftwareSuite sets the SimulationSoftwareSuite field's value. +func (s *UpdateSimulationApplicationInput) SetSimulationSoftwareSuite(v *SimulationSoftwareSuite) *UpdateSimulationApplicationInput { + s.SimulationSoftwareSuite = v + return s +} + +// SetSources sets the Sources field's value. +func (s *UpdateSimulationApplicationInput) SetSources(v []*SourceConfig) *UpdateSimulationApplicationInput { + s.Sources = v + return s +} + +type UpdateSimulationApplicationOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the updated simulation application. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // The time, in milliseconds since the epoch, when the simulation application + // was last updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` + + // The name of the simulation application. + Name *string `locationName:"name" min:"1" type:"string"` + + // The rendering engine for the simulation application. + RenderingEngine *RenderingEngine `locationName:"renderingEngine" type:"structure"` + + // The revision id of the simulation application. + RevisionId *string `locationName:"revisionId" min:"1" type:"string"` + + // Information about the robot software suite (ROS distribution). + RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` + + // The simulation software suite used by the simulation application. + SimulationSoftwareSuite *SimulationSoftwareSuite `locationName:"simulationSoftwareSuite" type:"structure"` + + // The sources of the simulation application. + Sources []*Source `locationName:"sources" type:"list"` + + // The version of the robot application. + Version *string `locationName:"version" min:"1" type:"string"` +} + +// String returns the string representation +func (s UpdateSimulationApplicationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateSimulationApplicationOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *UpdateSimulationApplicationOutput) SetArn(v string) *UpdateSimulationApplicationOutput { + s.Arn = &v + return s +} + +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *UpdateSimulationApplicationOutput) SetLastUpdatedAt(v time.Time) *UpdateSimulationApplicationOutput { + s.LastUpdatedAt = &v + return s +} + +// SetName sets the Name field's value. +func (s *UpdateSimulationApplicationOutput) SetName(v string) *UpdateSimulationApplicationOutput { + s.Name = &v + return s +} + +// SetRenderingEngine sets the RenderingEngine field's value. +func (s *UpdateSimulationApplicationOutput) SetRenderingEngine(v *RenderingEngine) *UpdateSimulationApplicationOutput { + s.RenderingEngine = v + return s +} + +// SetRevisionId sets the RevisionId field's value. +func (s *UpdateSimulationApplicationOutput) SetRevisionId(v string) *UpdateSimulationApplicationOutput { + s.RevisionId = &v + return s +} + +// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. +func (s *UpdateSimulationApplicationOutput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *UpdateSimulationApplicationOutput { + s.RobotSoftwareSuite = v + return s +} + +// SetSimulationSoftwareSuite sets the SimulationSoftwareSuite field's value. +func (s *UpdateSimulationApplicationOutput) SetSimulationSoftwareSuite(v *SimulationSoftwareSuite) *UpdateSimulationApplicationOutput { + s.SimulationSoftwareSuite = v + return s +} + +// SetSources sets the Sources field's value. +func (s *UpdateSimulationApplicationOutput) SetSources(v []*Source) *UpdateSimulationApplicationOutput { + s.Sources = v + return s +} + +// SetVersion sets the Version field's value. +func (s *UpdateSimulationApplicationOutput) SetVersion(v string) *UpdateSimulationApplicationOutput { + s.Version = &v + return s +} + +type UpdateWorldTemplateInput struct { + _ struct{} `type:"structure"` + + // The name of the template. + Name *string `locationName:"name" type:"string"` + + // The Amazon Resource Name (arn) of the world template to update. + // + // Template is a required field + Template *string `locationName:"template" min:"1" type:"string" required:"true"` + + // The world template body. + TemplateBody *string `locationName:"templateBody" min:"1" type:"string"` + + // The location of the world template. + TemplateLocation *TemplateLocation `locationName:"templateLocation" type:"structure"` +} + +// String returns the string representation +func (s UpdateWorldTemplateInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateWorldTemplateInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateWorldTemplateInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateWorldTemplateInput"} + if s.Template == nil { + invalidParams.Add(request.NewErrParamRequired("Template")) + } + if s.Template != nil && len(*s.Template) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Template", 1)) + } + if s.TemplateBody != nil && len(*s.TemplateBody) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TemplateBody", 1)) + } + if s.TemplateLocation != nil { + if err := s.TemplateLocation.Validate(); err != nil { + invalidParams.AddNested("TemplateLocation", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *UpdateWorldTemplateInput) SetName(v string) *UpdateWorldTemplateInput { + s.Name = &v return s } -// SetCurrentRevisionId sets the CurrentRevisionId field's value. -func (s *UpdateRobotApplicationInput) SetCurrentRevisionId(v string) *UpdateRobotApplicationInput { - s.CurrentRevisionId = &v +// SetTemplate sets the Template field's value. +func (s *UpdateWorldTemplateInput) SetTemplate(v string) *UpdateWorldTemplateInput { + s.Template = &v return s } -// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. -func (s *UpdateRobotApplicationInput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *UpdateRobotApplicationInput { - s.RobotSoftwareSuite = v +// SetTemplateBody sets the TemplateBody field's value. +func (s *UpdateWorldTemplateInput) SetTemplateBody(v string) *UpdateWorldTemplateInput { + s.TemplateBody = &v return s } -// SetSources sets the Sources field's value. -func (s *UpdateRobotApplicationInput) SetSources(v []*SourceConfig) *UpdateRobotApplicationInput { - s.Sources = v +// SetTemplateLocation sets the TemplateLocation field's value. +func (s *UpdateWorldTemplateInput) SetTemplateLocation(v *TemplateLocation) *UpdateWorldTemplateInput { + s.TemplateLocation = v return s } -type UpdateRobotApplicationOutput struct { +type UpdateWorldTemplateOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the updated robot application. + // The Amazon Resource Name (arn) of the world template. Arn *string `locationName:"arn" min:"1" type:"string"` - // The time, in milliseconds since the epoch, when the robot application was - // last updated. - LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` - - // The name of the robot application. - Name *string `locationName:"name" min:"1" type:"string"` - - // The revision id of the robot application. - RevisionId *string `locationName:"revisionId" min:"1" type:"string"` - - // The robot software suite (ROS distribution) used by the robot application. - RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` + // The time, in milliseconds since the epoch, when the world template was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The sources of the robot application. - Sources []*Source `locationName:"sources" type:"list"` + // The time, in milliseconds since the epoch, when the world template was last + // updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` - // The version of the robot application. - Version *string `locationName:"version" min:"1" type:"string"` + // The name of the world template. + Name *string `locationName:"name" type:"string"` } // String returns the string representation -func (s UpdateRobotApplicationOutput) String() string { +func (s UpdateWorldTemplateOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s UpdateRobotApplicationOutput) GoString() string { +func (s UpdateWorldTemplateOutput) GoString() string { return s.String() } // SetArn sets the Arn field's value. -func (s *UpdateRobotApplicationOutput) SetArn(v string) *UpdateRobotApplicationOutput { +func (s *UpdateWorldTemplateOutput) SetArn(v string) *UpdateWorldTemplateOutput { s.Arn = &v return s } +// SetCreatedAt sets the CreatedAt field's value. +func (s *UpdateWorldTemplateOutput) SetCreatedAt(v time.Time) *UpdateWorldTemplateOutput { + s.CreatedAt = &v + return s +} + // SetLastUpdatedAt sets the LastUpdatedAt field's value. -func (s *UpdateRobotApplicationOutput) SetLastUpdatedAt(v time.Time) *UpdateRobotApplicationOutput { +func (s *UpdateWorldTemplateOutput) SetLastUpdatedAt(v time.Time) *UpdateWorldTemplateOutput { s.LastUpdatedAt = &v return s } // SetName sets the Name field's value. -func (s *UpdateRobotApplicationOutput) SetName(v string) *UpdateRobotApplicationOutput { +func (s *UpdateWorldTemplateOutput) SetName(v string) *UpdateWorldTemplateOutput { s.Name = &v return s } -// SetRevisionId sets the RevisionId field's value. -func (s *UpdateRobotApplicationOutput) SetRevisionId(v string) *UpdateRobotApplicationOutput { - s.RevisionId = &v - return s -} - -// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. -func (s *UpdateRobotApplicationOutput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *UpdateRobotApplicationOutput { - s.RobotSoftwareSuite = v - return s -} - -// SetSources sets the Sources field's value. -func (s *UpdateRobotApplicationOutput) SetSources(v []*Source) *UpdateRobotApplicationOutput { - s.Sources = v - return s -} - -// SetVersion sets the Version field's value. -func (s *UpdateRobotApplicationOutput) SetVersion(v string) *UpdateRobotApplicationOutput { - s.Version = &v - return s -} - -type UpdateSimulationApplicationInput struct { +// If your simulation job accesses resources in a VPC, you provide this parameter +// identifying the list of security group IDs and subnet IDs. These must belong +// to the same VPC. You must provide at least one security group and two subnet +// IDs. +type VPCConfig struct { _ struct{} `type:"structure"` - // The application information for the simulation application. - // - // Application is a required field - Application *string `locationName:"application" min:"1" type:"string" required:"true"` - - // The revision id for the robot application. - CurrentRevisionId *string `locationName:"currentRevisionId" min:"1" type:"string"` - - // The rendering engine for the simulation application. - RenderingEngine *RenderingEngine `locationName:"renderingEngine" type:"structure"` - - // Information about the robot software suite (ROS distribution). - // - // RobotSoftwareSuite is a required field - RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure" required:"true"` + // A boolean indicating whether to assign a public IP address. + AssignPublicIp *bool `locationName:"assignPublicIp" type:"boolean"` - // The simulation software suite used by the simulation application. - // - // SimulationSoftwareSuite is a required field - SimulationSoftwareSuite *SimulationSoftwareSuite `locationName:"simulationSoftwareSuite" type:"structure" required:"true"` + // A list of one or more security groups IDs in your VPC. + SecurityGroups []*string `locationName:"securityGroups" min:"1" type:"list"` - // The sources of the simulation application. + // A list of one or more subnet IDs in your VPC. // - // Sources is a required field - Sources []*SourceConfig `locationName:"sources" type:"list" required:"true"` + // Subnets is a required field + Subnets []*string `locationName:"subnets" min:"1" type:"list" required:"true"` } // String returns the string representation -func (s UpdateSimulationApplicationInput) String() string { +func (s VPCConfig) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s UpdateSimulationApplicationInput) GoString() string { +func (s VPCConfig) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *UpdateSimulationApplicationInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "UpdateSimulationApplicationInput"} - if s.Application == nil { - invalidParams.Add(request.NewErrParamRequired("Application")) - } - if s.Application != nil && len(*s.Application) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Application", 1)) - } - if s.CurrentRevisionId != nil && len(*s.CurrentRevisionId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("CurrentRevisionId", 1)) - } - if s.RobotSoftwareSuite == nil { - invalidParams.Add(request.NewErrParamRequired("RobotSoftwareSuite")) - } - if s.SimulationSoftwareSuite == nil { - invalidParams.Add(request.NewErrParamRequired("SimulationSoftwareSuite")) - } - if s.Sources == nil { - invalidParams.Add(request.NewErrParamRequired("Sources")) +func (s *VPCConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "VPCConfig"} + if s.SecurityGroups != nil && len(s.SecurityGroups) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SecurityGroups", 1)) } - if s.RenderingEngine != nil { - if err := s.RenderingEngine.Validate(); err != nil { - invalidParams.AddNested("RenderingEngine", err.(request.ErrInvalidParams)) - } + if s.Subnets == nil { + invalidParams.Add(request.NewErrParamRequired("Subnets")) } - if s.Sources != nil { - for i, v := range s.Sources { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Sources", i), err.(request.ErrInvalidParams)) - } - } + if s.Subnets != nil && len(s.Subnets) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Subnets", 1)) } if invalidParams.Len() > 0 { @@ -12528,252 +16758,447 @@ func (s *UpdateSimulationApplicationInput) Validate() error { return nil } -// SetApplication sets the Application field's value. -func (s *UpdateSimulationApplicationInput) SetApplication(v string) *UpdateSimulationApplicationInput { - s.Application = &v +// SetAssignPublicIp sets the AssignPublicIp field's value. +func (s *VPCConfig) SetAssignPublicIp(v bool) *VPCConfig { + s.AssignPublicIp = &v return s } -// SetCurrentRevisionId sets the CurrentRevisionId field's value. -func (s *UpdateSimulationApplicationInput) SetCurrentRevisionId(v string) *UpdateSimulationApplicationInput { - s.CurrentRevisionId = &v +// SetSecurityGroups sets the SecurityGroups field's value. +func (s *VPCConfig) SetSecurityGroups(v []*string) *VPCConfig { + s.SecurityGroups = v return s } -// SetRenderingEngine sets the RenderingEngine field's value. -func (s *UpdateSimulationApplicationInput) SetRenderingEngine(v *RenderingEngine) *UpdateSimulationApplicationInput { - s.RenderingEngine = v +// SetSubnets sets the Subnets field's value. +func (s *VPCConfig) SetSubnets(v []*string) *VPCConfig { + s.Subnets = v return s } -// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. -func (s *UpdateSimulationApplicationInput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *UpdateSimulationApplicationInput { - s.RobotSoftwareSuite = v +// VPC configuration associated with your simulation job. +type VPCConfigResponse struct { + _ struct{} `type:"structure"` + + // A boolean indicating if a public IP was assigned. + AssignPublicIp *bool `locationName:"assignPublicIp" type:"boolean"` + + // A list of security group IDs associated with the simulation job. + SecurityGroups []*string `locationName:"securityGroups" min:"1" type:"list"` + + // A list of subnet IDs associated with the simulation job. + Subnets []*string `locationName:"subnets" min:"1" type:"list"` + + // The VPC ID associated with your simulation job. + VpcId *string `locationName:"vpcId" type:"string"` +} + +// String returns the string representation +func (s VPCConfigResponse) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s VPCConfigResponse) GoString() string { + return s.String() +} + +// SetAssignPublicIp sets the AssignPublicIp field's value. +func (s *VPCConfigResponse) SetAssignPublicIp(v bool) *VPCConfigResponse { + s.AssignPublicIp = &v return s } -// SetSimulationSoftwareSuite sets the SimulationSoftwareSuite field's value. -func (s *UpdateSimulationApplicationInput) SetSimulationSoftwareSuite(v *SimulationSoftwareSuite) *UpdateSimulationApplicationInput { - s.SimulationSoftwareSuite = v +// SetSecurityGroups sets the SecurityGroups field's value. +func (s *VPCConfigResponse) SetSecurityGroups(v []*string) *VPCConfigResponse { + s.SecurityGroups = v return s } -// SetSources sets the Sources field's value. -func (s *UpdateSimulationApplicationInput) SetSources(v []*SourceConfig) *UpdateSimulationApplicationInput { - s.Sources = v +// SetSubnets sets the Subnets field's value. +func (s *VPCConfigResponse) SetSubnets(v []*string) *VPCConfigResponse { + s.Subnets = v return s } -type UpdateSimulationApplicationOutput struct { +// SetVpcId sets the VpcId field's value. +func (s *VPCConfigResponse) SetVpcId(v string) *VPCConfigResponse { + s.VpcId = &v + return s +} + +// Configuration information for a world. +type WorldConfig struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the updated simulation application. - Arn *string `locationName:"arn" min:"1" type:"string"` + // The world generated by Simulation WorldForge. + World *string `locationName:"world" min:"1" type:"string"` +} - // The time, in milliseconds since the epoch, when the simulation application - // was last updated. - LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` +// String returns the string representation +func (s WorldConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s WorldConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *WorldConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "WorldConfig"} + if s.World != nil && len(*s.World) < 1 { + invalidParams.Add(request.NewErrParamMinLen("World", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetWorld sets the World field's value. +func (s *WorldConfig) SetWorld(v string) *WorldConfig { + s.World = &v + return s +} + +// The number of worlds that will be created. You can configure the number of +// unique floorplans and the number of unique interiors for each floor plan. +// For example, if you want 1 world with 20 unique interiors, you set floorplanCount +// = 1 and interiorCountPerFloorplan = 20. This will result in 20 worlds (floorplanCount +// * interiorCountPerFloorplan). +// +// If you set floorplanCount = 4 and interiorCountPerFloorplan = 5, there will +// be 20 worlds with 5 unique floor plans. +type WorldCount struct { + _ struct{} `type:"structure"` + + // The number of unique floorplans. + FloorplanCount *int64 `locationName:"floorplanCount" type:"integer"` + + // The number of unique interiors per floorplan. + InteriorCountPerFloorplan *int64 `locationName:"interiorCountPerFloorplan" type:"integer"` +} + +// String returns the string representation +func (s WorldCount) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s WorldCount) GoString() string { + return s.String() +} - // The name of the simulation application. - Name *string `locationName:"name" min:"1" type:"string"` +// SetFloorplanCount sets the FloorplanCount field's value. +func (s *WorldCount) SetFloorplanCount(v int64) *WorldCount { + s.FloorplanCount = &v + return s +} - // The rendering engine for the simulation application. - RenderingEngine *RenderingEngine `locationName:"renderingEngine" type:"structure"` +// SetInteriorCountPerFloorplan sets the InteriorCountPerFloorplan field's value. +func (s *WorldCount) SetInteriorCountPerFloorplan(v int64) *WorldCount { + s.InteriorCountPerFloorplan = &v + return s +} - // The revision id of the simulation application. - RevisionId *string `locationName:"revisionId" min:"1" type:"string"` +// Information about a world export job. +type WorldExportJobSummary struct { + _ struct{} `type:"structure"` - // Information about the robot software suite (ROS distribution). - RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` + // The Amazon Resource Name (ARN) of the world export job. + Arn *string `locationName:"arn" min:"1" type:"string"` - // The simulation software suite used by the simulation application. - SimulationSoftwareSuite *SimulationSoftwareSuite `locationName:"simulationSoftwareSuite" type:"structure"` + // The time, in milliseconds since the epoch, when the world export job was + // created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The sources of the simulation application. - Sources []*Source `locationName:"sources" type:"list"` + // The status of the world export job. + // + // Pending + // + // The world export job request is pending. + // + // Running + // + // The world export job is running. + // + // Completed + // + // The world export job completed. + // + // Failed + // + // The world export job failed. See failureCode for more information. + // + // Canceled + // + // The world export job was cancelled. + // + // Canceling + // + // The world export job is being cancelled. + Status *string `locationName:"status" type:"string" enum:"WorldExportJobStatus"` - // The version of the robot application. - Version *string `locationName:"version" min:"1" type:"string"` + // A list of worlds. + Worlds []*string `locationName:"worlds" min:"1" type:"list"` } // String returns the string representation -func (s UpdateSimulationApplicationOutput) String() string { +func (s WorldExportJobSummary) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s UpdateSimulationApplicationOutput) GoString() string { +func (s WorldExportJobSummary) GoString() string { return s.String() } // SetArn sets the Arn field's value. -func (s *UpdateSimulationApplicationOutput) SetArn(v string) *UpdateSimulationApplicationOutput { +func (s *WorldExportJobSummary) SetArn(v string) *WorldExportJobSummary { s.Arn = &v return s } -// SetLastUpdatedAt sets the LastUpdatedAt field's value. -func (s *UpdateSimulationApplicationOutput) SetLastUpdatedAt(v time.Time) *UpdateSimulationApplicationOutput { - s.LastUpdatedAt = &v +// SetCreatedAt sets the CreatedAt field's value. +func (s *WorldExportJobSummary) SetCreatedAt(v time.Time) *WorldExportJobSummary { + s.CreatedAt = &v return s } -// SetName sets the Name field's value. -func (s *UpdateSimulationApplicationOutput) SetName(v string) *UpdateSimulationApplicationOutput { - s.Name = &v +// SetStatus sets the Status field's value. +func (s *WorldExportJobSummary) SetStatus(v string) *WorldExportJobSummary { + s.Status = &v return s } -// SetRenderingEngine sets the RenderingEngine field's value. -func (s *UpdateSimulationApplicationOutput) SetRenderingEngine(v *RenderingEngine) *UpdateSimulationApplicationOutput { - s.RenderingEngine = v +// SetWorlds sets the Worlds field's value. +func (s *WorldExportJobSummary) SetWorlds(v []*string) *WorldExportJobSummary { + s.Worlds = v return s } -// SetRevisionId sets the RevisionId field's value. -func (s *UpdateSimulationApplicationOutput) SetRevisionId(v string) *UpdateSimulationApplicationOutput { - s.RevisionId = &v - return s +// Information about a failed world. +type WorldFailure struct { + _ struct{} `type:"structure"` + + // The failure code of the world export job if it failed: + // + // InternalServiceError + // + // Internal service error. + // + // LimitExceeded + // + // The requested resource exceeds the maximum number allowed, or the number + // of concurrent stream requests exceeds the maximum number allowed. + // + // ResourceNotFound + // + // The specified resource could not be found. + // + // RequestThrottled + // + // The request was throttled. + // + // InvalidInput + // + // An input parameter in the request is not valid. + FailureCode *string `locationName:"failureCode" type:"string" enum:"WorldGenerationJobErrorCode"` + + // The number of failed worlds. + FailureCount *int64 `locationName:"failureCount" type:"integer"` + + // The sample reason why the world failed. World errors are aggregated. A sample + // is used as the sampleFailureReason. + SampleFailureReason *string `locationName:"sampleFailureReason" type:"string"` } -// SetRobotSoftwareSuite sets the RobotSoftwareSuite field's value. -func (s *UpdateSimulationApplicationOutput) SetRobotSoftwareSuite(v *RobotSoftwareSuite) *UpdateSimulationApplicationOutput { - s.RobotSoftwareSuite = v - return s +// String returns the string representation +func (s WorldFailure) String() string { + return awsutil.Prettify(s) } -// SetSimulationSoftwareSuite sets the SimulationSoftwareSuite field's value. -func (s *UpdateSimulationApplicationOutput) SetSimulationSoftwareSuite(v *SimulationSoftwareSuite) *UpdateSimulationApplicationOutput { - s.SimulationSoftwareSuite = v +// GoString returns the string representation +func (s WorldFailure) GoString() string { + return s.String() +} + +// SetFailureCode sets the FailureCode field's value. +func (s *WorldFailure) SetFailureCode(v string) *WorldFailure { + s.FailureCode = &v return s } -// SetSources sets the Sources field's value. -func (s *UpdateSimulationApplicationOutput) SetSources(v []*Source) *UpdateSimulationApplicationOutput { - s.Sources = v +// SetFailureCount sets the FailureCount field's value. +func (s *WorldFailure) SetFailureCount(v int64) *WorldFailure { + s.FailureCount = &v return s } -// SetVersion sets the Version field's value. -func (s *UpdateSimulationApplicationOutput) SetVersion(v string) *UpdateSimulationApplicationOutput { - s.Version = &v +// SetSampleFailureReason sets the SampleFailureReason field's value. +func (s *WorldFailure) SetSampleFailureReason(v string) *WorldFailure { + s.SampleFailureReason = &v return s } -// If your simulation job accesses resources in a VPC, you provide this parameter -// identifying the list of security group IDs and subnet IDs. These must belong -// to the same VPC. You must provide at least one security group and two subnet -// IDs. -type VPCConfig struct { +// Information about a world generator job. +type WorldGenerationJobSummary struct { _ struct{} `type:"structure"` - // A boolean indicating whether to assign a public IP address. - AssignPublicIp *bool `locationName:"assignPublicIp" type:"boolean"` + // The Amazon Resource Name (ARN) of the world generator job. + Arn *string `locationName:"arn" min:"1" type:"string"` - // A list of one or more security groups IDs in your VPC. - SecurityGroups []*string `locationName:"securityGroups" min:"1" type:"list"` + // The time, in milliseconds since the epoch, when the world generator job was + // created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // A list of one or more subnet IDs in your VPC. + // The number of worlds that failed. + FailedWorldCount *int64 `locationName:"failedWorldCount" type:"integer"` + + // The status of the world generator job: // - // Subnets is a required field - Subnets []*string `locationName:"subnets" min:"1" type:"list" required:"true"` + // Pending + // + // The world generator job request is pending. + // + // Running + // + // The world generator job is running. + // + // Completed + // + // The world generator job completed. + // + // Failed + // + // The world generator job failed. See failureCode for more information. + // + // PartialFailed + // + // Some worlds did not generate. + // + // Canceled + // + // The world generator job was cancelled. + // + // Canceling + // + // The world generator job is being cancelled. + Status *string `locationName:"status" type:"string" enum:"WorldGenerationJobStatus"` + + // The number of worlds that were generated. + SucceededWorldCount *int64 `locationName:"succeededWorldCount" type:"integer"` + + // The Amazon Resource Name (arn) of the world template. + Template *string `locationName:"template" min:"1" type:"string"` + + // Information about the world count. + WorldCount *WorldCount `locationName:"worldCount" type:"structure"` } // String returns the string representation -func (s VPCConfig) String() string { +func (s WorldGenerationJobSummary) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s VPCConfig) GoString() string { +func (s WorldGenerationJobSummary) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *VPCConfig) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "VPCConfig"} - if s.SecurityGroups != nil && len(s.SecurityGroups) < 1 { - invalidParams.Add(request.NewErrParamMinLen("SecurityGroups", 1)) - } - if s.Subnets == nil { - invalidParams.Add(request.NewErrParamRequired("Subnets")) - } - if s.Subnets != nil && len(s.Subnets) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Subnets", 1)) - } +// SetArn sets the Arn field's value. +func (s *WorldGenerationJobSummary) SetArn(v string) *WorldGenerationJobSummary { + s.Arn = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetCreatedAt sets the CreatedAt field's value. +func (s *WorldGenerationJobSummary) SetCreatedAt(v time.Time) *WorldGenerationJobSummary { + s.CreatedAt = &v + return s } -// SetAssignPublicIp sets the AssignPublicIp field's value. -func (s *VPCConfig) SetAssignPublicIp(v bool) *VPCConfig { - s.AssignPublicIp = &v +// SetFailedWorldCount sets the FailedWorldCount field's value. +func (s *WorldGenerationJobSummary) SetFailedWorldCount(v int64) *WorldGenerationJobSummary { + s.FailedWorldCount = &v return s } -// SetSecurityGroups sets the SecurityGroups field's value. -func (s *VPCConfig) SetSecurityGroups(v []*string) *VPCConfig { - s.SecurityGroups = v +// SetStatus sets the Status field's value. +func (s *WorldGenerationJobSummary) SetStatus(v string) *WorldGenerationJobSummary { + s.Status = &v return s } -// SetSubnets sets the Subnets field's value. -func (s *VPCConfig) SetSubnets(v []*string) *VPCConfig { - s.Subnets = v +// SetSucceededWorldCount sets the SucceededWorldCount field's value. +func (s *WorldGenerationJobSummary) SetSucceededWorldCount(v int64) *WorldGenerationJobSummary { + s.SucceededWorldCount = &v return s } -// VPC configuration associated with your simulation job. -type VPCConfigResponse struct { +// SetTemplate sets the Template field's value. +func (s *WorldGenerationJobSummary) SetTemplate(v string) *WorldGenerationJobSummary { + s.Template = &v + return s +} + +// SetWorldCount sets the WorldCount field's value. +func (s *WorldGenerationJobSummary) SetWorldCount(v *WorldCount) *WorldGenerationJobSummary { + s.WorldCount = v + return s +} + +// Information about a world. +type WorldSummary struct { _ struct{} `type:"structure"` - // A boolean indicating if a public IP was assigned. - AssignPublicIp *bool `locationName:"assignPublicIp" type:"boolean"` + // The Amazon Resource Name (ARN) of the world. + Arn *string `locationName:"arn" min:"1" type:"string"` - // A list of security group IDs associated with the simulation job. - SecurityGroups []*string `locationName:"securityGroups" min:"1" type:"list"` + // The time, in milliseconds since the epoch, when the world was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // A list of subnet IDs associated with the simulation job. - Subnets []*string `locationName:"subnets" min:"1" type:"list"` + // The Amazon Resource Name (arn) of the world generation job. + GenerationJob *string `locationName:"generationJob" min:"1" type:"string"` - // The VPC ID associated with your simulation job. - VpcId *string `locationName:"vpcId" type:"string"` + // The Amazon Resource Name (arn) of the world template. + Template *string `locationName:"template" min:"1" type:"string"` } // String returns the string representation -func (s VPCConfigResponse) String() string { +func (s WorldSummary) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s VPCConfigResponse) GoString() string { +func (s WorldSummary) GoString() string { return s.String() } -// SetAssignPublicIp sets the AssignPublicIp field's value. -func (s *VPCConfigResponse) SetAssignPublicIp(v bool) *VPCConfigResponse { - s.AssignPublicIp = &v +// SetArn sets the Arn field's value. +func (s *WorldSummary) SetArn(v string) *WorldSummary { + s.Arn = &v return s } -// SetSecurityGroups sets the SecurityGroups field's value. -func (s *VPCConfigResponse) SetSecurityGroups(v []*string) *VPCConfigResponse { - s.SecurityGroups = v +// SetCreatedAt sets the CreatedAt field's value. +func (s *WorldSummary) SetCreatedAt(v time.Time) *WorldSummary { + s.CreatedAt = &v return s } -// SetSubnets sets the Subnets field's value. -func (s *VPCConfigResponse) SetSubnets(v []*string) *VPCConfigResponse { - s.Subnets = v +// SetGenerationJob sets the GenerationJob field's value. +func (s *WorldSummary) SetGenerationJob(v string) *WorldSummary { + s.GenerationJob = &v return s } -// SetVpcId sets the VpcId field's value. -func (s *VPCConfigResponse) SetVpcId(v string) *VPCConfigResponse { - s.VpcId = &v +// SetTemplate sets the Template field's value. +func (s *WorldSummary) SetTemplate(v string) *WorldSummary { + s.Template = &v return s } @@ -13288,3 +17713,135 @@ func SimulationSoftwareSuiteType_Values() []string { SimulationSoftwareSuiteTypeRosbagPlay, } } + +const ( + // WorldExportJobErrorCodeInternalServiceError is a WorldExportJobErrorCode enum value + WorldExportJobErrorCodeInternalServiceError = "InternalServiceError" + + // WorldExportJobErrorCodeLimitExceeded is a WorldExportJobErrorCode enum value + WorldExportJobErrorCodeLimitExceeded = "LimitExceeded" + + // WorldExportJobErrorCodeResourceNotFound is a WorldExportJobErrorCode enum value + WorldExportJobErrorCodeResourceNotFound = "ResourceNotFound" + + // WorldExportJobErrorCodeRequestThrottled is a WorldExportJobErrorCode enum value + WorldExportJobErrorCodeRequestThrottled = "RequestThrottled" + + // WorldExportJobErrorCodeInvalidInput is a WorldExportJobErrorCode enum value + WorldExportJobErrorCodeInvalidInput = "InvalidInput" + + // WorldExportJobErrorCodeAccessDenied is a WorldExportJobErrorCode enum value + WorldExportJobErrorCodeAccessDenied = "AccessDenied" +) + +// WorldExportJobErrorCode_Values returns all elements of the WorldExportJobErrorCode enum +func WorldExportJobErrorCode_Values() []string { + return []string{ + WorldExportJobErrorCodeInternalServiceError, + WorldExportJobErrorCodeLimitExceeded, + WorldExportJobErrorCodeResourceNotFound, + WorldExportJobErrorCodeRequestThrottled, + WorldExportJobErrorCodeInvalidInput, + WorldExportJobErrorCodeAccessDenied, + } +} + +const ( + // WorldExportJobStatusPending is a WorldExportJobStatus enum value + WorldExportJobStatusPending = "Pending" + + // WorldExportJobStatusRunning is a WorldExportJobStatus enum value + WorldExportJobStatusRunning = "Running" + + // WorldExportJobStatusCompleted is a WorldExportJobStatus enum value + WorldExportJobStatusCompleted = "Completed" + + // WorldExportJobStatusFailed is a WorldExportJobStatus enum value + WorldExportJobStatusFailed = "Failed" + + // WorldExportJobStatusCanceling is a WorldExportJobStatus enum value + WorldExportJobStatusCanceling = "Canceling" + + // WorldExportJobStatusCanceled is a WorldExportJobStatus enum value + WorldExportJobStatusCanceled = "Canceled" +) + +// WorldExportJobStatus_Values returns all elements of the WorldExportJobStatus enum +func WorldExportJobStatus_Values() []string { + return []string{ + WorldExportJobStatusPending, + WorldExportJobStatusRunning, + WorldExportJobStatusCompleted, + WorldExportJobStatusFailed, + WorldExportJobStatusCanceling, + WorldExportJobStatusCanceled, + } +} + +const ( + // WorldGenerationJobErrorCodeInternalServiceError is a WorldGenerationJobErrorCode enum value + WorldGenerationJobErrorCodeInternalServiceError = "InternalServiceError" + + // WorldGenerationJobErrorCodeLimitExceeded is a WorldGenerationJobErrorCode enum value + WorldGenerationJobErrorCodeLimitExceeded = "LimitExceeded" + + // WorldGenerationJobErrorCodeResourceNotFound is a WorldGenerationJobErrorCode enum value + WorldGenerationJobErrorCodeResourceNotFound = "ResourceNotFound" + + // WorldGenerationJobErrorCodeRequestThrottled is a WorldGenerationJobErrorCode enum value + WorldGenerationJobErrorCodeRequestThrottled = "RequestThrottled" + + // WorldGenerationJobErrorCodeInvalidInput is a WorldGenerationJobErrorCode enum value + WorldGenerationJobErrorCodeInvalidInput = "InvalidInput" + + // WorldGenerationJobErrorCodeAllWorldGenerationFailed is a WorldGenerationJobErrorCode enum value + WorldGenerationJobErrorCodeAllWorldGenerationFailed = "AllWorldGenerationFailed" +) + +// WorldGenerationJobErrorCode_Values returns all elements of the WorldGenerationJobErrorCode enum +func WorldGenerationJobErrorCode_Values() []string { + return []string{ + WorldGenerationJobErrorCodeInternalServiceError, + WorldGenerationJobErrorCodeLimitExceeded, + WorldGenerationJobErrorCodeResourceNotFound, + WorldGenerationJobErrorCodeRequestThrottled, + WorldGenerationJobErrorCodeInvalidInput, + WorldGenerationJobErrorCodeAllWorldGenerationFailed, + } +} + +const ( + // WorldGenerationJobStatusPending is a WorldGenerationJobStatus enum value + WorldGenerationJobStatusPending = "Pending" + + // WorldGenerationJobStatusRunning is a WorldGenerationJobStatus enum value + WorldGenerationJobStatusRunning = "Running" + + // WorldGenerationJobStatusCompleted is a WorldGenerationJobStatus enum value + WorldGenerationJobStatusCompleted = "Completed" + + // WorldGenerationJobStatusFailed is a WorldGenerationJobStatus enum value + WorldGenerationJobStatusFailed = "Failed" + + // WorldGenerationJobStatusPartialFailed is a WorldGenerationJobStatus enum value + WorldGenerationJobStatusPartialFailed = "PartialFailed" + + // WorldGenerationJobStatusCanceling is a WorldGenerationJobStatus enum value + WorldGenerationJobStatusCanceling = "Canceling" + + // WorldGenerationJobStatusCanceled is a WorldGenerationJobStatus enum value + WorldGenerationJobStatusCanceled = "Canceled" +) + +// WorldGenerationJobStatus_Values returns all elements of the WorldGenerationJobStatus enum +func WorldGenerationJobStatus_Values() []string { + return []string{ + WorldGenerationJobStatusPending, + WorldGenerationJobStatusRunning, + WorldGenerationJobStatusCompleted, + WorldGenerationJobStatusFailed, + WorldGenerationJobStatusPartialFailed, + WorldGenerationJobStatusCanceling, + WorldGenerationJobStatusCanceled, + } +} diff --git a/service/robomaker/robomakeriface/interface.go b/service/robomaker/robomakeriface/interface.go index 7677056150..efe386701c 100644 --- a/service/robomaker/robomakeriface/interface.go +++ b/service/robomaker/robomakeriface/interface.go @@ -26,7 +26,7 @@ import ( // // myFunc uses an SDK service client to make a request to // // AWS RoboMaker. // func myFunc(svc robomakeriface.RoboMakerAPI) bool { -// // Make svc.BatchDescribeSimulationJob request +// // Make svc.BatchDeleteWorlds request // } // // func main() { @@ -42,7 +42,7 @@ import ( // type mockRoboMakerClient struct { // robomakeriface.RoboMakerAPI // } -// func (m *mockRoboMakerClient) BatchDescribeSimulationJob(input *robomaker.BatchDescribeSimulationJobInput) (*robomaker.BatchDescribeSimulationJobOutput, error) { +// func (m *mockRoboMakerClient) BatchDeleteWorlds(input *robomaker.BatchDeleteWorldsInput) (*robomaker.BatchDeleteWorldsOutput, error) { // // mock response/functionality // } // @@ -60,6 +60,10 @@ import ( // and waiters. Its suggested to use the pattern above for testing, or using // tooling to generate mocks to satisfy the interfaces. type RoboMakerAPI interface { + BatchDeleteWorlds(*robomaker.BatchDeleteWorldsInput) (*robomaker.BatchDeleteWorldsOutput, error) + BatchDeleteWorldsWithContext(aws.Context, *robomaker.BatchDeleteWorldsInput, ...request.Option) (*robomaker.BatchDeleteWorldsOutput, error) + BatchDeleteWorldsRequest(*robomaker.BatchDeleteWorldsInput) (*request.Request, *robomaker.BatchDeleteWorldsOutput) + BatchDescribeSimulationJob(*robomaker.BatchDescribeSimulationJobInput) (*robomaker.BatchDescribeSimulationJobOutput, error) BatchDescribeSimulationJobWithContext(aws.Context, *robomaker.BatchDescribeSimulationJobInput, ...request.Option) (*robomaker.BatchDescribeSimulationJobOutput, error) BatchDescribeSimulationJobRequest(*robomaker.BatchDescribeSimulationJobInput) (*request.Request, *robomaker.BatchDescribeSimulationJobOutput) @@ -76,6 +80,14 @@ type RoboMakerAPI interface { CancelSimulationJobBatchWithContext(aws.Context, *robomaker.CancelSimulationJobBatchInput, ...request.Option) (*robomaker.CancelSimulationJobBatchOutput, error) CancelSimulationJobBatchRequest(*robomaker.CancelSimulationJobBatchInput) (*request.Request, *robomaker.CancelSimulationJobBatchOutput) + CancelWorldExportJob(*robomaker.CancelWorldExportJobInput) (*robomaker.CancelWorldExportJobOutput, error) + CancelWorldExportJobWithContext(aws.Context, *robomaker.CancelWorldExportJobInput, ...request.Option) (*robomaker.CancelWorldExportJobOutput, error) + CancelWorldExportJobRequest(*robomaker.CancelWorldExportJobInput) (*request.Request, *robomaker.CancelWorldExportJobOutput) + + CancelWorldGenerationJob(*robomaker.CancelWorldGenerationJobInput) (*robomaker.CancelWorldGenerationJobOutput, error) + CancelWorldGenerationJobWithContext(aws.Context, *robomaker.CancelWorldGenerationJobInput, ...request.Option) (*robomaker.CancelWorldGenerationJobOutput, error) + CancelWorldGenerationJobRequest(*robomaker.CancelWorldGenerationJobInput) (*request.Request, *robomaker.CancelWorldGenerationJobOutput) + CreateDeploymentJob(*robomaker.CreateDeploymentJobInput) (*robomaker.CreateDeploymentJobOutput, error) CreateDeploymentJobWithContext(aws.Context, *robomaker.CreateDeploymentJobInput, ...request.Option) (*robomaker.CreateDeploymentJobOutput, error) CreateDeploymentJobRequest(*robomaker.CreateDeploymentJobInput) (*request.Request, *robomaker.CreateDeploymentJobOutput) @@ -108,6 +120,18 @@ type RoboMakerAPI interface { CreateSimulationJobWithContext(aws.Context, *robomaker.CreateSimulationJobInput, ...request.Option) (*robomaker.CreateSimulationJobOutput, error) CreateSimulationJobRequest(*robomaker.CreateSimulationJobInput) (*request.Request, *robomaker.CreateSimulationJobOutput) + CreateWorldExportJob(*robomaker.CreateWorldExportJobInput) (*robomaker.CreateWorldExportJobOutput, error) + CreateWorldExportJobWithContext(aws.Context, *robomaker.CreateWorldExportJobInput, ...request.Option) (*robomaker.CreateWorldExportJobOutput, error) + CreateWorldExportJobRequest(*robomaker.CreateWorldExportJobInput) (*request.Request, *robomaker.CreateWorldExportJobOutput) + + CreateWorldGenerationJob(*robomaker.CreateWorldGenerationJobInput) (*robomaker.CreateWorldGenerationJobOutput, error) + CreateWorldGenerationJobWithContext(aws.Context, *robomaker.CreateWorldGenerationJobInput, ...request.Option) (*robomaker.CreateWorldGenerationJobOutput, error) + CreateWorldGenerationJobRequest(*robomaker.CreateWorldGenerationJobInput) (*request.Request, *robomaker.CreateWorldGenerationJobOutput) + + CreateWorldTemplate(*robomaker.CreateWorldTemplateInput) (*robomaker.CreateWorldTemplateOutput, error) + CreateWorldTemplateWithContext(aws.Context, *robomaker.CreateWorldTemplateInput, ...request.Option) (*robomaker.CreateWorldTemplateOutput, error) + CreateWorldTemplateRequest(*robomaker.CreateWorldTemplateInput) (*request.Request, *robomaker.CreateWorldTemplateOutput) + DeleteFleet(*robomaker.DeleteFleetInput) (*robomaker.DeleteFleetOutput, error) DeleteFleetWithContext(aws.Context, *robomaker.DeleteFleetInput, ...request.Option) (*robomaker.DeleteFleetOutput, error) DeleteFleetRequest(*robomaker.DeleteFleetInput) (*request.Request, *robomaker.DeleteFleetOutput) @@ -124,6 +148,10 @@ type RoboMakerAPI interface { DeleteSimulationApplicationWithContext(aws.Context, *robomaker.DeleteSimulationApplicationInput, ...request.Option) (*robomaker.DeleteSimulationApplicationOutput, error) DeleteSimulationApplicationRequest(*robomaker.DeleteSimulationApplicationInput) (*request.Request, *robomaker.DeleteSimulationApplicationOutput) + DeleteWorldTemplate(*robomaker.DeleteWorldTemplateInput) (*robomaker.DeleteWorldTemplateOutput, error) + DeleteWorldTemplateWithContext(aws.Context, *robomaker.DeleteWorldTemplateInput, ...request.Option) (*robomaker.DeleteWorldTemplateOutput, error) + DeleteWorldTemplateRequest(*robomaker.DeleteWorldTemplateInput) (*request.Request, *robomaker.DeleteWorldTemplateOutput) + DeregisterRobot(*robomaker.DeregisterRobotInput) (*robomaker.DeregisterRobotOutput, error) DeregisterRobotWithContext(aws.Context, *robomaker.DeregisterRobotInput, ...request.Option) (*robomaker.DeregisterRobotOutput, error) DeregisterRobotRequest(*robomaker.DeregisterRobotInput) (*request.Request, *robomaker.DeregisterRobotOutput) @@ -156,6 +184,26 @@ type RoboMakerAPI interface { DescribeSimulationJobBatchWithContext(aws.Context, *robomaker.DescribeSimulationJobBatchInput, ...request.Option) (*robomaker.DescribeSimulationJobBatchOutput, error) DescribeSimulationJobBatchRequest(*robomaker.DescribeSimulationJobBatchInput) (*request.Request, *robomaker.DescribeSimulationJobBatchOutput) + DescribeWorld(*robomaker.DescribeWorldInput) (*robomaker.DescribeWorldOutput, error) + DescribeWorldWithContext(aws.Context, *robomaker.DescribeWorldInput, ...request.Option) (*robomaker.DescribeWorldOutput, error) + DescribeWorldRequest(*robomaker.DescribeWorldInput) (*request.Request, *robomaker.DescribeWorldOutput) + + DescribeWorldExportJob(*robomaker.DescribeWorldExportJobInput) (*robomaker.DescribeWorldExportJobOutput, error) + DescribeWorldExportJobWithContext(aws.Context, *robomaker.DescribeWorldExportJobInput, ...request.Option) (*robomaker.DescribeWorldExportJobOutput, error) + DescribeWorldExportJobRequest(*robomaker.DescribeWorldExportJobInput) (*request.Request, *robomaker.DescribeWorldExportJobOutput) + + DescribeWorldGenerationJob(*robomaker.DescribeWorldGenerationJobInput) (*robomaker.DescribeWorldGenerationJobOutput, error) + DescribeWorldGenerationJobWithContext(aws.Context, *robomaker.DescribeWorldGenerationJobInput, ...request.Option) (*robomaker.DescribeWorldGenerationJobOutput, error) + DescribeWorldGenerationJobRequest(*robomaker.DescribeWorldGenerationJobInput) (*request.Request, *robomaker.DescribeWorldGenerationJobOutput) + + DescribeWorldTemplate(*robomaker.DescribeWorldTemplateInput) (*robomaker.DescribeWorldTemplateOutput, error) + DescribeWorldTemplateWithContext(aws.Context, *robomaker.DescribeWorldTemplateInput, ...request.Option) (*robomaker.DescribeWorldTemplateOutput, error) + DescribeWorldTemplateRequest(*robomaker.DescribeWorldTemplateInput) (*request.Request, *robomaker.DescribeWorldTemplateOutput) + + GetWorldTemplateBody(*robomaker.GetWorldTemplateBodyInput) (*robomaker.GetWorldTemplateBodyOutput, error) + GetWorldTemplateBodyWithContext(aws.Context, *robomaker.GetWorldTemplateBodyInput, ...request.Option) (*robomaker.GetWorldTemplateBodyOutput, error) + GetWorldTemplateBodyRequest(*robomaker.GetWorldTemplateBodyInput) (*request.Request, *robomaker.GetWorldTemplateBodyOutput) + ListDeploymentJobs(*robomaker.ListDeploymentJobsInput) (*robomaker.ListDeploymentJobsOutput, error) ListDeploymentJobsWithContext(aws.Context, *robomaker.ListDeploymentJobsInput, ...request.Option) (*robomaker.ListDeploymentJobsOutput, error) ListDeploymentJobsRequest(*robomaker.ListDeploymentJobsInput) (*request.Request, *robomaker.ListDeploymentJobsOutput) @@ -209,6 +257,34 @@ type RoboMakerAPI interface { ListTagsForResourceWithContext(aws.Context, *robomaker.ListTagsForResourceInput, ...request.Option) (*robomaker.ListTagsForResourceOutput, error) ListTagsForResourceRequest(*robomaker.ListTagsForResourceInput) (*request.Request, *robomaker.ListTagsForResourceOutput) + ListWorldExportJobs(*robomaker.ListWorldExportJobsInput) (*robomaker.ListWorldExportJobsOutput, error) + ListWorldExportJobsWithContext(aws.Context, *robomaker.ListWorldExportJobsInput, ...request.Option) (*robomaker.ListWorldExportJobsOutput, error) + ListWorldExportJobsRequest(*robomaker.ListWorldExportJobsInput) (*request.Request, *robomaker.ListWorldExportJobsOutput) + + ListWorldExportJobsPages(*robomaker.ListWorldExportJobsInput, func(*robomaker.ListWorldExportJobsOutput, bool) bool) error + ListWorldExportJobsPagesWithContext(aws.Context, *robomaker.ListWorldExportJobsInput, func(*robomaker.ListWorldExportJobsOutput, bool) bool, ...request.Option) error + + ListWorldGenerationJobs(*robomaker.ListWorldGenerationJobsInput) (*robomaker.ListWorldGenerationJobsOutput, error) + ListWorldGenerationJobsWithContext(aws.Context, *robomaker.ListWorldGenerationJobsInput, ...request.Option) (*robomaker.ListWorldGenerationJobsOutput, error) + ListWorldGenerationJobsRequest(*robomaker.ListWorldGenerationJobsInput) (*request.Request, *robomaker.ListWorldGenerationJobsOutput) + + ListWorldGenerationJobsPages(*robomaker.ListWorldGenerationJobsInput, func(*robomaker.ListWorldGenerationJobsOutput, bool) bool) error + ListWorldGenerationJobsPagesWithContext(aws.Context, *robomaker.ListWorldGenerationJobsInput, func(*robomaker.ListWorldGenerationJobsOutput, bool) bool, ...request.Option) error + + ListWorldTemplates(*robomaker.ListWorldTemplatesInput) (*robomaker.ListWorldTemplatesOutput, error) + ListWorldTemplatesWithContext(aws.Context, *robomaker.ListWorldTemplatesInput, ...request.Option) (*robomaker.ListWorldTemplatesOutput, error) + ListWorldTemplatesRequest(*robomaker.ListWorldTemplatesInput) (*request.Request, *robomaker.ListWorldTemplatesOutput) + + ListWorldTemplatesPages(*robomaker.ListWorldTemplatesInput, func(*robomaker.ListWorldTemplatesOutput, bool) bool) error + ListWorldTemplatesPagesWithContext(aws.Context, *robomaker.ListWorldTemplatesInput, func(*robomaker.ListWorldTemplatesOutput, bool) bool, ...request.Option) error + + ListWorlds(*robomaker.ListWorldsInput) (*robomaker.ListWorldsOutput, error) + ListWorldsWithContext(aws.Context, *robomaker.ListWorldsInput, ...request.Option) (*robomaker.ListWorldsOutput, error) + ListWorldsRequest(*robomaker.ListWorldsInput) (*request.Request, *robomaker.ListWorldsOutput) + + ListWorldsPages(*robomaker.ListWorldsInput, func(*robomaker.ListWorldsOutput, bool) bool) error + ListWorldsPagesWithContext(aws.Context, *robomaker.ListWorldsInput, func(*robomaker.ListWorldsOutput, bool) bool, ...request.Option) error + RegisterRobot(*robomaker.RegisterRobotInput) (*robomaker.RegisterRobotOutput, error) RegisterRobotWithContext(aws.Context, *robomaker.RegisterRobotInput, ...request.Option) (*robomaker.RegisterRobotOutput, error) RegisterRobotRequest(*robomaker.RegisterRobotInput) (*request.Request, *robomaker.RegisterRobotOutput) @@ -240,6 +316,10 @@ type RoboMakerAPI interface { UpdateSimulationApplication(*robomaker.UpdateSimulationApplicationInput) (*robomaker.UpdateSimulationApplicationOutput, error) UpdateSimulationApplicationWithContext(aws.Context, *robomaker.UpdateSimulationApplicationInput, ...request.Option) (*robomaker.UpdateSimulationApplicationOutput, error) UpdateSimulationApplicationRequest(*robomaker.UpdateSimulationApplicationInput) (*request.Request, *robomaker.UpdateSimulationApplicationOutput) + + UpdateWorldTemplate(*robomaker.UpdateWorldTemplateInput) (*robomaker.UpdateWorldTemplateOutput, error) + UpdateWorldTemplateWithContext(aws.Context, *robomaker.UpdateWorldTemplateInput, ...request.Option) (*robomaker.UpdateWorldTemplateOutput, error) + UpdateWorldTemplateRequest(*robomaker.UpdateWorldTemplateInput) (*request.Request, *robomaker.UpdateWorldTemplateOutput) } var _ RoboMakerAPI = (*robomaker.RoboMaker)(nil)