If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.
manualCreation is only available for GitHub webhooks.
If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.
manualCreation is only available for GitHub webhooks.
The type of webhook filter. There are nine webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH, COMMIT_MESSAGE, TAG_NAME, RELEASE_NAME, and WORKFLOW_NAME.
EVENT
A webhook event triggers a build when the provided pattern matches one of nine event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_CLOSED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED, RELEASED, PRERELEASED, and WORKFLOW_JOB_QUEUED. The EVENT patterns are specified as a comma-separated string. For example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull request created, and pull request updated events.
The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only. The RELEASED, PRERELEASED, and WORKFLOW_JOB_QUEUED work with GitHub only.
ACTOR_ACCOUNT_ID
A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression pattern.
HEAD_REF
A webhook event triggers a build when the head reference matches the regular expression pattern. For example, refs/heads/branch-name and refs/tags/tag-name.
Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
BASE_REF
A webhook event triggers a build when the base reference matches the regular expression pattern. For example, refs/heads/branch-name.
Works with pull request events only.
FILE_PATH
A webhook triggers a build when the path of a changed file matches the regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.
COMMIT_MESSAGE
A webhook triggers a build when the head commit message matches the regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.
TAG_NAME
A webhook triggers a build when the tag name of the release matches the regular expression pattern.
Works with RELEASED and PRERELEASED events only.
RELEASE_NAME
A webhook triggers a build when the release name matches the regular expression pattern.
Works with RELEASED and PRERELEASED events only.
WORKFLOW_NAME
A webhook triggers a build when the workflow name matches the regular expression pattern.
Works with WORKFLOW_JOB_QUEUED events only.
The type of webhook filter. There are nine webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH, COMMIT_MESSAGE, TAG_NAME, RELEASE_NAME, and WORKFLOW_NAME.
EVENT
A webhook event triggers a build when the provided pattern matches one of nine event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_CLOSED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED, RELEASED, PRERELEASED, and WORKFLOW_JOB_QUEUED. The EVENT patterns are specified as a comma-separated string. For example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull request created, and pull request updated events.
Types PULL_REQUEST_REOPENED and WORKFLOW_JOB_QUEUED work with GitHub and GitHub Enterprise only. Types RELEASED and PRERELEASED work with GitHub only.
ACTOR_ACCOUNT_ID
A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression pattern.
HEAD_REF
A webhook event triggers a build when the head reference matches the regular expression pattern. For example, refs/heads/branch-name and refs/tags/tag-name.
Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
BASE_REF
A webhook event triggers a build when the base reference matches the regular expression pattern. For example, refs/heads/branch-name.
Works with pull request events only.
FILE_PATH
A webhook triggers a build when the path of a changed file matches the regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.
COMMIT_MESSAGE
A webhook triggers a build when the head commit message matches the regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.
TAG_NAME
A webhook triggers a build when the tag name of the release matches the regular expression pattern.
Works with RELEASED and PRERELEASED events only.
RELEASE_NAME
A webhook triggers a build when the release name matches the regular expression pattern.
Works with RELEASED and PRERELEASED events only.
WORKFLOW_NAME
A webhook triggers a build when the workflow name matches the regular expression pattern.
Works with WORKFLOW_JOB_QUEUED events only.
Returns a list of all requested findings.
" + "documentation":"Returns a list of requested findings from standard scans.
" }, "CreateScan":{ "name":"CreateScan", @@ -46,7 +47,7 @@ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Use to create a scan using code uploaded to an S3 bucket.
" + "documentation":"Use to create a scan using code uploaded to an Amazon S3 bucket.
" }, "CreateUploadUrl":{ "name":"CreateUploadUrl", @@ -63,7 +64,7 @@ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Generates a pre-signed URL and request headers used to upload a code resource.
You can upload your code resource to the URL and add the request headers using any HTTP client.
" + "documentation":"Generates a pre-signed URL, request headers used to upload a code resource, and code artifact identifier for the uploaded resource.
You can upload your code resource to the URL with the request headers using any HTTP client.
" }, "GetAccountConfiguration":{ "name":"GetAccountConfiguration", @@ -80,7 +81,7 @@ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Use to get account level configuration.
" + "documentation":"Use to get the encryption configuration for an account.
" }, "GetFindings":{ "name":"GetFindings", @@ -116,7 +117,7 @@ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Returns top level metrics about an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings.
" + "documentation":"Returns a summary of metrics for an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings.
" }, "GetScan":{ "name":"GetScan", @@ -131,6 +132,7 @@ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"Returns details about a scan, including whether or not a scan has completed.
" @@ -167,7 +169,7 @@ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], - "documentation":"Returns a list of all the standard scans in an account. Does not return express scans.
" + "documentation":"Returns a list of all scans in an account. Does not return EXPRESS scans.
Use to update account-level configuration with an encryption key.
" + "documentation":"Use to update the encryption configuration for an account.
" } }, "shapes":{ @@ -283,26 +285,26 @@ "members":{ "closedFindings":{ "shape":"FindingMetricsValuePerSeverity", - "documentation":"The number of closed findings of each severity in an account on the specified date.
" + "documentation":"The number of closed findings of each severity on the specified date.
" }, "date":{ "shape":"Timestamp", - "documentation":"The date from which the finding metrics were retrieved.
" + "documentation":"The date from which the findings metrics were retrieved.
" }, "meanTimeToClose":{ "shape":"FindingMetricsValuePerSeverity", - "documentation":"The average time it takes to close findings of each severity in days.
" + "documentation":"The average time in days it takes to close findings of each severity as of a specified date.
" }, "newFindings":{ "shape":"FindingMetricsValuePerSeverity", - "documentation":"The number of new findings of each severity in account on the specified date.
" + "documentation":"The number of new findings of each severity on the specified date.
" }, "openFindings":{ "shape":"FindingMetricsValuePerSeverity", - "documentation":"The number of open findings of each severity in an account as of the specified date.
" + "documentation":"The number of open findings of each severity as of the specified date.
" } }, - "documentation":"A summary of findings metrics in an account.
" + "documentation":"A summary of findings metrics for an account on a specified date.
" }, "AnalysisType":{ "type":"string", @@ -366,7 +368,7 @@ }, "findings":{ "shape":"Findings", - "documentation":"A list of all requested findings.
" + "documentation":"A list of all findings which were successfully fetched.
" } } }, @@ -465,11 +467,11 @@ }, "resourceId":{ "shape":"ResourceId", - "documentation":"The identifier for an input resource used to create a scan.
" + "documentation":"The identifier for the resource object to be scanned.
" }, "scanName":{ "shape":"ScanName", - "documentation":"The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD scan type. If not specified, it will be auto generated.
The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD scan type.
The identifier for the uploaded code resource.
" + "documentation":"The identifier for the uploaded code resource. Pass this to CreateScan to use the uploaded resources.
A pre-signed S3 URL. You can upload the code file you want to scan and add the required requestHeaders using any HTTP client.
A pre-signed S3 URL. You can upload the code file you want to scan with the required requestHeaders using any HTTP client.
The KMS key ARN to use for encryption. This must be provided as a header when uploading your code resource.
" + "documentation":"The KMS key ARN that is used for encryption. If an AWS-managed key is used for encryption, returns empty.
" } }, - "documentation":"Information about account-level configuration.
" + "documentation":"Information about the encryption configuration for an account. Required to call UpdateAccountConfiguration.
The identifier for the component that generated a finding such as AWSCodeGuruSecurity or AWSInspector.
" + "documentation":"The identifier for the component that generated a finding such as AmazonCodeGuruSecurity.
" }, "id":{ "shape":"String", @@ -643,7 +649,7 @@ }, "severity":{ "shape":"Severity", - "documentation":"The severity of the finding.
" + "documentation":"The severity of the finding. Severity can be critical, high, medium, low, or informational. For information on severity levels, see Finding severity in the Amazon CodeGuru Security User Guide.
" }, "status":{ "shape":"Status", @@ -697,26 +703,26 @@ "members":{ "critical":{ "shape":"Double", - "documentation":"The severity of the finding is critical and should be addressed immediately.
" + "documentation":"A numeric value corresponding to a critical finding.
" }, "high":{ "shape":"Double", - "documentation":"The severity of the finding is high and should be addressed as a near-term priority.
" + "documentation":"A numeric value corresponding to a high severity finding.
" }, "info":{ "shape":"Double", - "documentation":"The finding is related to quality or readability improvements and not considered actionable.
" + "documentation":"A numeric value corresponding to an informational finding.
" }, "low":{ "shape":"Double", - "documentation":"The severity of the finding is low and does require action on its own.
" + "documentation":"A numeric value corresponding to a low severity finding.
" }, "medium":{ "shape":"Double", - "documentation":"The severity of the finding is medium and should be addressed as a mid-term priority.
" + "documentation":"A numeric value corresponding to a medium severity finding.
" } }, - "documentation":"The severity of the issue in the code that generated a finding.
" + "documentation":"A numeric value corresponding to the severity of a finding, such as the number of open findings or the average time it takes to close findings of a given severity.
" }, "Findings":{ "type":"list", @@ -737,7 +743,7 @@ "members":{ "encryptionConfig":{ "shape":"EncryptionConfig", - "documentation":"An EncryptionConfig object that contains the KMS key ARN to use for encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify your own key, call UpdateAccountConfiguration.
An EncryptionConfig object that contains the KMS key ARN that is used for encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify your own key, call UpdateAccountConfiguration. If you do not specify a customer-managed key, returns empty.
The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results.
The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 1000 results.
The date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years since metrics data is only stored for two years. If a date outside of this range is passed, the response will be empty.
", + "documentation":"The date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years.
", "location":"querystring", "locationName":"date" } @@ -847,6 +853,10 @@ "shape":"Timestamp", "documentation":"The time the scan was created.
" }, + "errorMessage":{ + "shape":"ErrorMessage", + "documentation":"Details about the error that causes a scan to fail to be retrieved.
" + }, "numberOfRevisions":{ "shape":"Long", "documentation":"The number of times a scan has been re-run on a revised resource.
" @@ -865,7 +875,7 @@ }, "scanState":{ "shape":"ScanState", - "documentation":"The current state of the scan. Pass either InProgress, Successful, or Failed.
The current state of the scan. Returns either InProgress, Successful, or Failed.
The end date of the interval which you want to retrieve metrics from.
", + "documentation":"The end date of the interval which you want to retrieve metrics from. Round to the nearest day.
", "location":"querystring", "locationName":"endDate" }, "maxResults":{ "shape":"ListFindingsMetricsRequestMaxResultsInteger", - "documentation":"The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results.
The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 1000 results.
The start date of the interval which you want to retrieve metrics from.
", + "documentation":"The start date of the interval which you want to retrieve metrics from. Rounds to the nearest day.
", "location":"querystring", "locationName":"startDate" } @@ -966,7 +976,7 @@ "members":{ "maxResults":{ "shape":"ListScansRequestMaxResultsInteger", - "documentation":"The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results.
The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 100 results.
The ARN of the ScanName object. You can retrieve this ARN by calling ListScans or GetScan.
The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.
A list of CategoryWithFindingNum objects for the top 5 finding categories with the most open findings in an account.
A list of CategoryWithFindingNum objects for the top 5 finding categories with the most findings.
The number of open findings of each severity in an account.
" + "documentation":"The number of open findings of each severity.
" }, "scansWithMostOpenCriticalFindings":{ "shape":"ScansWithMostOpenCriticalFindings", - "documentation":"A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings in an account.
A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings.
A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings in an account.
A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings.
Information about summary metrics in an account.
" + "documentation":"A summary of metrics for an account as of a specified date.
" }, "NextToken":{ "type":"string", @@ -1101,24 +1111,24 @@ "members":{ "id":{ "shape":"String", - "documentation":"The identifier for the resource.
" + "documentation":"The scanName of the scan that was run on the resource.
The identifier for a section of the resource, such as an AWS Lambda layer.
" + "documentation":"The identifier for a section of the resource.
" } }, - "documentation":"Information about a resource, such as an Amazon S3 bucket or AWS Lambda function, that contains a finding.
" + "documentation":"Information about a resource that contains a finding.
" }, "ResourceId":{ "type":"structure", "members":{ "codeArtifactId":{ "shape":"Uuid", - "documentation":"The identifier for the code file uploaded to the resource where a finding was detected.
" + "documentation":"The identifier for the code file uploaded to the resource object. Returned by CreateUploadUrl when you upload resources to be scanned.
The identifier for a resource object that contains resources where a finding was detected.
", + "documentation":"The identifier for a resource object that contains resources to scan. Specifying a codeArtifactId is required to create a scan.
", "union":true }, "ResourceNotFoundException":{ @@ -1176,14 +1186,14 @@ "members":{ "findingNumber":{ "shape":"Integer", - "documentation":"The number of open findings generated by a scan.
" + "documentation":"The number of findings generated by a scan.
" }, "scanName":{ "shape":"String", "documentation":"The name of the scan.
" } }, - "documentation":"Information about a scan with open findings.
" + "documentation":"Information about the number of findings generated by a scan.
" }, "ScanState":{ "type":"string", @@ -1276,7 +1286,7 @@ "members":{ "code":{ "shape":"String", - "documentation":"The suggested code to add to your file.
" + "documentation":"The suggested code fix. If applicable, includes code patch to replace your source code.
" }, "description":{ "shape":"String", @@ -1316,7 +1326,7 @@ "members":{ "resourceArn":{ "shape":"ScanNameArn", - "documentation":"The ARN of the ScanName object. You can retrieve this ARN by calling ListScans or GetScan.
The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.
The ARN of the ScanName object. You can retrieve this ARN by calling ListScans or GetScan.
The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.
The KMS key ARN you want to use for encryption. Defaults to service-side encryption if missing.
" + "documentation":"The customer-managed KMS key ARN you want to use for encryption. If not specified, CodeGuru Security will use an AWS-managed key for encryption. If you previously specified a customer-managed KMS key and want CodeGuru Security to use an AWS-managed key for encryption instead, pass nothing.
" } } }, @@ -1411,7 +1421,7 @@ "members":{ "encryptionConfig":{ "shape":"EncryptionConfig", - "documentation":"An EncryptionConfig object that contains the KMS key ARN to use for encryption.
An EncryptionConfig object that contains the KMS key ARN that is used for encryption. If you did not specify a customer-managed KMS key in the request, returns empty.
The number of times the vulnerability appears in your code.
" + "documentation":"The number of times the vulnerability appears in your code.
", + "deprecated":true, + "deprecatedMessage":"This shape is not used." }, "referenceUrls":{ "shape":"ReferenceUrls", diff --git a/botocore/data/elasticache/2015-02-02/service-2.json b/botocore/data/elasticache/2015-02-02/service-2.json index 2b9c916def..e9e97b1470 100644 --- a/botocore/data/elasticache/2015-02-02/service-2.json +++ b/botocore/data/elasticache/2015-02-02/service-2.json @@ -4,6 +4,7 @@ "apiVersion":"2015-02-02", "endpointPrefix":"elasticache", "protocol":"query", + "protocols":["query"], "serviceFullName":"Amazon ElastiCache", "serviceId":"ElastiCache", "signatureVersion":"v4", @@ -1532,7 +1533,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).
This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.
Note the following
A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.
If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
Replication group message: Test Failover API called for node group <node-group-id>
Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed
Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed
Cache cluster message: Recovering cache nodes <node-id>
Cache cluster message: Finished recovery for cache nodes <node-id>
For more information see:
Viewing ElastiCache Events in the ElastiCache User Guide
DescribeEvents in the ElastiCache API Reference
Also see, Testing Multi-AZ in the ElastiCache User Guide.
" + "documentation":"Represents the input of a TestFailover operation which tests automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).
This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.
Note the following
A customer can use this operation to test automatic failover on up to 15 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.
If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.
If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.
To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:
Replication group message: Test Failover API called for node group <node-group-id>
Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed
Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed
Cache cluster message: Recovering cache nodes <node-id>
Cache cluster message: Finished recovery for cache nodes <node-id>
For more information see:
Viewing ElastiCache Events in the ElastiCache User Guide
DescribeEvents in the ElastiCache API Reference
Also see, Testing Multi-AZ in the ElastiCache User Guide.
" }, "TestMigration":{ "name":"TestMigration", @@ -4190,7 +4191,7 @@ }, "Marker":{ "shape":"String", - "documentation":"An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >
" + "documentation":"An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.>
" } } }, @@ -5189,7 +5190,7 @@ }, "AuthTokenUpdateStrategy":{ "shape":"AuthTokenUpdateStrategyType", - "documentation":"Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:
Rotate
Set
For more information, see Authenticating Users with Redis AUTH
" + "documentation":"Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:
ROTATE - default, if no update strategy is provided
SET - allowed only after ROTATE
DELETE - allowed only when transitioning to RBAC
For more information, see Authenticating Users with Redis AUTH
" }, "LogDeliveryConfigurations":{ "shape":"LogDeliveryConfigurationRequestList", @@ -5381,7 +5382,7 @@ }, "AuthTokenUpdateStrategy":{ "shape":"AuthTokenUpdateStrategyType", - "documentation":"Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:
Rotate
Set
For more information, see Authenticating Users with Redis AUTH
" + "documentation":"Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:
ROTATE - default, if no update strategy is provided
SET - allowed only after ROTATE
DELETE - allowed only when transitioning to RBAC
For more information, see Authenticating Users with Redis AUTH
" }, "UserGroupIdsToAdd":{ "shape":"UserGroupIdList", @@ -7541,7 +7542,7 @@ }, "NodeGroupId":{ "shape":"AllowedNodeGroupId", - "documentation":"The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 5 node groups in any rolling 24-hour period.
" + "documentation":"The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 15 node groups in any rolling 24-hour period.
" } } }, diff --git a/botocore/data/launch-wizard/2018-05-10/service-2.json b/botocore/data/launch-wizard/2018-05-10/service-2.json index 956316c387..c4365bb5e2 100644 --- a/botocore/data/launch-wizard/2018-05-10/service-2.json +++ b/botocore/data/launch-wizard/2018-05-10/service-2.json @@ -5,6 +5,7 @@ "endpointPrefix":"launchwizard", "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"AWS Launch Wizard", "serviceId":"Launch Wizard", "signatureVersion":"v4", @@ -39,6 +40,7 @@ "input":{"shape":"DeleteDeploymentInput"}, "output":{"shape":"DeleteDeploymentOutput"}, "errors":[ + {"shape":"ResourceLimitException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} @@ -78,6 +80,22 @@ ], "documentation":"Returns information about a workload.
" }, + "GetWorkloadDeploymentPattern":{ + "name":"GetWorkloadDeploymentPattern", + "http":{ + "method":"POST", + "requestUri":"/getWorkloadDeploymentPattern", + "responseCode":200 + }, + "input":{"shape":"GetWorkloadDeploymentPatternInput"}, + "output":{"shape":"GetWorkloadDeploymentPatternOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns details for a given workload and deployment pattern, including the available specifications. You can use the ListWorkloads operation to discover the available workload names and the ListWorkloadDeploymentPatterns operation to discover the available deployment pattern names of a given workload.
" + }, "ListDeploymentEvents":{ "name":"ListDeploymentEvents", "http":{ @@ -109,6 +127,22 @@ ], "documentation":"Lists the deployments that have been created.
" }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Lists the tags associated with a specified resource.
" + }, "ListWorkloadDeploymentPatterns":{ "name":"ListWorkloadDeploymentPatterns", "http":{ @@ -123,7 +157,7 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"Lists the workload deployment patterns.
" + "documentation":"Lists the workload deployment patterns for a given workload name. You can use the ListWorkloads operation to discover the available workload names.
" }, "ListWorkloads":{ "name":"ListWorkloads", @@ -138,10 +172,47 @@ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], - "documentation":"Lists the workloads.
" + "documentation":"Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Adds the specified tags to the given resource.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Removes the specified tags from the given resource.
", + "idempotent":true } }, "shapes":{ + "AllowedValues":{ + "type":"list", + "member":{"shape":"ValueString"} + }, "Boolean":{ "type":"boolean", "box":true @@ -169,11 +240,15 @@ }, "specifications":{ "shape":"DeploymentSpecifications", - "documentation":"The settings specified for the deployment. For more information on the specifications required for creating a deployment, see Workload specifications.
" + "documentation":"The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.
The tags to add to the deployment.
" }, "workloadName":{ "shape":"WorkloadName", - "documentation":"The name of the workload. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.
The name of the workload. You can use the ListWorkloads operation to discover supported values for this parameter.
The comparator of the condition.
Valid values: Equal | NotEqual
The name of the deployment condition.
" + }, + "value":{ + "shape":"String", + "documentation":"The value of the condition.
" + } + }, + "documentation":"A field that details a condition of the specifications for a deployment.
" + }, "DeploymentData":{ "type":"structure", "members":{ @@ -220,6 +313,10 @@ "shape":"Timestamp", "documentation":"The time the deployment was deleted.
" }, + "deploymentArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the deployment.
" + }, "id":{ "shape":"DeploymentId", "documentation":"The ID of the deployment.
" @@ -238,12 +335,16 @@ }, "specifications":{ "shape":"DeploymentSpecifications", - "documentation":"The specifications of the deployment. For more information on specifications for each deployment, see Workload specifications.
" + "documentation":"The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.
The status of the deployment.
" }, + "tags":{ + "shape":"Tags", + "documentation":"Information about the tags attached to a deployment.
" + }, "workloadName":{ "shape":"WorkloadName", "documentation":"The name of the workload.
" @@ -358,15 +459,15 @@ }, "DeploymentName":{ "type":"string", - "max":25, + "max":50, "min":1, - "pattern":"^[A-Za-z0-9_\\s\\.-]+$" + "pattern":"^[A-Za-z0-9_\\.-]+$" }, "DeploymentPatternName":{ "type":"string", "max":256, "min":1, - "pattern":"^[a-zA-Z0-9-]+$" + "pattern":"^[A-Za-z0-9][a-zA-Z0-9-]*$" }, "DeploymentSpecifications":{ "type":"map", @@ -376,6 +477,38 @@ "min":1, "sensitive":true }, + "DeploymentSpecificationsData":{ + "type":"list", + "member":{"shape":"DeploymentSpecificationsField"}, + "max":100, + "min":1 + }, + "DeploymentSpecificationsField":{ + "type":"structure", + "members":{ + "allowedValues":{ + "shape":"AllowedValues", + "documentation":"The allowed values of the deployment specification.
" + }, + "conditionals":{ + "shape":"SpecificationsConditionalData", + "documentation":"The conditionals used for the deployment specification.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the deployment specification.
" + }, + "name":{ + "shape":"String", + "documentation":"The name of the deployment specification.
" + }, + "required":{ + "shape":"String", + "documentation":"Indicates if the deployment specification is required.
" + } + }, + "documentation":"A field that details a specification of a deployment pattern.
" + }, "DeploymentStatus":{ "type":"string", "enum":[ @@ -422,6 +555,32 @@ } } }, + "GetWorkloadDeploymentPatternInput":{ + "type":"structure", + "required":[ + "deploymentPatternName", + "workloadName" + ], + "members":{ + "deploymentPatternName":{ + "shape":"DeploymentPatternName", + "documentation":"The name of the deployment pattern.
" + }, + "workloadName":{ + "shape":"WorkloadName", + "documentation":"The name of the workload.
" + } + } + }, + "GetWorkloadDeploymentPatternOutput":{ + "type":"structure", + "members":{ + "workloadDeploymentPattern":{ + "shape":"WorkloadDeploymentPatternData", + "documentation":"Details about the workload deployment pattern.
" + } + } + }, "GetWorkloadInput":{ "type":"structure", "required":["workloadName"], @@ -493,7 +652,7 @@ "members":{ "filters":{ "shape":"DeploymentFilterList", - "documentation":"Filters to scope the results. The following filters are supported:
WORKLOAD_NAME
DEPLOYMENT_STATUS
Filters to scope the results. The following filters are supported:
WORKLOAD_NAME - The name used in deployments.
DEPLOYMENT_STATUS - COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING
The Amazon Resource Name (ARN) of the resource.
", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"Tags", + "documentation":"Information about the tags.
" + } + } + }, "ListWorkloadDeploymentPatternsInput":{ "type":"structure", "required":["workloadName"], @@ -628,8 +808,88 @@ }, "exception":true }, + "SpecificationsConditionalData":{ + "type":"list", + "member":{"shape":"DeploymentConditionalField"}, + "max":5, + "min":1 + }, "String":{"type":"string"}, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":1 + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the resource.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"Tags", + "documentation":"One or more tags to attach to the resource.
" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "Tags":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":200, + "min":1 + }, "Timestamp":{"type":"timestamp"}, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"The Amazon Resource Name (ARN) of the resource.
", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"Keys identifying the tags to remove.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, "ValidationException":{ "type":"structure", "members":{ @@ -699,6 +959,44 @@ "type":"list", "member":{"shape":"WorkloadDataSummary"} }, + "WorkloadDeploymentPatternData":{ + "type":"structure", + "members":{ + "deploymentPatternName":{ + "shape":"DeploymentPatternName", + "documentation":"The name of the deployment pattern.
" + }, + "description":{ + "shape":"String", + "documentation":"The description of the deployment pattern.
" + }, + "displayName":{ + "shape":"String", + "documentation":"The display name of the deployment pattern.
" + }, + "specifications":{ + "shape":"DeploymentSpecificationsData", + "documentation":"The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.
The status of the deployment pattern.
" + }, + "statusMessage":{ + "shape":"String", + "documentation":"The status message of the deployment pattern.
" + }, + "workloadName":{ + "shape":"WorkloadName", + "documentation":"The workload name of the deployment pattern.
" + }, + "workloadVersionName":{ + "shape":"WorkloadVersionName", + "documentation":"The workload version name of the deployment pattern.
" + } + }, + "documentation":"The data that details a workload deployment pattern.
" + }, "WorkloadDeploymentPatternDataSummary":{ "type":"structure", "members":{ @@ -748,9 +1046,9 @@ }, "WorkloadName":{ "type":"string", - "max":256, + "max":100, "min":1, - "pattern":"^[a-zA-Z0-9-]+$" + "pattern":"^[A-Za-z][a-zA-Z0-9-_]*$" }, "WorkloadStatus":{ "type":"string", @@ -765,7 +1063,7 @@ "type":"string", "max":30, "min":5, - "pattern":"^[a-zA-Z0-9-]+$" + "pattern":"^[A-Za-z0-9][a-zA-Z0-9-]*$" } }, "documentation":"Launch Wizard offers a guided way of sizing, configuring, and deploying Amazon Web Services resources for third party applications, such as Microsoft SQL Server Always On and HANA based SAP systems, without the need to manually identify and provision individual Amazon Web Services resources.
" diff --git a/tests/functional/endpoint-rules/launch-wizard/endpoint-tests-1.json b/tests/functional/endpoint-rules/launch-wizard/endpoint-tests-1.json index 850ed0a8fd..33502c9dc8 100644 --- a/tests/functional/endpoint-rules/launch-wizard/endpoint-tests-1.json +++ b/tests/functional/endpoint-rules/launch-wizard/endpoint-tests-1.json @@ -308,17 +308,6 @@ "expect": { "error": "Invalid Configuration: Missing Region" } - }, - { - "documentation": "Partition doesn't support DualStack", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } } ], "version": "1.0"