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.
Information that tells you if encryption for build artifacts is disabled.
", "BuildBatch$debugSessionEnabled": "Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.
", "CreateProjectInput$badgeEnabled": "Set this to true to generate a publicly accessible URL for your project's build badge.
", - "CreateWebhookInput$manualCreation": "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.
Specifies if session debugging is enabled for this build.
", "GitSubmodulesConfig$fetchSubmodules": "Set to true to fetch Git submodules for your CodeBuild build project.
", "ImportSourceCredentialsInput$shouldOverwrite": " Set to false to prevent overwriting the repository source credentials. Set to true to overwrite the repository source credentials. The default value is true.
CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild to use your own build tools. CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about CodeBuild, see the CodeBuild User Guide.
', 'operations' => [ 'BatchDeleteBuilds' => 'Deletes one or more builds.
', 'BatchGetBuildBatches' => 'Retrieves information about one or more batch builds.
', 'BatchGetBuilds' => 'Gets information about one or more builds.
', 'BatchGetFleets' => 'Gets information about one or more compute fleets.
', 'BatchGetProjects' => 'Gets information about one or more build projects.
', 'BatchGetReportGroups' => 'Returns an array of report groups.
', 'BatchGetReports' => 'Returns an array of reports.
', 'CreateFleet' => 'Creates a compute fleet.
', 'CreateProject' => 'Creates a build project.
', 'CreateReportGroup' => 'Creates a report group. A report group contains a collection of reports.
', 'CreateWebhook' => 'For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.
If you enable webhooks for an CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project\'s Settings.
Deletes a batch build.
', 'DeleteFleet' => 'Deletes a compute fleet. When you delete a compute fleet, its builds are not deleted.
', 'DeleteProject' => 'Deletes a build project. When you delete a project, its builds are not deleted.
', 'DeleteReport' => 'Deletes a report.
', 'DeleteReportGroup' => 'Deletes a report group. Before you delete a report group, you must delete its reports.
', 'DeleteResourcePolicy' => 'Deletes a resource policy that is identified by its resource ARN.
', 'DeleteSourceCredentials' => 'Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
', 'DeleteWebhook' => 'For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository.
', 'DescribeCodeCoverages' => 'Retrieves one or more code coverage reports.
', 'DescribeTestCases' => 'Returns a list of details about test cases for a report.
', 'GetReportGroupTrend' => 'Analyzes and accumulates test report values for the specified test reports.
', 'GetResourcePolicy' => 'Gets a resource policy that is identified by its resource ARN.
', 'ImportSourceCredentials' => 'Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
', 'InvalidateProjectCache' => 'Resets the cache for a project.
', 'ListBuildBatches' => 'Retrieves the identifiers of your build batches in the current region.
', 'ListBuildBatchesForProject' => 'Retrieves the identifiers of the build batches for a specific project.
', 'ListBuilds' => 'Gets a list of build IDs, with each build ID representing a single build.
', 'ListBuildsForProject' => 'Gets a list of build identifiers for the specified build project, with each build identifier representing a single build.
', 'ListCuratedEnvironmentImages' => 'Gets information about Docker images that are managed by CodeBuild.
', 'ListFleets' => 'Gets a list of compute fleet names with each compute fleet name representing a single compute fleet.
', 'ListProjects' => 'Gets a list of build project names, with each build project name representing a single build project.
', 'ListReportGroups' => 'Gets a list ARNs for the report groups in the current Amazon Web Services account.
', 'ListReports' => 'Returns a list of ARNs for the reports in the current Amazon Web Services account.
', 'ListReportsForReportGroup' => ' Returns a list of ARNs for the reports that belong to a ReportGroup.
Gets a list of projects that are shared with other Amazon Web Services accounts or users.
', 'ListSharedReportGroups' => 'Gets a list of report groups that are shared with other Amazon Web Services accounts or users.
', 'ListSourceCredentials' => ' Returns a list of SourceCredentialsInfo objects.
Stores a resource policy for the ARN of a Project or ReportGroup object.
Restarts a build.
', 'RetryBuildBatch' => 'Restarts a failed batch build. Only batch builds that have failed can be retried.
', 'StartBuild' => 'Starts running a build with the settings defined in the project. These setting include: how to run a build, where to get the source code, which build environment to use, which build commands to run, and where to store the build output.
You can also start a build run by overriding some of the build settings in the project. The overrides only apply for that specific start build request. The settings in the project are unaltered.
', 'StartBuildBatch' => 'Starts a batch build for a project.
', 'StopBuild' => 'Attempts to stop running a build.
', 'StopBuildBatch' => 'Stops a running batch build.
', 'UpdateFleet' => 'Updates a compute fleet.
', 'UpdateProject' => 'Changes the settings of a build project.
', 'UpdateProjectVisibility' => 'Changes the public visibility for a project. The project\'s build results, logs, and artifacts are available to the general public. For more information, see Public build projects in the CodeBuild User Guide.
The following should be kept in mind when making your projects public:
All of a project\'s build results, logs, and artifacts, including builds that were run when the project was private, are available to the general public.
All build logs and artifacts are available to the public. Environment variables, source code, and other sensitive information may have been output to the build logs and artifacts. You must be careful about what information is output to the build logs. Some best practice are:
Do not store sensitive values in environment variables. We recommend that you use an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store sensitive values.
Follow Best practices for using webhooks in the CodeBuild User Guide to limit which entities can trigger a build, and do not store the buildspec in the project itself, to ensure that your webhooks are as secure as possible.
A malicious user can use public builds to distribute malicious artifacts. We recommend that you review all pull requests to verify that the pull request is a legitimate change. We also recommend that you validate any artifacts with their checksums to make sure that the correct artifacts are being downloaded.
Updates a report group.
', 'UpdateWebhook' => 'Updates the webhook associated with an CodeBuild build project.
If you use Bitbucket for your repository, rotateSecret is ignored.
An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.
', 'refs' => [], ], 'ArtifactNamespace' => [ 'base' => NULL, 'refs' => [ 'ProjectArtifacts$namespaceType' => 'Along with path and name, the pattern that CodeBuild uses to determine the name and location to store the output artifact:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, valid values include:
BUILD_ID: Include the build ID in the location of the build output artifact.
NONE: Do not include the build ID. This is the default if namespaceType is not specified.
For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
The type of build output artifact to create:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, valid values include:
NONE: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.
ZIP: CodeBuild creates in the output bucket a ZIP file that contains the build output.
The type of build output artifact. Valid values include:
CODEPIPELINE: The build project has build output generated through CodePipeline.
The CODEPIPELINE type is not supported for secondaryArtifacts.
NO_ARTIFACTS: The build project does not produce any build output.
S3: The build project stores build output in Amazon S3.
Specifies the type of artifact.
', ], ], 'AuthType' => [ 'base' => NULL, 'refs' => [ 'ImportSourceCredentialsInput$authType' => 'The type of authentication used to connect to a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the CodeBuild console. Note that CODECONNECTIONS is only valid for GitLab and GitLab Self Managed.
', 'SourceCredentialsInfo$authType' => 'The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, PERSONAL_ACCESS_TOKEN, or CODECONNECTIONS.
', ], ], 'BatchDeleteBuildsInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteBuildsOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetBuildBatchesInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetBuildBatchesOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetBuildsInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetBuildsOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetFleetsInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetFleetsOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetProjectsInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetProjectsOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetReportGroupsInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetReportGroupsOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetReportsInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetReportsOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchReportModeType' => [ 'base' => NULL, 'refs' => [ 'ProjectBuildBatchConfig$batchReportMode' => 'Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.
(Default) Aggregate all of the build statuses into a single status report.
Send a separate status report for each individual build.
Specifies restrictions for the batch build.
', 'refs' => [ 'ProjectBuildBatchConfig$restrictions' => 'A BatchRestrictions object that specifies the restrictions for the batch build.
Whether the build is complete. True if complete; otherwise, false.
', 'BuildBatch$complete' => 'Indicates if the batch build is complete.
', 'BuildGroup$ignoreFailure' => 'Specifies if failures in this build group can be ignored.
', 'DeleteReportGroupInput$deleteReports' => 'If true, deletes any reports that belong to a report group before deleting the report group.
If false, you must delete any reports in the report group. Use ListReportsForReportGroup to get the reports in a report group. Use DeleteReport to delete the reports. If you call DeleteReportGroup for a report group that contains one or more reports, an exception is thrown.
Set this to true to generate a publicly accessible URL for your project\'s build badge.
', 'UpdateWebhookInput$rotateSecret' => ' A boolean value that specifies whether the associated GitHub repository\'s secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.
Specifies the bucket owner\'s access for objects that another account uploads to their Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has access to these objects. This property allows you to give the bucket owner access to these objects.
To use this property, your CodeBuild service role must have the s3:PutBucketAcl permission. This permission allows CodeBuild to modify the access control list for the bucket.
This property can be one of the following values:
The bucket owner does not have access to the objects. This is the default.
The bucket owner has read-only access to the objects. The uploading account retains ownership of the objects.
The bucket owner has full access to the objects. Object ownership is determined by the following criteria:
If the bucket is configured with the Bucket owner preferred setting, the bucket owner owns the objects. The uploading account will have object access as specified by the bucket\'s policy.
Otherwise, the uploading account retains ownership of the objects.
For more information about Amazon S3 object ownership, see Controlling ownership of uploaded objects using S3 Object Ownership in the Amazon Simple Storage Service User Guide.
Information about a build.
', 'refs' => [ 'Builds$member' => NULL, 'RetryBuildOutput$build' => NULL, 'StartBuildOutput$build' => 'Information about the build to be run.
', 'StopBuildOutput$build' => 'Information about the build.
', ], ], 'BuildArtifacts' => [ 'base' => 'Information about build output artifacts.
', 'refs' => [ 'Build$artifacts' => 'Information about the output artifacts for the build.
', 'BuildArtifactsList$member' => NULL, 'BuildBatch$artifacts' => 'A BuildArtifacts object the defines the build artifacts for this batch build.
An array of ProjectArtifacts objects.
An array of BuildArtifacts objects the define the build artifacts for this batch build.
Contains information about a batch build.
', 'refs' => [ 'BuildBatches$member' => NULL, 'RetryBuildBatchOutput$buildBatch' => NULL, 'StartBuildBatchOutput$buildBatch' => 'A BuildBatch object that contains information about the batch build.
Specifies filters when retrieving batch builds.
', 'refs' => [ 'ListBuildBatchesForProjectInput$filter' => 'A BuildBatchFilter object that specifies the filters for the search.
A BuildBatchFilter object that specifies the filters for the search.
An array that contains the batch build identifiers to retrieve.
', 'BatchGetBuildBatchesOutput$buildBatchesNotFound' => 'An array that contains the identifiers of any batch builds that are not found.
', 'ListBuildBatchesForProjectOutput$ids' => 'An array of strings that contains the batch build identifiers.
', 'ListBuildBatchesOutput$ids' => 'An array of strings that contains the batch build identifiers.
', ], ], 'BuildBatchPhase' => [ 'base' => 'Contains information about a stage for a batch build.
', 'refs' => [ 'BuildBatchPhases$member' => NULL, ], ], 'BuildBatchPhaseType' => [ 'base' => NULL, 'refs' => [ 'BuildBatchPhase$phaseType' => 'The name of the batch build phase. Valid values include:
Build output artifacts are being combined and uploaded to the output location.
The batch build specification is being downloaded.
One or more of the builds failed.
The batch build is in progress.
The batch build was stopped.
The btach build has been submitted.
The batch build succeeded.
An array of BuildBatchPhase objects the specify the phases of the batch build.
An array of BuildBatch objects that represent the retrieved batch builds.
Contains information about a batch build build group. Build groups are used to combine builds that can run in parallel, while still being able to set dependencies on other build groups.
', 'refs' => [ 'BuildGroups$member' => NULL, ], ], 'BuildGroups' => [ 'base' => NULL, 'refs' => [ 'BuildBatch$buildGroups' => 'An array of BuildGroup objects that define the build groups for the batch build.
The IDs of the builds to delete.
', 'BatchDeleteBuildsOutput$buildsDeleted' => 'The IDs of the builds that were successfully deleted.
', 'BatchGetBuildsInput$ids' => 'The IDs of the builds.
', 'BatchGetBuildsOutput$buildsNotFound' => 'The IDs of builds for which information could not be found.
', 'DeleteBuildBatchOutput$buildsDeleted' => 'An array of strings that contain the identifiers of the builds that were deleted.
', 'ListBuildsForProjectOutput$ids' => 'A list of build identifiers for the specified build project, with each build ID representing a single build.
', 'ListBuildsOutput$ids' => 'A list of build IDs, with each build ID representing a single build.
', ], ], 'BuildNotDeleted' => [ 'base' => 'Information about a build that could not be successfully deleted.
', 'refs' => [ 'BuildsNotDeleted$member' => NULL, ], ], 'BuildPhase' => [ 'base' => 'Information about a stage for a build.
', 'refs' => [ 'BuildPhases$member' => NULL, ], ], 'BuildPhaseType' => [ 'base' => NULL, 'refs' => [ 'BuildPhase$phaseType' => 'The name of the build phase. Valid values include:
Core build activities typically occur in this build phase.
The build has been completed.
Source code is being downloaded in this build phase.
The build process is completing in this build phase.
Installation activities typically occur in this build phase.
Post-build activities typically occur in this build phase.
Pre-build activities typically occur in this build phase.
The build environment is being set up.
The build has been submitted and is queued behind other submitted builds.
The build has been submitted.
Build output artifacts are being uploaded to the output location.
Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
', ], ], 'BuildReportArns' => [ 'base' => NULL, 'refs' => [ 'Build$reportArns' => 'An array of the ARNs associated with this build\'s reports.
', ], ], 'BuildStatusConfig' => [ 'base' => 'Contains information that defines how the CodeBuild build project reports the build status to the source provider.
', 'refs' => [ 'ProjectSource$buildStatusConfig' => 'Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
An array of BuildSummary objects that contain summaries of previous build groups.
Contains summary information about a batch build group.
', 'refs' => [ 'BuildGroup$currentBuildSummary' => 'A BuildSummary object that contains a summary of the current build group.
How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.
', 'Project$timeoutInMinutes' => 'How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
', 'StartBuildBatchInput$buildTimeoutInMinutesOverride' => 'Overrides the build timeout specified in the batch build project.
', 'StartBuildInput$timeoutInMinutesOverride' => 'The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the latest setting already defined in the build project.
', 'UpdateProjectInput$timeoutInMinutes' => 'The replacement value in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.
', ], ], 'Builds' => [ 'base' => NULL, 'refs' => [ 'BatchGetBuildsOutput$builds' => 'Information about the requested builds.
', ], ], 'BuildsNotDeleted' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteBuildsOutput$buildsNotDeleted' => 'Information about any builds that could not be successfully deleted.
', 'DeleteBuildBatchOutput$buildsNotDeleted' => 'An array of BuildNotDeleted objects that specify the builds that could not be deleted.
The type of cache used by the build project. Valid values include:
NO_CACHE: The build project does not use any cache.
S3: The build project reads and writes from and to S3.
LOCAL: The build project stores a cache locally on a build host that is only available to that build host.
Information about CloudWatch Logs for a build project.
', 'refs' => [ 'LogsConfig$cloudWatchLogs' => 'Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.
', 'LogsLocation$cloudWatchLogs' => 'Information about CloudWatch Logs for a build project.
', ], ], 'CodeCoverage' => [ 'base' => 'Contains code coverage report information.
Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.
Branch coverage determines if your tests cover every possible branch of a control structure, such as an if or case statement.
Contains a summary of a code coverage report.
Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.
Branch coverage determines if your tests cover every possible branch of a control structure, such as an if or case statement.
A CodeCoverageReportSummary object that contains a code coverage summary for this report.
An array of CodeCoverage objects that contain the results.
Information about the compute resources the compute fleet uses. Available values include:
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 3 GB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see Build environment compute types in the CodeBuild User Guide.
', 'Fleet$computeType' => 'Information about the compute resources the compute fleet uses. Available values include:
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 3 GB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see Build environment compute types in the CodeBuild User Guide.
', 'ProjectEnvironment$computeType' => 'Information about the compute resources the build project uses. Available values include:
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 3 GB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
If you\'re using compute fleets during project creation, computeType will be ignored.
For more information, see Build Environment Compute Types in the CodeBuild User Guide.
', 'StartBuildBatchInput$computeTypeOverride' => 'The name of a compute type for this batch build that overrides the one specified in the batch build project.
', 'StartBuildInput$computeTypeOverride' => 'The name of a compute type for this build that overrides the one specified in the build project.
', 'UpdateFleetInput$computeType' => 'Information about the compute resources the compute fleet uses. Available values include:
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 3 GB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see Build environment compute types in the CodeBuild User Guide.
', ], ], 'ComputeTypesAllowed' => [ 'base' => NULL, 'refs' => [ 'BatchRestrictions$computeTypesAllowed' => 'An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the CodeBuild User Guide for these values.
', ], ], 'CreateFleetInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateFleetOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateReportGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateReportGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateWebhookInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateWebhookOutput' => [ 'base' => NULL, 'refs' => [], ], 'CredentialProviderType' => [ 'base' => NULL, 'refs' => [ 'RegistryCredential$credentialProvider' => 'The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager.
', ], ], 'DebugSession' => [ 'base' => 'Contains information about the debug session for a build. For more information, see Viewing a running build in Session Manager.
', 'refs' => [ 'Build$debugSession' => 'Contains information about the debug session for this build.
', ], ], 'DeleteBuildBatchInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBuildBatchOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFleetInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFleetOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteReportGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteReportGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteReportInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteReportOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSourceCredentialsInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSourceCredentialsOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWebhookInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWebhookOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCodeCoveragesInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCodeCoveragesOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTestCasesInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTestCasesOutput' => [ 'base' => NULL, 'refs' => [], ], 'EnvironmentImage' => [ 'base' => 'Information about a Docker image that is managed by CodeBuild.
', 'refs' => [ 'EnvironmentImages$member' => NULL, ], ], 'EnvironmentImages' => [ 'base' => NULL, 'refs' => [ 'EnvironmentLanguage$images' => 'The list of Docker images that are related by the specified programming language.
', ], ], 'EnvironmentLanguage' => [ 'base' => 'A set of Docker images that are related by programming language and are managed by CodeBuild.
', 'refs' => [ 'EnvironmentLanguages$member' => NULL, ], ], 'EnvironmentLanguages' => [ 'base' => NULL, 'refs' => [ 'EnvironmentPlatform$languages' => 'The list of programming languages that are available for the specified platform.
', ], ], 'EnvironmentPlatform' => [ 'base' => 'A set of Docker images that are related by platform and are managed by CodeBuild.
', 'refs' => [ 'EnvironmentPlatforms$member' => NULL, ], ], 'EnvironmentPlatforms' => [ 'base' => NULL, 'refs' => [ 'ListCuratedEnvironmentImagesOutput$platforms' => 'Information about supported platforms for Docker images that are managed by CodeBuild.
', ], ], 'EnvironmentType' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$environmentType' => 'The environment type of the compute fleet.
The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo).
The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).
The environment type WINDOWS_SERVER_2019_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland).
The environment type WINDOWS_SERVER_2022_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).
For more information, see Build environment compute types in the CodeBuild user guide.
', 'Fleet$environmentType' => 'The environment type of the compute fleet.
The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo).
The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).
The environment type WINDOWS_SERVER_2019_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland).
The environment type WINDOWS_SERVER_2022_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).
For more information, see Build environment compute types in the CodeBuild user guide.
', 'ProjectEnvironment$type' => 'The type of build environment to use for related builds.
The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).
The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).
The environment types ARM_LAMBDA_CONTAINER and LINUX_LAMBDA_CONTAINER are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), EU (Frankfurt), EU (Ireland), and South America (São Paulo).
The environment types WINDOWS_CONTAINER and WINDOWS_SERVER_2019_CONTAINER are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).
If you\'re using compute fleets during project creation, type will be ignored.
For more information, see Build environment compute types in the CodeBuild user guide.
', 'StartBuildBatchInput$environmentTypeOverride' => 'A container type for this batch build that overrides the one specified in the batch build project.
', 'StartBuildInput$environmentTypeOverride' => 'A container type for this build that overrides the one specified in the build project.
', 'UpdateFleetInput$environmentType' => 'The environment type of the compute fleet.
The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo).
The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).
The environment type WINDOWS_SERVER_2019_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland).
The environment type WINDOWS_SERVER_2022_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).
For more information, see Build environment compute types in the CodeBuild user guide.
', ], ], 'EnvironmentVariable' => [ 'base' => 'Information about an environment variable for a build project or a build.
', 'refs' => [ 'EnvironmentVariables$member' => NULL, ], ], 'EnvironmentVariableType' => [ 'base' => NULL, 'refs' => [ 'EnvironmentVariable$type' => 'The type of environment variable. Valid values include:
PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the value of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.
PLAINTEXT: An environment variable in plain text format. This is the default value.
SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the value of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.
A set of environment variables to make available to builds for this build project.
', 'StartBuildBatchInput$environmentVariablesOverride' => 'An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.
A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
', ], ], 'ExportedEnvironmentVariable' => [ 'base' => 'Contains information about an exported environment variable.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
During a build, the value of a variable is available starting with the install phase. It can be updated between the start of the install phase and the end of the post_build phase. After the post_build phase ends, the value of exported variables cannot change.
A list of exported environment variables for this build.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
', ], ], 'FileSystemType' => [ 'base' => NULL, 'refs' => [ 'ProjectFileSystemLocation$type' => ' The type of the file system. The one supported type is EFS.
An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.
For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.
An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must contain at least one EVENT WebhookFilter.
An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.
For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.
A set of dedicated instances for your build environment.
', 'refs' => [ 'CreateFleetOutput$fleet' => 'Information about the compute fleet
', 'Fleets$member' => NULL, 'UpdateFleetOutput$fleet' => 'A Fleet object.
The list of compute fleet names.
', ], ], 'FleetCapacity' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$baseCapacity' => 'The initial number of machines allocated to the fleet, which defines the number of builds that can run in parallel.
', 'Fleet$baseCapacity' => 'The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.
', 'ScalingConfigurationInput$maxCapacity' => 'The maximum number of instances in the fleet when auto-scaling.
', 'ScalingConfigurationOutput$maxCapacity' => 'The maximum number of instances in the fleet when auto-scaling.
', 'ScalingConfigurationOutput$desiredCapacity' => 'The desired number of instances in the fleet when auto-scaling.
', 'UpdateFleetInput$baseCapacity' => 'The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.
', ], ], 'FleetContextCode' => [ 'base' => NULL, 'refs' => [ 'FleetStatus$context' => 'Additional information about a compute fleet. Valid values include:
CREATE_FAILED: The compute fleet has failed to create.
UPDATE_FAILED: The compute fleet has failed to update.
The name of the compute fleet.
', 'Fleet$name' => 'The name of the compute fleet.
', ], ], 'FleetNames' => [ 'base' => NULL, 'refs' => [ 'BatchGetFleetsInput$names' => 'The names or ARNs of the compute fleets.
', 'BatchGetFleetsOutput$fleetsNotFound' => 'The names of compute fleets for which information could not be found.
', ], ], 'FleetOverflowBehavior' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$overflowBehavior' => 'The compute fleet overflow behavior.
For overflow behavior QUEUE, your overflow builds need to wait on the existing fleet instance to become available.
For overflow behavior ON_DEMAND, your overflow builds run on CodeBuild on-demand.
If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to Amazon Web Services services required to create a VPC network interface.
The compute fleet overflow behavior.
For overflow behavior QUEUE, your overflow builds need to wait on the existing fleet instance to become available.
For overflow behavior ON_DEMAND, your overflow builds run on CodeBuild on-demand.
If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to Amazon Web Services services required to create a VPC network interface.
The compute fleet overflow behavior.
For overflow behavior QUEUE, your overflow builds need to wait on the existing fleet instance to become available.
For overflow behavior ON_DEMAND, your overflow builds run on CodeBuild on-demand.
If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to Amazon Web Services services required to create a VPC network interface.
The metric type to determine auto-scaling.
', ], ], 'FleetScalingType' => [ 'base' => NULL, 'refs' => [ 'ScalingConfigurationInput$scalingType' => 'The scaling type for a compute fleet.
', 'ScalingConfigurationOutput$scalingType' => 'The scaling type for a compute fleet.
', ], ], 'FleetSortByType' => [ 'base' => NULL, 'refs' => [ 'ListFleetsInput$sortBy' => 'The criterion to be used to list compute fleet names. Valid values include:
CREATED_TIME: List based on when each compute fleet was created.
LAST_MODIFIED_TIME: List based on when information about each compute fleet was last changed.
NAME: List based on each compute fleet\'s name.
Use sortOrder to specify in what order to list the compute fleet names based on the preceding criteria.
The status of the compute fleet.
', 'refs' => [ 'Fleet$status' => 'The status of the compute fleet.
', ], ], 'FleetStatusCode' => [ 'base' => NULL, 'refs' => [ 'FleetStatus$statusCode' => 'The status code of the compute fleet. Valid values include:
CREATING: The compute fleet is being created.
UPDATING: The compute fleet is being updated.
ROTATING: The compute fleet is being rotated.
PENDING_DELETION: The compute fleet is pending deletion.
DELETING: The compute fleet is being deleted.
CREATE_FAILED: The compute fleet has failed to create.
UPDATE_ROLLBACK_FAILED: The compute fleet has failed to update and could not rollback to previous state.
ACTIVE: The compute fleet has succeeded and is active.
Information about the requested compute fleets.
', ], ], 'GetReportGroupTrendInput' => [ 'base' => NULL, 'refs' => [], ], 'GetReportGroupTrendOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'GitCloneDepth' => [ 'base' => NULL, 'refs' => [ 'ProjectSource$gitCloneDepth' => 'Information about the Git clone depth for the build project.
', 'StartBuildBatchInput$gitCloneDepthOverride' => 'The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build only, any previous depth of history defined in the batch build project.
', 'StartBuildInput$gitCloneDepthOverride' => 'The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.
', ], ], 'GitSubmodulesConfig' => [ 'base' => 'Information about the Git submodules configuration for an CodeBuild build project.
', 'refs' => [ 'ProjectSource$gitSubmodulesConfig' => 'Information about the Git submodules configuration for the build project.
', 'StartBuildBatchInput$gitSubmodulesConfigOverride' => 'A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.
Information about the Git submodules configuration for this build of an CodeBuild build project.
', ], ], 'Identifiers' => [ 'base' => NULL, 'refs' => [ 'BuildGroup$dependsOn' => 'An array of strings that contain the identifiers of the build groups that this build group depends on.
', ], ], 'ImagePullCredentialsType' => [ 'base' => NULL, 'refs' => [ 'ProjectEnvironment$imagePullCredentialsType' => 'The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal.
SERVICE_ROLE specifies that CodeBuild uses your build project\'s service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.
', 'StartBuildBatchInput$imagePullCredentialsTypeOverride' => 'The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild\'s service principal.
Specifies that CodeBuild uses your build project\'s service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.
The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild\'s service principal.
Specifies that CodeBuild uses your build project\'s service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.
A list of environment image versions.
', ], ], 'ImportSourceCredentialsInput' => [ 'base' => NULL, 'refs' => [], ], 'ImportSourceCredentialsOutput' => [ 'base' => NULL, 'refs' => [], ], 'InvalidInputException' => [ 'base' => 'The input value that was provided is not valid.
', 'refs' => [], ], 'InvalidateProjectCacheInput' => [ 'base' => NULL, 'refs' => [], ], 'InvalidateProjectCacheOutput' => [ 'base' => NULL, 'refs' => [], ], 'KeyInput' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => 'The tag\'s key.
', ], ], 'LanguageType' => [ 'base' => NULL, 'refs' => [ 'EnvironmentLanguage$language' => 'The programming language for the Docker images.
', ], ], 'ListBuildBatchesForProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'ListBuildBatchesForProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBuildBatchesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListBuildBatchesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBuildsForProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'ListBuildsForProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBuildsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListBuildsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListCuratedEnvironmentImagesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListCuratedEnvironmentImagesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListFleetsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListFleetsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListProjectsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProjectsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListReportGroupsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListReportGroupsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListReportsForReportGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'ListReportsForReportGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListReportsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListReportsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListSharedProjectsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSharedProjectsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListSharedReportGroupsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSharedReportGroupsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListSourceCredentialsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSourceCredentialsOutput' => [ 'base' => NULL, 'refs' => [], ], 'LogsConfig' => [ 'base' => 'Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both.
', 'refs' => [ 'BuildBatch$logConfig' => NULL, 'CreateProjectInput$logsConfig' => 'Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.
', 'Project$logsConfig' => 'Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.
', 'StartBuildBatchInput$logsConfigOverride' => 'A LogsConfig object that override the log settings defined in the batch build project.
Log settings for this build that override the log settings defined in the build project.
', 'UpdateProjectInput$logsConfig' => 'Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.
', ], ], 'LogsConfigStatusType' => [ 'base' => NULL, 'refs' => [ 'CloudWatchLogsConfig$status' => 'The current status of the logs in CloudWatch Logs for a build project. Valid values are:
ENABLED: CloudWatch Logs are enabled for this build project.
DISABLED: CloudWatch Logs are not enabled for this build project.
The current status of the S3 build logs. Valid values are:
ENABLED: S3 build logs are enabled for this build project.
DISABLED: S3 build logs are not enabled for this build project.
Information about build logs in CloudWatch Logs.
', 'refs' => [ 'Build$logs' => 'Information about the build\'s logs in CloudWatch Logs.
', ], ], 'NetworkInterface' => [ 'base' => 'Describes a network interface.
', 'refs' => [ 'Build$networkInterface' => 'Describes a network interface.
', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'Build$id' => 'The unique ID for the build.
', 'Build$arn' => 'The Amazon Resource Name (ARN) of the build.
', 'Build$sourceVersion' => 'Any version identifier for the version of the source code to be built. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
', 'Build$resolvedSourceVersion' => 'An identifier for the version of this build\'s source code.
For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For CodePipeline, the source revision provided by CodePipeline.
For Amazon S3, this does not apply.
The name of the CodeBuild project.
', 'Build$serviceRole' => 'The name of a service role used for this build.
', 'Build$encryptionKey' => 'The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK\'s alias (using the format alias/<alias-name>).
The identifier of the batch build.
', 'BuildBatch$arn' => 'The ARN of the batch build.
', 'BuildBatch$sourceVersion' => 'The identifier of the version of the source code to be built.
', 'BuildBatch$resolvedSourceVersion' => 'The identifier of the resolved version of this batch build\'s source code.
For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For CodePipeline, the source revision provided by CodePipeline.
For Amazon S3, this does not apply.
The name of the batch build project.
', 'BuildBatch$serviceRole' => 'The name of a service role used for builds in the batch.
', 'BuildBatch$encryptionKey' => 'The Key Management Service customer master key (CMK) to be used for encrypting the batch build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK\'s alias (using the format alias/<alias-name>).
The ID of the build that could not be successfully deleted.
', 'CodeCoverage$id' => 'The identifier of the code coverage report.
', 'CodeCoverage$reportARN' => 'The ARN of the report.
', 'CodeCoverage$filePath' => 'The path of the test report file.
', 'ComputeTypesAllowed$member' => NULL, 'CreateFleetInput$fleetServiceRole' => 'The service role associated with the compute fleet. For more information, see Allow a user to add a permission policy for a fleet service role in the CodeBuild User Guide.
', 'CreateProjectInput$serviceRole' => 'The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
', 'CreateProjectInput$encryptionKey' => 'The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK\'s alias (using the format alias/<alias-name>).
Contains the identifier of the Session Manager session used for the build. To work with the paused build, you open this session to examine, control, and resume the build.
', 'DeleteBuildBatchInput$id' => 'The identifier of the batch build to delete.
', 'DeleteFleetInput$arn' => 'The ARN of the compute fleet.
', 'DeleteProjectInput$name' => 'The name of the build project.
', 'DeleteReportGroupInput$arn' => 'The ARN of the report group to delete.
', 'DeleteReportInput$arn' => 'The ARN of the report to delete.
', 'DeleteResourcePolicyInput$resourceArn' => 'The ARN of the resource that is associated with the resource policy.
', 'DeleteSourceCredentialsInput$arn' => 'The Amazon Resource Name (ARN) of the token.
', 'DeleteSourceCredentialsOutput$arn' => 'The Amazon Resource Name (ARN) of the token.
', 'DescribeCodeCoveragesInput$reportArn' => 'The ARN of the report for which test cases are returned.
', 'EnvironmentVariable$name' => 'The name or key of the environment variable.
', 'ExportedEnvironmentVariable$name' => 'The name of the exported environment variable.
', 'Fleet$arn' => 'The ARN of the compute fleet.
', 'Fleet$id' => 'The ID of the compute fleet.
', 'Fleet$fleetServiceRole' => 'The service role associated with the compute fleet. For more information, see Allow a user to add a permission policy for a fleet service role in the CodeBuild User Guide.
', 'FleetArns$member' => NULL, 'FleetNames$member' => NULL, 'GetReportGroupTrendInput$reportGroupArn' => 'The ARN of the report group that contains the reports to analyze.
', 'GetResourcePolicyInput$resourceArn' => 'The ARN of the resource that is associated with the resource policy.
', 'GetResourcePolicyOutput$policy' => 'The resource policy for the resource identified by the input ARN parameter.
', 'Identifiers$member' => NULL, 'ImportSourceCredentialsInput$username' => ' The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.
The Amazon Resource Name (ARN) of the token.
', 'InvalidateProjectCacheInput$projectName' => 'The name of the CodeBuild build project that the cache is reset for.
', 'ListBuildBatchesForProjectInput$projectName' => 'The name of the project.
', 'ListBuildsForProjectInput$projectName' => 'The name of the CodeBuild project.
', 'ListProjectsInput$nextToken' => 'During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
', 'ListSharedProjectsInput$nextToken' => ' During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
The ID of the subnet.
', 'NetworkInterface$networkInterfaceId' => 'The ID of the network interface.
', 'Project$serviceRole' => 'The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
', 'Project$encryptionKey' => 'The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK\'s alias (using the format alias/<alias-name>). If you don\'t specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).
Contains the project identifier used with the public build APIs.
', 'Project$resourceAccessRole' => 'The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project\'s builds.
', 'ProjectArns$member' => NULL, 'ProjectBuildBatchConfig$serviceRole' => 'Specifies the service role ARN for the batch build project.
', 'ProjectEnvironment$image' => 'The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:
For an image tag: <registry>/<repository>:<tag>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be aws/codebuild/standard:4.0.
For an image digest: <registry>/<repository>@<digest>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use <registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
For more information, see Docker images provided by CodeBuild in the CodeBuild user guide.
', 'ProjectNames$member' => NULL, 'PutResourcePolicyInput$policy' => 'A JSON-formatted resource policy. For more information, see Sharing a Project and Sharing a Report Group in the CodeBuild User Guide.
', 'PutResourcePolicyInput$resourceArn' => ' The ARN of the Project or ReportGroup resource you want to associate with a resource policy.
The ARN of the Project or ReportGroup resource that is associated with a resource policy.
The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager.
The credential can use the name of the credentials only if they exist in your current Amazon Web Services Region.
The ARN of the report run.
', 'Report$reportGroupArn' => 'The ARN of the report group associated with this report.
', 'ReportArns$member' => NULL, 'ReportGroup$arn' => 'The ARN of the ReportGroup.
The ARN of the report.
', 'RetryBuildBatchInput$id' => 'Specifies the identifier of the batch build to restart.
', 'RetryBuildInput$id' => 'Specifies the identifier of the build to restart.
', 'S3ReportExportConfig$bucket' => 'The name of the S3 bucket where the raw data of a report are exported.
', 'S3ReportExportConfig$encryptionKey' => 'The encryption key for the report\'s encrypted raw data.
', 'SecurityGroupIds$member' => NULL, 'SourceCredentialsInfo$arn' => 'The Amazon Resource Name (ARN) of the token.
', 'StartBuildBatchInput$projectName' => 'The name of the project.
', 'StartBuildBatchInput$imageOverride' => 'The name of an image for this batch build that overrides the one specified in the batch build project.
', 'StartBuildBatchInput$serviceRoleOverride' => 'The name of a service role for this batch build that overrides the one specified in the batch build project.
', 'StartBuildBatchInput$encryptionKeyOverride' => 'The Key Management Service customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK\'s alias (using the format alias/<alias-name>).
The name of the CodeBuild build project to start running a build.
', 'StartBuildInput$imageOverride' => 'The name of an image for this build that overrides the one specified in the build project.
', 'StartBuildInput$serviceRoleOverride' => 'The name of a service role for this build that overrides the one specified in the build project.
', 'StartBuildInput$encryptionKeyOverride' => 'The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK\'s alias (using the format alias/<alias-name>).
The identifier of the batch build to stop.
', 'StopBuildInput$id' => 'The ID of the build.
', 'Subnets$member' => NULL, 'TestCase$reportArn' => 'The ARN of the report to which the test case belongs.
', 'UpdateFleetInput$arn' => 'The ARN of the compute fleet.
', 'UpdateFleetInput$fleetServiceRole' => 'The service role associated with the compute fleet. For more information, see Allow a user to add a permission policy for a fleet service role in the CodeBuild User Guide.
', 'UpdateProjectInput$name' => 'The name of the build project.
You cannot change a build project\'s name.
The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
', 'UpdateProjectInput$encryptionKey' => 'The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK\'s alias (using the format alias/<alias-name>).
The Amazon Resource Name (ARN) of the build project.
', 'UpdateProjectVisibilityInput$resourceAccessRole' => 'The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project\'s builds.
', 'UpdateProjectVisibilityOutput$projectArn' => 'The Amazon Resource Name (ARN) of the build project.
', 'UpdateProjectVisibilityOutput$publicProjectAlias' => 'Contains the project identifier used with the public build APIs.
', 'UpdateReportGroupInput$arn' => 'The ARN of the report group to update.
', 'VpcConfig$vpcId' => 'The ID of the Amazon VPC.
', 'Webhook$url' => 'The URL to the webhook.
', 'Webhook$payloadUrl' => 'The CodeBuild endpoint where webhook events are sent.
', 'Webhook$secret' => 'The secret token of the associated repository.
A Bitbucket webhook does not support secret.
The number of lines that are covered by your tests.
', 'CodeCoverage$linesMissed' => 'The number of lines that are not covered by your tests.
', 'CodeCoverage$branchesCovered' => 'The number of conditional branches that are covered by your tests.
', 'CodeCoverage$branchesMissed' => 'The number of conditional branches that are not covered by your tests.
', 'CodeCoverageReportSummary$linesCovered' => 'The number of lines that are covered by your tests.
', 'CodeCoverageReportSummary$linesMissed' => 'The number of lines that are not covered by your tests.
', 'CodeCoverageReportSummary$branchesCovered' => 'The number of conditional branches that are covered by your tests.
', 'CodeCoverageReportSummary$branchesMissed' => 'The number of conditional branches that are not covered by your tests.
', ], ], 'OAuthProviderException' => [ 'base' => 'There was a problem with the underlying OAuth provider.
', 'refs' => [], ], 'PageSize' => [ 'base' => NULL, 'refs' => [ 'DescribeCodeCoveragesInput$maxResults' => 'The maximum number of results to return.
', 'DescribeTestCasesInput$maxResults' => ' The maximum number of paginated test cases returned per response. Use nextToken to iterate pages in the list of returned TestCase objects. The default value is 100.
The number of reports to analyze. This operation always retrieves the most recent reports.
If this parameter is omitted, the most recent 100 reports are analyzed.
', 'ListBuildBatchesForProjectInput$maxResults' => 'The maximum number of results to return.
', 'ListBuildBatchesInput$maxResults' => 'The maximum number of results to return.
', 'ListFleetsInput$maxResults' => 'The maximum number of paginated compute fleets returned per response. Use nextToken to iterate pages in the list of returned compute fleets.
The maximum number of paginated report groups returned per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.
The maximum number of paginated reports in this report group returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.
The maximum number of paginated reports returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.
The maximum number of paginated shared build projects returned per response. Use nextToken to iterate pages in the list of returned Project objects. The default value is 100.
The maximum number of paginated shared report groups per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.
The percentage of lines that are covered by your tests.
', 'CodeCoverage$branchCoveragePercentage' => 'The percentage of branches that are covered by your tests.
', 'CodeCoverageReportSummary$lineCoveragePercentage' => 'The percentage of lines that are covered by your tests.
', 'CodeCoverageReportSummary$branchCoveragePercentage' => 'The percentage of branches that are covered by your tests.
', 'DescribeCodeCoveragesInput$minLineCoveragePercentage' => 'The minimum line coverage percentage to report.
', 'DescribeCodeCoveragesInput$maxLineCoveragePercentage' => 'The maximum line coverage percentage to report.
', ], ], 'PhaseContext' => [ 'base' => 'Additional information about a build phase that has an error. You can use this information for troubleshooting.
', 'refs' => [ 'PhaseContexts$member' => NULL, ], ], 'PhaseContexts' => [ 'base' => NULL, 'refs' => [ 'BuildBatchPhase$contexts' => 'Additional information about the batch build phase. Especially to help troubleshoot a failed batch build.
', 'BuildPhase$contexts' => 'Additional information about a build phase, especially to help troubleshoot a failed build.
', ], ], 'PlatformType' => [ 'base' => NULL, 'refs' => [ 'EnvironmentPlatform$platform' => 'The platform\'s name.
', ], ], 'Project' => [ 'base' => 'Information about a build project.
', 'refs' => [ 'CreateProjectOutput$project' => 'Information about the build project that was created.
', 'Projects$member' => NULL, 'UpdateProjectOutput$project' => 'Information about the build project that was changed.
', ], ], 'ProjectArns' => [ 'base' => NULL, 'refs' => [ 'ListSharedProjectsOutput$projects' => 'The list of ARNs for the build projects shared with the current Amazon Web Services account or user.
', ], ], 'ProjectArtifacts' => [ 'base' => 'Information about the build output artifacts for the build project.
', 'refs' => [ 'CreateProjectInput$artifacts' => 'Information about the build output artifacts for the build project.
', 'Project$artifacts' => 'Information about the build output artifacts for the build project.
', 'ProjectArtifactsList$member' => NULL, 'StartBuildBatchInput$artifactsOverride' => 'An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.
Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
', 'UpdateProjectInput$artifacts' => 'Information to be changed about the build output artifacts for the build project.
', ], ], 'ProjectArtifactsList' => [ 'base' => NULL, 'refs' => [ 'CreateProjectInput$secondaryArtifacts' => 'An array of ProjectArtifacts objects.
An array of ProjectArtifacts objects.
An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch build project.
An array of ProjectArtifacts objects.
An array of ProjectArtifact objects.
Information about the build badge for the build project.
', 'refs' => [ 'Project$badge' => 'Information about the build badge for the build project.
', ], ], 'ProjectBuildBatchConfig' => [ 'base' => 'Contains configuration information about a batch build project.
', 'refs' => [ 'BuildBatch$buildBatchConfig' => NULL, 'CreateProjectInput$buildBatchConfig' => 'A ProjectBuildBatchConfig object that defines the batch build options for the project.
', 'Project$buildBatchConfig' => 'A ProjectBuildBatchConfig object that defines the batch build options for the project.
', 'StartBuildBatchInput$buildBatchConfigOverride' => 'A BuildBatchConfigOverride object that contains batch build configuration overrides.
Information about the cache for the build project.
', 'refs' => [ 'Build$cache' => 'Information about the cache for the build.
', 'BuildBatch$cache' => NULL, 'CreateProjectInput$cache' => 'Stores recently used information so that it can be quickly accessed at a later time.
', 'Project$cache' => 'Information about the cache for the build project.
', 'StartBuildBatchInput$cacheOverride' => 'A ProjectCache object that specifies cache overrides.
A ProjectCache object specified for this build that overrides the one defined in the build project.
', 'UpdateProjectInput$cache' => 'Stores recently used information so that it can be quickly accessed at a later time.
', ], ], 'ProjectCacheModes' => [ 'base' => NULL, 'refs' => [ 'ProjectCache$modes' => 'An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for LOCAL cache types.
Possible values are:
Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.
Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.
You can use a Docker layer cache in the Linux environment only.
The privileged flag must be set so that your project has the required Docker permissions.
You should consider the security implications before you use a Docker layer cache.
Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:
Only directories can be specified for caching. You cannot specify individual files.
Symlinks are used to reference cached directories.
Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.
A description that makes the build project easy to identify.
', 'Project$description' => 'A description that makes the build project easy to identify.
', 'UpdateProjectInput$description' => 'A new or replacement description of the build project.
', ], ], 'ProjectEnvironment' => [ 'base' => 'Information about the build environment of the build project.
', 'refs' => [ 'Build$environment' => 'Information about the build environment for this build.
', 'BuildBatch$environment' => NULL, 'CreateProjectInput$environment' => 'Information about the build environment for the build project.
', 'Project$environment' => 'Information about the build environment for this build project.
', 'UpdateProjectInput$environment' => 'Information to be changed about the build environment for the build project.
', ], ], 'ProjectFileSystemLocation' => [ 'base' => 'Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?
', 'refs' => [ 'ProjectFileSystemLocations$member' => NULL, ], ], 'ProjectFileSystemLocations' => [ 'base' => NULL, 'refs' => [ 'Build$fileSystemLocations' => ' An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
An array of ProjectFileSystemLocation objects for the batch build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
Information about the compute fleet of the build project. For more information, see Working with reserved capacity in CodeBuild.
', 'refs' => [ 'ProjectEnvironment$fleet' => 'A ProjectFleet object to use for this build project.
', 'StartBuildInput$fleetOverride' => 'A ProjectFleet object specified for this build that overrides the one defined in the build project.
', ], ], 'ProjectName' => [ 'base' => NULL, 'refs' => [ 'CreateProjectInput$name' => 'The name of the build project.
', 'CreateWebhookInput$projectName' => 'The name of the CodeBuild project.
', 'DeleteWebhookInput$projectName' => 'The name of the CodeBuild project.
', 'Project$name' => 'The name of the build project.
', 'UpdateWebhookInput$projectName' => 'The name of the CodeBuild project.
', ], ], 'ProjectNames' => [ 'base' => NULL, 'refs' => [ 'BatchGetProjectsInput$names' => 'The names or ARNs of the build projects. To get information about a project shared with your Amazon Web Services account, its ARN must be specified. You cannot specify a shared project using its name.
', 'BatchGetProjectsOutput$projectsNotFound' => 'The names of build projects for which information could not be found.
', 'ListProjectsOutput$projects' => 'The list of build project names, with each build project name representing a single build project.
', ], ], 'ProjectSecondarySourceVersions' => [ 'base' => NULL, 'refs' => [ 'Build$secondarySourceVersions' => ' An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take precedence over these secondarySourceVersions (at the project level).
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
An array of ProjectSourceVersion objects that override the secondary source versions in the batch build project.
An array of ProjectSourceVersion objects that specify one or more versions of the project\'s secondary sources to be used for this build only.
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
The criterion to be used to list build project names. Valid values include:
CREATED_TIME: List based on when each build project was created.
LAST_MODIFIED_TIME: List based on when information about each build project was last changed.
NAME: List based on each build project\'s name.
Use sortOrder to specify in what order to list the build project names based on the preceding criteria.
Information about the build input source code for the build project.
', 'refs' => [ 'Build$source' => 'Information about the source code to be built.
', 'BuildBatch$source' => NULL, 'CreateProjectInput$source' => 'Information about the build input source code for the build project.
', 'Project$source' => 'Information about the build input source code for this build project.
', 'ProjectSources$member' => NULL, 'UpdateProjectInput$source' => 'Information to be changed about the build input source code for the build project.
', ], ], 'ProjectSourceVersion' => [ 'base' => 'A source identifier and its corresponding version.
', 'refs' => [ 'ProjectSecondarySourceVersions$member' => NULL, ], ], 'ProjectSources' => [ 'base' => NULL, 'refs' => [ 'Build$secondarySources' => ' An array of ProjectSource objects.
An array of ProjectSource objects that define the sources for the batch build.
An array of ProjectSource objects.
An array of ProjectSource objects.
An array of ProjectSource objects that override the secondary sources defined in the batch build project.
An array of ProjectSource objects.
An array of ProjectSource objects.
Specifies the visibility of the project\'s builds. Possible values are:
The project builds are visible to the public.
The project builds are not visible to the public.
Information about the requested build projects.
', ], ], 'PutResourcePolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'PutResourcePolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'RegistryCredential' => [ 'base' => 'Information about credentials that provide access to a private Docker registry. When this is set:
imagePullCredentialsType must be set to SERVICE_ROLE.
images cannot be curated or an Amazon ECR image.
For more information, see Private Registry with Secrets Manager Sample for CodeBuild.
', 'refs' => [ 'ProjectEnvironment$registryCredential' => 'The credentials for access to a private registry.
', 'StartBuildBatchInput$registryCredentialOverride' => 'A RegistryCredential object that overrides credentials for access to a private registry.
The credentials for access to a private registry.
', ], ], 'Report' => [ 'base' => 'Information about the results from running a series of test cases during the run of a build project. The test cases are specified in the buildspec for the build project using one or more paths to the test case files. You can specify any type of tests you want, such as unit tests, integration tests, and functional tests.
', 'refs' => [ 'Reports$member' => NULL, ], ], 'ReportArns' => [ 'base' => NULL, 'refs' => [ 'BatchGetReportsInput$reportArns' => ' An array of ARNs that identify the Report objects to return.
An array of ARNs passed to BatchGetReportGroups that are not associated with a Report.
The list of report ARNs.
', 'ListReportsOutput$reports' => 'The list of returned ARNs for the reports in the current Amazon Web Services account.
', ], ], 'ReportCodeCoverageSortByType' => [ 'base' => NULL, 'refs' => [ 'DescribeCodeCoveragesInput$sortBy' => 'Specifies how the results are sorted. Possible values are:
The results are sorted by file path.
The results are sorted by the percentage of lines that are covered.
Information about the location where the run of a report is exported.
', 'refs' => [ 'CreateReportGroupInput$exportConfig' => ' A ReportExportConfig object that contains information about where the report group test results are exported.
Information about where the raw data used to generate this report was exported.
', 'ReportGroup$exportConfig' => 'Information about the destination where the raw data of this ReportGroup is exported.
Used to specify an updated export type. Valid values are:
S3: The report results are exported to an S3 bucket.
NO_EXPORT: The report results are not exported.
The export configuration type. Valid values are:
S3: The report results are exported to an S3 bucket.
NO_EXPORT: The report results are not exported.
A filter used to return reports with the status specified by the input status parameter.
A ReportFilter object used to filter the returned reports.
A ReportFilter object used to filter the returned reports.
A series of reports. Each report contains information about the results from running a series of test cases. You specify the test cases for a report group in the buildspec for a build project using one or more paths to the test case files.
', 'refs' => [ 'CreateReportGroupOutput$reportGroup' => 'Information about the report group that was created.
', 'ReportGroups$member' => NULL, 'UpdateReportGroupOutput$reportGroup' => 'Information about the updated report group.
', ], ], 'ReportGroupArns' => [ 'base' => NULL, 'refs' => [ 'BatchGetReportGroupsInput$reportGroupArns' => 'An array of report group ARNs that identify the report groups to return.
', 'BatchGetReportGroupsOutput$reportGroupsNotFound' => ' An array of ARNs passed to BatchGetReportGroups that are not associated with a ReportGroup.
The list of ARNs for the report groups in the current Amazon Web Services account.
', 'ListSharedReportGroupsOutput$reportGroups' => 'The list of ARNs for the report groups shared with the current Amazon Web Services account or user.
', ], ], 'ReportGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateReportGroupInput$name' => 'The name of the report group.
', 'ReportGroup$name' => 'The name of the ReportGroup.
The criterion to be used to list build report groups. Valid values include:
CREATED_TIME: List based on when each report group was created.
LAST_MODIFIED_TIME: List based on when each report group was last changed.
NAME: List based on each report group\'s name.
The status of the report group. This property is read-only.
This can be one of the following values:
The report group is active.
The report group is in the process of being deleted.
The test report value to accumulate. This must be one of the following values:
Accumulate the test run times for the specified reports.
Accumulate the percentage of tests that passed for the specified test reports.
Accumulate the total number of tests for the specified test reports.
Accumulate the branch coverage percentages for the specified test reports.
Accumulate the branches covered values for the specified test reports.
Accumulate the branches missed values for the specified test reports.
Accumulate the line coverage percentages for the specified test reports.
Accumulate the lines covered values for the specified test reports.
Accumulate the lines not covered values for the specified test reports.
An array that contains the raw data for each report.
', ], ], 'ReportGroupTrendStats' => [ 'base' => 'Contains trend statistics for a set of reports. The actual values depend on the type of trend being collected. For more information, see .
', 'refs' => [ 'GetReportGroupTrendOutput$stats' => 'Contains the accumulated trend data.
', ], ], 'ReportGroups' => [ 'base' => NULL, 'refs' => [ 'BatchGetReportGroupsOutput$reportGroups' => ' The array of report groups returned by BatchGetReportGroups.
The type of build output artifact to create. Valid values include:
NONE: CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified.
ZIP: CodeBuild creates a ZIP file with the raw data in the output bucket.
A map that contains the number of each type of status returned by the test results in this TestReportSummary.
The status of this report.
', 'ReportFilter$status' => 'The status used to filter reports. You can filter using one status only.
', ], ], 'ReportType' => [ 'base' => NULL, 'refs' => [ 'CreateReportGroupInput$type' => 'The type of report group.
', 'Report$type' => 'The type of the report that was run.
A code coverage report.
A test report.
The type of the ReportGroup. This can be one of the following values:
The report group contains code coverage reports.
The report group contains test reports.
Contains the unmodified data for the report. For more information, see .
', 'refs' => [ 'ReportGroupTrendRawDataList$member' => NULL, ], ], 'Reports' => [ 'base' => NULL, 'refs' => [ 'BatchGetReportsOutput$reports' => ' The array of Report objects returned by BatchGetReports.
Represents a resolved build artifact. A resolved artifact is an artifact that is built and deployed to the destination, such as Amazon S3.
', 'refs' => [ 'BuildSummary$primaryArtifact' => 'A ResolvedArtifact object that represents the primary build artifacts for the build group.
An array of ResolvedArtifact objects that represents the secondary build artifacts for the build group.
The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource with the same settings already exists.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'The specified Amazon Web Services resource cannot be found.
', 'refs' => [], ], 'RetryBuildBatchInput' => [ 'base' => NULL, 'refs' => [], ], 'RetryBuildBatchOutput' => [ 'base' => NULL, 'refs' => [], ], 'RetryBuildBatchType' => [ 'base' => NULL, 'refs' => [ 'RetryBuildBatchInput$retryType' => 'Specifies the type of retry to perform.
', ], ], 'RetryBuildInput' => [ 'base' => NULL, 'refs' => [], ], 'RetryBuildOutput' => [ 'base' => NULL, 'refs' => [], ], 'S3LogsConfig' => [ 'base' => 'Information about S3 logs for a build project.
', 'refs' => [ 'LogsConfig$s3Logs' => 'Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.
', 'LogsLocation$s3Logs' => 'Information about S3 logs for a build project.
', ], ], 'S3ReportExportConfig' => [ 'base' => 'Information about the S3 bucket where the raw data of a report are exported.
', 'refs' => [ 'ReportExportConfig$s3Destination' => ' A S3ReportExportConfig object that contains information about the S3 bucket where the run of a report is exported.
The scaling configuration input of a compute fleet.
', 'refs' => [ 'CreateFleetInput$scalingConfiguration' => 'The scaling configuration of the compute fleet.
', 'UpdateFleetInput$scalingConfiguration' => 'The scaling configuration of the compute fleet.
', ], ], 'ScalingConfigurationOutput' => [ 'base' => 'The scaling configuration output of a compute fleet.
', 'refs' => [ 'Fleet$scalingConfiguration' => 'The scaling configuration of the compute fleet.
', ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'VpcConfig$securityGroupIds' => 'A list of one or more security groups IDs in your Amazon VPC.
', ], ], 'SensitiveNonEmptyString' => [ 'base' => NULL, 'refs' => [ 'ImportSourceCredentialsInput$token' => ' For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is either the access token or the app password. For the authType CODECONNECTIONS, this is the connectionArn.
During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
', ], ], 'ServerType' => [ 'base' => NULL, 'refs' => [ 'ImportSourceCredentialsInput$serverType' => 'The source provider used for this project.
', 'SourceCredentialsInfo$serverType' => 'The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, GITLAB, GITLAB_SELF_MANAGED, or BITBUCKET.
', ], ], 'SharedResourceSortByType' => [ 'base' => NULL, 'refs' => [ 'ListSharedProjectsInput$sortBy' => 'The criterion to be used to list build projects shared with the current Amazon Web Services account or user. Valid values include:
ARN: List based on the ARN.
MODIFIED_TIME: List based on when information about the shared project was last changed.
The criterion to be used to list report groups shared with the current Amazon Web Services account or user. Valid values include:
ARN: List based on the ARN.
MODIFIED_TIME: List based on when information about the shared report group was last changed.
Specifies if the results are sorted in ascending or descending order.
', 'ListBuildBatchesForProjectInput$sortOrder' => 'Specifies the sort order of the returned items. Valid values include:
ASCENDING: List the batch build identifiers in ascending order by identifier.
DESCENDING: List the batch build identifiers in descending order by identifier.
Specifies the sort order of the returned items. Valid values include:
ASCENDING: List the batch build identifiers in ascending order by identifier.
DESCENDING: List the batch build identifiers in descending order by identifier.
The order to sort the results in. The results are sorted by build number, not the build identifier. If this is not specified, the results are sorted in descending order.
Valid values include:
ASCENDING: List the build identifiers in ascending order, by build number.
DESCENDING: List the build identifiers in descending order, by build number.
If the project has more than 100 builds, setting the sort order will result in an error.
', 'ListBuildsInput$sortOrder' => 'The order to list build IDs. Valid values include:
ASCENDING: List the build IDs in ascending order by build ID.
DESCENDING: List the build IDs in descending order by build ID.
The order in which to list compute fleets. Valid values include:
ASCENDING: List in ascending order.
DESCENDING: List in descending order.
Use sortBy to specify the criterion to be used to list compute fleet names.
The order in which to list build projects. Valid values include:
ASCENDING: List in ascending order.
DESCENDING: List in descending order.
Use sortBy to specify the criterion to be used to list build project names.
Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.
Use to specify whether the results are returned in ascending or descending order.
', 'ListReportsInput$sortOrder' => 'Specifies the sort order for the list of returned reports. Valid values are:
ASCENDING: return reports in chronological order based on their creation date.
DESCENDING: return reports in the reverse chronological order based on their creation date.
The order in which to list shared build projects. Valid values include:
ASCENDING: List in ascending order.
DESCENDING: List in descending order.
The order in which to list shared report groups. Valid values include:
ASCENDING: List in ascending order.
DESCENDING: List in descending order.
Information about the authorization settings for CodeBuild to access the source code to be built.
This information is for the CodeBuild console\'s use only. Your code should not get or set this information directly.
', 'refs' => [ 'ProjectSource$auth' => 'Information about the authorization settings for CodeBuild to access the source code to be built.
This information is for the CodeBuild console\'s use only. Your code should not get or set this information directly.
', 'StartBuildBatchInput$sourceAuthOverride' => 'A SourceAuth object that overrides the one defined in the batch build project. This override applies only if the build project\'s source is BitBucket or GitHub.
An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project\'s source is BitBucket, GitHub, GitLab, or GitLab Self Managed.
', ], ], 'SourceAuthType' => [ 'base' => NULL, 'refs' => [ 'SourceAuth$type' => 'The authorization type to use. Valid options are OAUTH or CODECONNECTIONS.
', ], ], 'SourceCredentialsInfo' => [ 'base' => 'Information about the credentials for a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository.
', 'refs' => [ 'SourceCredentialsInfos$member' => NULL, ], ], 'SourceCredentialsInfos' => [ 'base' => NULL, 'refs' => [ 'ListSourceCredentialsOutput$sourceCredentialsInfos' => ' A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials.
The type of repository that contains the source code to be built. Valid values include:
BITBUCKET: The source code is in a Bitbucket repository.
CODECOMMIT: The source code is in an CodeCommit repository.
CODEPIPELINE: The source code settings are specified in the source action of a pipeline in CodePipeline.
GITHUB: The source code is in a GitHub repository.
GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.
GITLAB: The source code is in a GitLab repository.
GITLAB_SELF_MANAGED: The source code is in a self-managed GitLab repository.
NO_SOURCE: The project does not have input source code.
S3: The source code is in an Amazon S3 bucket.
The source input type that overrides the source input defined in the batch build project.
', 'StartBuildInput$sourceTypeOverride' => 'A source input type, for this build, that overrides the source input defined in the build project.
', ], ], 'StartBuildBatchInput' => [ 'base' => NULL, 'refs' => [], ], 'StartBuildBatchOutput' => [ 'base' => NULL, 'refs' => [], ], 'StartBuildInput' => [ 'base' => NULL, 'refs' => [], ], 'StartBuildOutput' => [ 'base' => NULL, 'refs' => [], ], 'StatusType' => [ 'base' => NULL, 'refs' => [ 'Build$buildStatus' => 'The current status of the build. Valid values include:
FAILED: The build failed.
FAULT: The build faulted.
IN_PROGRESS: The build is still in progress.
STOPPED: The build stopped.
SUCCEEDED: The build succeeded.
TIMED_OUT: The build timed out.
The status of the batch build.
', 'BuildBatchFilter$status' => 'The status of the batch builds to retrieve. Only batch builds that have this status will be retrieved.
', 'BuildBatchPhase$phaseStatus' => 'The current status of the batch build phase. Valid values include:
The build phase failed.
The build phase faulted.
The build phase is still in progress.
The build phase stopped.
The build phase succeeded.
The build phase timed out.
The current status of the build phase. Valid values include:
The build phase failed.
The build phase faulted.
The build phase is still in progress.
The build phase stopped.
The build phase succeeded.
The build phase timed out.
The status of the build group.
The build group failed.
The build group faulted.
The build group is still in progress.
The build group stopped.
The build group succeeded.
The build group timed out.
The current build phase.
', 'Build$initiator' => 'The entity that started the build. Valid values include:
If CodePipeline started the build, the pipeline\'s name (for example, codepipeline/my-demo-pipeline).
If a user started the build, the user\'s name (for example, MyUserName).
If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
The ARN of the batch build that this build is a member of, if applicable.
', 'BuildArtifacts$location' => 'Information about the location of the build artifacts.
', 'BuildArtifacts$sha256sum' => 'The SHA-256 hash of the build artifact.
You can use this hash along with a checksum tool to confirm file integrity and authenticity.
This value is available only if the build project\'s packaging value is set to ZIP.
The MD5 hash of the build artifact.
You can use this hash along with a checksum tool to confirm file integrity and authenticity.
This value is available only if the build project\'s packaging value is set to ZIP.
An identifier for this artifact definition.
', 'BuildBatch$currentPhase' => 'The current phase of the batch build.
', 'BuildBatch$initiator' => 'The entity that started the batch build. Valid values include:
If CodePipeline started the build, the pipeline\'s name (for example, codepipeline/my-demo-pipeline).
If a user started the build, the user\'s name.
If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
Contains the identifier of the build group.
', 'BuildNotDeleted$statusCode' => 'Additional information about the build that could not be successfully deleted.
', 'BuildReportArns$member' => NULL, 'BuildStatusConfig$context' => 'Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
This parameter is used for the name parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.
This parameter is used for the context parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
This parameter is used for the url parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.
This parameter is used for the target_url parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
The batch build ARN.
', 'CloudWatchLogsConfig$groupName' => 'The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
', 'CloudWatchLogsConfig$streamName' => 'The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
', 'CreateProjectInput$sourceVersion' => 'A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For GitLab: the commit ID, branch, or Git tag to use.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
', 'CreateWebhookInput$branchFilter' => 'A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
The status code.
', 'DescribeCodeCoveragesInput$nextToken' => 'The nextToken value returned from a previous call to DescribeCodeCoverages. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
If there are more items to return, this contains a token that is passed to a subsequent call to DescribeCodeCoverages to retrieve the next set of items.
The ARN of the report for which test cases are returned.
', 'DescribeTestCasesInput$nextToken' => ' During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
The name of the Docker image.
', 'EnvironmentImage$description' => 'The description of the Docker image.
', 'EnvironmentVariable$value' => 'The value of the environment variable.
We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.
The value assigned to the exported environment variable.
', 'FleetStatus$message' => 'A message associated with the status of a compute fleet.
', 'ImageVersions$member' => NULL, 'ListBuildBatchesForProjectInput$nextToken' => 'The nextToken value returned from a previous call to ListBuildBatchesForProject. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
If there are more items to return, this contains a token that is passed to a subsequent call to ListBuildBatchesForProject to retrieve the next set of items.
The nextToken value returned from a previous call to ListBuildBatches. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
If there are more items to return, this contains a token that is passed to a subsequent call to ListBuildBatches to retrieve the next set of items.
During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
', 'ListBuildsForProjectOutput$nextToken' => 'If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.
', 'ListBuildsInput$nextToken' => 'During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
', 'ListBuildsOutput$nextToken' => 'If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.
', 'ListFleetsOutput$nextToken' => 'If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.
', 'ListProjectsOutput$nextToken' => 'If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.
', 'ListReportGroupsInput$nextToken' => ' During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
The ARN of the report group for which you want to return report ARNs.
', 'ListReportsForReportGroupInput$nextToken' => ' During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
The name of the CloudWatch Logs group for the build logs.
', 'LogsLocation$streamName' => 'The name of the CloudWatch Logs stream for the build logs.
', 'LogsLocation$deepLink' => 'The URL to an individual build log in CloudWatch Logs. The log stream is created during the PROVISIONING phase of a build and the deeplink will not be valid until it is created.
The URL to a build log in an S3 bucket.
', 'LogsLocation$cloudWatchLogsArn' => 'The ARN of the CloudWatch Logs stream for a build execution. Its format is arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}. The CloudWatch Logs stream is created during the PROVISIONING phase of a build and the ARN will not be valid until it is created. For more information, see Resources Defined by CloudWatch Logs.
The ARN of S3 logs for a build project. Its format is arn:${Partition}:s3:::${BucketName}/${ObjectName}. For more information, see Resources Defined by Amazon S3.
The status code for the context of the build phase.
', 'PhaseContext$message' => 'An explanation of the build phase\'s context. This might include a command ID and an exit code.
', 'Project$arn' => 'The Amazon Resource Name (ARN) of the build project.
', 'Project$sourceVersion' => 'A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For GitLab: the commit ID, branch, or Git tag to use.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
', 'ProjectArtifacts$location' => 'Information about the build output artifact location:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, this is the name of the output bucket.
Along with namespaceType and name, the pattern that CodeBuild uses to name and store the output artifact:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.
For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.
Along with path and namespaceType, the pattern that CodeBuild uses to name and store the output artifact:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.
For example:
If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
If path is empty, namespaceType is set to NONE, and name is set to "/", the output artifact is stored in the root of the output bucket.
If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "/", the output artifact is stored in MyArtifacts/<build-ID>.
An identifier for this artifact definition.
', 'ProjectBadge$badgeRequestUrl' => 'The publicly-accessible URL through which you can access the build badge for your project.
', 'ProjectCache$location' => 'Information about the cache location:
NO_CACHE or LOCAL: This value is ignored.
S3: This is the S3 bucket name/prefix.
The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the CodeBuild User Guide.
', 'ProjectFileSystemLocation$location' => 'A string that specifies the location of the file system created by Amazon EFS. Its format is efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory is my-efs-mount-directory, then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.
The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.
The location in the container where you mount the file system.
', 'ProjectFileSystemLocation$identifier' => 'The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the identifier in all capital letters to CODEBUILD_. For example, if you specify my_efs for identifier, a new environment variable is create named CODEBUILD_MY_EFS.
The identifier is used to mount your file system.
The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options.
Specifies the compute fleet ARN for the build project.
', 'ProjectSource$location' => 'Information about the location of the source code to be built. Valid values include:
For source code settings that are specified in the source action of a pipeline in CodePipeline, location should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline\'s source action instead of this value.
For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).
For source code in an Amazon S3 input bucket, one of the following.
The path to the ZIP file that contains the source code (for example, <bucket-name>/<path>/<object-name>.zip).
The path to the folder that contains the source code (for example, <bucket-name>/<path-to-source-code>/<folder>/).
For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitHub account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object\'s type value to OAUTH.
For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitLab account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections Authorize application page, choose Authorize. Then on the CodeConnections Create GitLab connection page, choose Connect to GitLab. (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to override the default connection and use this connection instead, set the auth object\'s type value to CODECONNECTIONS in the source object.
For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object\'s type value to OAUTH.
If you specify CODEPIPELINE for the Type property, don\'t specify this property. For all of the other types, you must specify Location.
The buildspec file declaration to use for the builds in this build project.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
', 'ProjectSourceVersion$sourceIdentifier' => 'An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
', 'ProjectSourceVersion$sourceVersion' => 'The source version for the corresponding source identifier. If specified, must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For GitLab: the commit ID, branch, or Git tag to use.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
', 'Report$name' => 'The name of the report that was run.
', 'Report$executionId' => 'The ARN of the build run that generated this report.
', 'ReportGroupTrendStats$average' => 'Contains the average of all values analyzed.
', 'ReportGroupTrendStats$max' => 'Contains the maximum value analyzed.
', 'ReportGroupTrendStats$min' => 'Contains the minimum value analyzed.
', 'ReportStatusCounts$key' => NULL, 'ReportWithRawData$data' => 'The value of the requested data field from the report.
', 'ResolvedArtifact$location' => 'The location of the artifact.
', 'ResolvedArtifact$identifier' => 'The identifier of the artifact.
', 'RetryBuildBatchInput$idempotencyToken' => 'A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuildBatch request. The token is included in the RetryBuildBatch request and is valid for five minutes. If you repeat the RetryBuildBatch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuild request. The token is included in the RetryBuild request and is valid for five minutes. If you repeat the RetryBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket, and your path prefix is build-log, then acceptable formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log.
The Amazon Web Services account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build.
', 'S3ReportExportConfig$path' => 'The path to the exported report\'s raw data results.
', 'SourceAuth$resource' => 'The resource value that applies to the specified authorization type.
', 'SourceCredentialsInfo$resource' => 'The connection ARN if your serverType type is GITLAB or GITLAB_SELF_MANAGED and your authType is CODECONNECTIONS.
', 'StartBuildBatchInput$sourceVersion' => 'The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:
The commit ID, branch, or Git tag to use.
The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
The version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
', 'StartBuildBatchInput$sourceLocationOverride' => 'A location that overrides, for this batch build, the source location defined in the batch build project.
', 'StartBuildBatchInput$buildspecOverride' => 'A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
The name of a certificate for this batch build that overrides the one specified in the batch build project.
', 'StartBuildBatchInput$idempotencyToken' => 'A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch request. The token is included in the StartBuildBatch request and is valid for five minutes. If you repeat the StartBuildBatch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:
The commit ID, branch, or Git tag to use.
The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
The commit ID, branch, or Git tag to use.
The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
The version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
', 'StartBuildInput$sourceLocationOverride' => 'A location that overrides, for this build, the source location for the one defined in the build project.
', 'StartBuildInput$buildspecOverride' => 'A buildspec file declaration that overrides the latest one defined in the build project, for this build only. The buildspec defined on the project is not changed.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.
The name of a certificate for this build that overrides the one specified in the build project.
', 'StartBuildInput$idempotencyToken' => 'A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
', 'TestCase$testRawDataPath' => 'The path to the raw data file that contains the test result.
', 'TestCase$prefix' => 'A string that is applied to a series of related test cases. CodeBuild generates the prefix. The prefix depends on the framework used to generate the tests.
', 'TestCase$name' => 'The name of the test case.
', 'TestCase$status' => ' The status returned by the test case after it was run. Valid statuses are SUCCEEDED, FAILED, ERROR, SKIPPED, and UNKNOWN.
A message associated with a test case. For example, an error message or stack trace.
', 'TestCaseFilter$status' => 'The status used to filter test cases. A TestCaseFilter can have one status. Valid values are:
SUCCEEDED
FAILED
ERROR
SKIPPED
UNKNOWN
A keyword that is used to filter on the name or the prefix of the test cases. Only test cases where the keyword is a substring of the name or the prefix will be returned.
A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For GitLab: the commit ID, branch, or Git tag to use.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
', 'UpdateWebhookInput$branchFilter' => 'A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
For a WebHookFilter that uses EVENT type, a comma-separated string that specifies one or more events. For example, the webhook filter PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED allows all push, pull request created, and pull request updated events to trigger a build.
For a WebHookFilter that uses any of the other filter types, a regular expression pattern. For example, a WebHookFilter that uses HEAD_REF for its type and the pattern ^refs/heads/ triggers a build when the head reference is a branch with a reference name refs/heads/branch-name.
A list of one or more subnet IDs in your Amazon VPC.
', ], ], 'Tag' => [ 'base' => 'A tag, consisting of a key and a value.
This tag is available for use by Amazon Web Services services that support tags in CodeBuild.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$tags' => 'A list of tag key and value pairs associated with this compute fleet.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
', 'CreateProjectInput$tags' => 'A list of tag key and value pairs associated with this build project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
', 'CreateReportGroupInput$tags' => 'A list of tag key and value pairs associated with this report group.
These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
', 'Fleet$tags' => 'A list of tag key and value pairs associated with this compute fleet.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
', 'Project$tags' => 'A list of tag key and value pairs associated with this build project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
', 'ReportGroup$tags' => 'A list of tag key and value pairs associated with this report group.
These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
', 'UpdateFleetInput$tags' => 'A list of tag key and value pairs associated with this compute fleet.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
', 'UpdateProjectInput$tags' => 'An updated list of tag key and value pairs associated with this build project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
', 'UpdateReportGroupInput$tags' => 'An updated list of tag key and value pairs associated with this report group.
These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
', ], ], 'TargetTrackingScalingConfiguration' => [ 'base' => 'Defines when a new instance is auto-scaled into the compute fleet.
', 'refs' => [ 'TargetTrackingScalingConfigurations$member' => NULL, ], ], 'TargetTrackingScalingConfigurations' => [ 'base' => NULL, 'refs' => [ 'ScalingConfigurationInput$targetTrackingScalingConfigs' => 'A list of TargetTrackingScalingConfiguration objects.
A list of TargetTrackingScalingConfiguration objects.
Information about a test case created using a framework such as NUnit or Cucumber. A test case might be a unit test or a configuration test.
', 'refs' => [ 'TestCases$member' => NULL, ], ], 'TestCaseFilter' => [ 'base' => 'A filter used to return specific types of test cases. In order to pass the filter, the report must meet all of the filter properties.
', 'refs' => [ 'DescribeTestCasesInput$filter' => ' A TestCaseFilter object used to filter the returned reports.
The returned list of test cases.
', ], ], 'TestReportSummary' => [ 'base' => 'Information about a test report.
', 'refs' => [ 'Report$testSummary' => ' A TestReportSummary object that contains information about this test report.
The number of minutes a build is allowed to be queued before it times out.
', 'Project$queuedTimeoutInMinutes' => 'The number of minutes a build is allowed to be queued before it times out.
', 'StartBuildBatchInput$queuedTimeoutInMinutesOverride' => 'The number of minutes a batch build is allowed to be queued before it times out.
', 'StartBuildInput$queuedTimeoutInMinutesOverride' => 'The number of minutes a build is allowed to be queued before it times out.
', 'UpdateProjectInput$queuedTimeoutInMinutes' => 'The number of minutes a build is allowed to be queued before it times out.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Build$startTime' => 'When the build process started, expressed in Unix time format.
', 'Build$endTime' => 'When the build process ended, expressed in Unix time format.
', 'BuildBatch$startTime' => 'The date and time that the batch build started.
', 'BuildBatch$endTime' => 'The date and time that the batch build ended.
', 'BuildBatchPhase$startTime' => 'When the batch build phase started, expressed in Unix time format.
', 'BuildBatchPhase$endTime' => 'When the batch build phase ended, expressed in Unix time format.
', 'BuildPhase$startTime' => 'When the build phase started, expressed in Unix time format.
', 'BuildPhase$endTime' => 'When the build phase ended, expressed in Unix time format.
', 'BuildSummary$requestedOn' => 'When the build was started, expressed in Unix time format.
', 'CodeCoverage$expired' => 'The date and time that the tests were run.
', 'Fleet$created' => 'The time at which the compute fleet was created.
', 'Fleet$lastModified' => 'The time at which the compute fleet was last modified.
', 'Project$created' => 'When the build project was created, expressed in Unix time format.
', 'Project$lastModified' => 'When the build project\'s settings were last modified, expressed in Unix time format.
', 'Report$created' => 'The date and time this report run occurred.
', 'Report$expired' => 'The date and time a report expires. A report expires 30 days after it is created. An expired report is not available to view in CodeBuild.
', 'ReportGroup$created' => 'The date and time this ReportGroup was created.
The date and time this ReportGroup was last modified.
The date and time a test case expires. A test case expires 30 days after it is created. An expired test case is not available to view in CodeBuild.
', 'Webhook$lastModifiedSecret' => 'A timestamp that indicates the last time a repository\'s secret token was modified.
', ], ], 'UpdateFleetInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFleetOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectVisibilityInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectVisibilityOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateReportGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateReportGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWebhookInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWebhookOutput' => [ 'base' => NULL, 'refs' => [], ], 'ValueInput' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => 'The tag\'s value.
', ], ], 'VpcConfig' => [ 'base' => 'Information about the VPC configuration that CodeBuild accesses.
', 'refs' => [ 'Build$vpcConfig' => 'If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
', 'BuildBatch$vpcConfig' => NULL, 'CreateFleetInput$vpcConfig' => NULL, 'CreateProjectInput$vpcConfig' => 'VpcConfig enables CodeBuild to access resources in an Amazon VPC.
If you\'re using compute fleets during project creation, do not provide vpcConfig.
Information about the VPC configuration that CodeBuild accesses.
', 'UpdateFleetInput$vpcConfig' => NULL, 'UpdateProjectInput$vpcConfig' => 'VpcConfig enables CodeBuild to access resources in an Amazon VPC.
', ], ], 'Webhook' => [ 'base' => 'Information about a webhook that connects repository events to a build project in CodeBuild.
', 'refs' => [ 'CreateWebhookOutput$webhook' => 'Information about a webhook that connects repository events to a build project in CodeBuild.
', 'Project$webhook' => 'Information about a webhook that connects repository events to a build project in CodeBuild.
', 'UpdateWebhookOutput$webhook' => 'Information about a repository\'s webhook that is associated with a project in CodeBuild.
', ], ], 'WebhookBuildType' => [ 'base' => NULL, 'refs' => [ 'CreateWebhookInput$buildType' => 'Specifies the type of build this webhook will trigger.
', 'UpdateWebhookInput$buildType' => 'Specifies the type of build this webhook will trigger.
', 'Webhook$buildType' => 'Specifies the type of build this webhook will trigger.
', ], ], 'WebhookFilter' => [ 'base' => 'A filter used to determine which webhooks trigger a build.
', 'refs' => [ 'FilterGroup$member' => NULL, ], ], 'WebhookFilterType' => [ 'base' => NULL, 'refs' => [ 'WebhookFilter$type' => ' 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.
If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.
', 'BuildArtifacts$encryptionDisabled' => 'Information that tells you if encryption for build artifacts is disabled.
', 'BuildBatch$debugSessionEnabled' => 'Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.
', 'CreateProjectInput$badgeEnabled' => 'Set this to true to generate a publicly accessible URL for your project\'s build badge.
', 'CreateWebhookInput$manualCreation' => '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.
Specifies if session debugging is enabled for this build.
', 'GitSubmodulesConfig$fetchSubmodules' => 'Set to true to fetch Git submodules for your CodeBuild build project.
', 'ImportSourceCredentialsInput$shouldOverwrite' => ' Set to false to prevent overwriting the repository source credentials. Set to true to overwrite the repository source credentials. The default value is true.
If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.
', 'ProjectArtifacts$encryptionDisabled' => 'Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown.
', 'ProjectBuildBatchConfig$combineArtifacts' => 'Specifies if the build artifacts for the batch build should be combined into a single artifact location.
', 'ProjectEnvironment$privilegedMode' => 'Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is false.
You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:
If the operating system\'s base image is Ubuntu Linux:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&
- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"
If the operating system\'s base image is Alpine Linux and the previous command does not work, add the -t argument to timeout:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&
- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"
Set to true to report the status of a build\'s start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
If your project\'s builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.
', 'ProjectSource$insecureSsl' => 'Enable this flag to ignore SSL warnings while connecting to the project source code.
', 'Report$truncated' => 'A boolean that specifies if this report run is truncated. The list of test cases is truncated after the maximum number of test cases is reached.
', 'S3LogsConfig$encryptionDisabled' => 'Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
', 'S3ReportExportConfig$encryptionDisabled' => 'A boolean value that specifies if the results of a report are encrypted.
', 'StartBuildBatchInput$insecureSslOverride' => 'Enable this flag to override the insecure SSL setting that is specified in the batch build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build\'s source is GitHub Enterprise.
', 'StartBuildBatchInput$reportBuildBatchStatusOverride' => 'Set to true to report to your source provider the status of a batch build\'s start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.
The status of a build triggered by a webhook is always reported to your source provider.
Enable this flag to override privileged mode in the batch build project.
', 'StartBuildBatchInput$debugSessionEnabled' => 'Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.
', 'StartBuildInput$insecureSslOverride' => 'Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build\'s source is GitHub Enterprise.
', 'StartBuildInput$reportBuildStatusOverride' => ' Set to true to report to your source provider the status of a build\'s start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
Enable this flag to override privileged mode in the build project.
', 'StartBuildInput$debugSessionEnabled' => 'Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.
', 'UpdateProjectInput$badgeEnabled' => 'Set this to true to generate a publicly accessible URL for your project\'s build badge.
', 'Webhook$manualCreation' => '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.
Used to indicate that the pattern determines which webhook events do not trigger a build. If true, then a webhook event that does not match the pattern triggers a build. If false, then a webhook event that matches the pattern triggers a build.
The value of metricType when to start scaling.
Specifies the maximum number of builds allowed.
', 'Build$timeoutInMinutes' => 'How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out this build if it does not get marked as completed.
', 'Build$queuedTimeoutInMinutes' => 'The number of minutes a build is allowed to be queued before it times out.
', 'BuildBatch$buildTimeoutInMinutes' => 'Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.
', 'BuildBatch$queuedTimeoutInMinutes' => 'Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.
', 'CreateProjectInput$concurrentBuildLimit' => 'The maximum number of concurrent builds that are allowed for this project.
New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
', 'Project$concurrentBuildLimit' => 'The maximum number of concurrent builds that are allowed for this project.
New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
', 'ProjectBuildBatchConfig$timeoutInMins' => 'Specifies the maximum amount of time, in minutes, that the batch build must be completed in.
', 'ReportStatusCounts$value' => NULL, 'TestReportSummary$total' => ' The number of test cases in this TestReportSummary. The total includes truncated test cases.
The maximum number of concurrent builds that are allowed for this project.
New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
To remove this limit, set this value to -1.
', ], ], 'WrapperLong' => [ 'base' => NULL, 'refs' => [ 'Build$buildNumber' => 'The number of the build. For each project, the buildNumber of its first build is 1. The buildNumber of each subsequent build is incremented by 1. If a build is deleted, the buildNumber of other builds does not change.
The number of the batch build. For each project, the buildBatchNumber of its first batch build is 1. The buildBatchNumber of each subsequent batch build is incremented by 1. If a batch build is deleted, the buildBatchNumber of other batch builds does not change.
How long, in seconds, between the starting and ending times of the batch build\'s phase.
', 'BuildPhase$durationInSeconds' => 'How long, in seconds, between the starting and ending times of the build\'s phase.
', 'TestCase$durationInNanoSeconds' => 'The number of nanoseconds it took to run this test case.
', 'TestReportSummary$durationInNanoSeconds' => 'The number of nanoseconds it took to run all of the test cases in this report.
', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild to use your own build tools. CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about CodeBuild, see the CodeBuild User Guide.
', 'operations' => [ 'BatchDeleteBuilds' => 'Deletes one or more builds.
', 'BatchGetBuildBatches' => 'Retrieves information about one or more batch builds.
', 'BatchGetBuilds' => 'Gets information about one or more builds.
', 'BatchGetFleets' => 'Gets information about one or more compute fleets.
', 'BatchGetProjects' => 'Gets information about one or more build projects.
', 'BatchGetReportGroups' => 'Returns an array of report groups.
', 'BatchGetReports' => 'Returns an array of reports.
', 'CreateFleet' => 'Creates a compute fleet.
', 'CreateProject' => 'Creates a build project.
', 'CreateReportGroup' => 'Creates a report group. A report group contains a collection of reports.
', 'CreateWebhook' => 'For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.
If you enable webhooks for an CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project\'s Settings.
Deletes a batch build.
', 'DeleteFleet' => 'Deletes a compute fleet. When you delete a compute fleet, its builds are not deleted.
', 'DeleteProject' => 'Deletes a build project. When you delete a project, its builds are not deleted.
', 'DeleteReport' => 'Deletes a report.
', 'DeleteReportGroup' => 'Deletes a report group. Before you delete a report group, you must delete its reports.
', 'DeleteResourcePolicy' => 'Deletes a resource policy that is identified by its resource ARN.
', 'DeleteSourceCredentials' => 'Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
', 'DeleteWebhook' => 'For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository.
', 'DescribeCodeCoverages' => 'Retrieves one or more code coverage reports.
', 'DescribeTestCases' => 'Returns a list of details about test cases for a report.
', 'GetReportGroupTrend' => 'Analyzes and accumulates test report values for the specified test reports.
', 'GetResourcePolicy' => 'Gets a resource policy that is identified by its resource ARN.
', 'ImportSourceCredentials' => 'Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
', 'InvalidateProjectCache' => 'Resets the cache for a project.
', 'ListBuildBatches' => 'Retrieves the identifiers of your build batches in the current region.
', 'ListBuildBatchesForProject' => 'Retrieves the identifiers of the build batches for a specific project.
', 'ListBuilds' => 'Gets a list of build IDs, with each build ID representing a single build.
', 'ListBuildsForProject' => 'Gets a list of build identifiers for the specified build project, with each build identifier representing a single build.
', 'ListCuratedEnvironmentImages' => 'Gets information about Docker images that are managed by CodeBuild.
', 'ListFleets' => 'Gets a list of compute fleet names with each compute fleet name representing a single compute fleet.
', 'ListProjects' => 'Gets a list of build project names, with each build project name representing a single build project.
', 'ListReportGroups' => 'Gets a list ARNs for the report groups in the current Amazon Web Services account.
', 'ListReports' => 'Returns a list of ARNs for the reports in the current Amazon Web Services account.
', 'ListReportsForReportGroup' => ' Returns a list of ARNs for the reports that belong to a ReportGroup.
Gets a list of projects that are shared with other Amazon Web Services accounts or users.
', 'ListSharedReportGroups' => 'Gets a list of report groups that are shared with other Amazon Web Services accounts or users.
', 'ListSourceCredentials' => ' Returns a list of SourceCredentialsInfo objects.
Stores a resource policy for the ARN of a Project or ReportGroup object.
Restarts a build.
', 'RetryBuildBatch' => 'Restarts a failed batch build. Only batch builds that have failed can be retried.
', 'StartBuild' => 'Starts running a build with the settings defined in the project. These setting include: how to run a build, where to get the source code, which build environment to use, which build commands to run, and where to store the build output.
You can also start a build run by overriding some of the build settings in the project. The overrides only apply for that specific start build request. The settings in the project are unaltered.
', 'StartBuildBatch' => 'Starts a batch build for a project.
', 'StopBuild' => 'Attempts to stop running a build.
', 'StopBuildBatch' => 'Stops a running batch build.
', 'UpdateFleet' => 'Updates a compute fleet.
', 'UpdateProject' => 'Changes the settings of a build project.
', 'UpdateProjectVisibility' => 'Changes the public visibility for a project. The project\'s build results, logs, and artifacts are available to the general public. For more information, see Public build projects in the CodeBuild User Guide.
The following should be kept in mind when making your projects public:
All of a project\'s build results, logs, and artifacts, including builds that were run when the project was private, are available to the general public.
All build logs and artifacts are available to the public. Environment variables, source code, and other sensitive information may have been output to the build logs and artifacts. You must be careful about what information is output to the build logs. Some best practice are:
Do not store sensitive values in environment variables. We recommend that you use an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store sensitive values.
Follow Best practices for using webhooks in the CodeBuild User Guide to limit which entities can trigger a build, and do not store the buildspec in the project itself, to ensure that your webhooks are as secure as possible.
A malicious user can use public builds to distribute malicious artifacts. We recommend that you review all pull requests to verify that the pull request is a legitimate change. We also recommend that you validate any artifacts with their checksums to make sure that the correct artifacts are being downloaded.
Updates a report group.
', 'UpdateWebhook' => 'Updates the webhook associated with an CodeBuild build project.
If you use Bitbucket for your repository, rotateSecret is ignored.
An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.
', 'refs' => [], ], 'ArtifactNamespace' => [ 'base' => NULL, 'refs' => [ 'ProjectArtifacts$namespaceType' => 'Along with path and name, the pattern that CodeBuild uses to determine the name and location to store the output artifact:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, valid values include:
BUILD_ID: Include the build ID in the location of the build output artifact.
NONE: Do not include the build ID. This is the default if namespaceType is not specified.
For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
The type of build output artifact to create:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, valid values include:
NONE: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.
ZIP: CodeBuild creates in the output bucket a ZIP file that contains the build output.
The type of build output artifact. Valid values include:
CODEPIPELINE: The build project has build output generated through CodePipeline.
The CODEPIPELINE type is not supported for secondaryArtifacts.
NO_ARTIFACTS: The build project does not produce any build output.
S3: The build project stores build output in Amazon S3.
Specifies the type of artifact.
', ], ], 'AuthType' => [ 'base' => NULL, 'refs' => [ 'ImportSourceCredentialsInput$authType' => 'The type of authentication used to connect to a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the CodeBuild console. Note that CODECONNECTIONS is only valid for GitLab and GitLab Self Managed.
', 'SourceCredentialsInfo$authType' => 'The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, PERSONAL_ACCESS_TOKEN, or CODECONNECTIONS.
', ], ], 'BatchDeleteBuildsInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchDeleteBuildsOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetBuildBatchesInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetBuildBatchesOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetBuildsInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetBuildsOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetFleetsInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetFleetsOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetProjectsInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetProjectsOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetReportGroupsInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetReportGroupsOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetReportsInput' => [ 'base' => NULL, 'refs' => [], ], 'BatchGetReportsOutput' => [ 'base' => NULL, 'refs' => [], ], 'BatchReportModeType' => [ 'base' => NULL, 'refs' => [ 'ProjectBuildBatchConfig$batchReportMode' => 'Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.
(Default) Aggregate all of the build statuses into a single status report.
Send a separate status report for each individual build.
Specifies restrictions for the batch build.
', 'refs' => [ 'ProjectBuildBatchConfig$restrictions' => 'A BatchRestrictions object that specifies the restrictions for the batch build.
Whether the build is complete. True if complete; otherwise, false.
', 'BuildBatch$complete' => 'Indicates if the batch build is complete.
', 'BuildGroup$ignoreFailure' => 'Specifies if failures in this build group can be ignored.
', 'DeleteReportGroupInput$deleteReports' => 'If true, deletes any reports that belong to a report group before deleting the report group.
If false, you must delete any reports in the report group. Use ListReportsForReportGroup to get the reports in a report group. Use DeleteReport to delete the reports. If you call DeleteReportGroup for a report group that contains one or more reports, an exception is thrown.
Set this to true to generate a publicly accessible URL for your project\'s build badge.
', 'UpdateWebhookInput$rotateSecret' => ' A boolean value that specifies whether the associated GitHub repository\'s secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.
Specifies the bucket owner\'s access for objects that another account uploads to their Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has access to these objects. This property allows you to give the bucket owner access to these objects.
To use this property, your CodeBuild service role must have the s3:PutBucketAcl permission. This permission allows CodeBuild to modify the access control list for the bucket.
This property can be one of the following values:
The bucket owner does not have access to the objects. This is the default.
The bucket owner has read-only access to the objects. The uploading account retains ownership of the objects.
The bucket owner has full access to the objects. Object ownership is determined by the following criteria:
If the bucket is configured with the Bucket owner preferred setting, the bucket owner owns the objects. The uploading account will have object access as specified by the bucket\'s policy.
Otherwise, the uploading account retains ownership of the objects.
For more information about Amazon S3 object ownership, see Controlling ownership of uploaded objects using S3 Object Ownership in the Amazon Simple Storage Service User Guide.
Information about a build.
', 'refs' => [ 'Builds$member' => NULL, 'RetryBuildOutput$build' => NULL, 'StartBuildOutput$build' => 'Information about the build to be run.
', 'StopBuildOutput$build' => 'Information about the build.
', ], ], 'BuildArtifacts' => [ 'base' => 'Information about build output artifacts.
', 'refs' => [ 'Build$artifacts' => 'Information about the output artifacts for the build.
', 'BuildArtifactsList$member' => NULL, 'BuildBatch$artifacts' => 'A BuildArtifacts object the defines the build artifacts for this batch build.
An array of ProjectArtifacts objects.
An array of BuildArtifacts objects the define the build artifacts for this batch build.
Contains information about a batch build.
', 'refs' => [ 'BuildBatches$member' => NULL, 'RetryBuildBatchOutput$buildBatch' => NULL, 'StartBuildBatchOutput$buildBatch' => 'A BuildBatch object that contains information about the batch build.
Specifies filters when retrieving batch builds.
', 'refs' => [ 'ListBuildBatchesForProjectInput$filter' => 'A BuildBatchFilter object that specifies the filters for the search.
A BuildBatchFilter object that specifies the filters for the search.
An array that contains the batch build identifiers to retrieve.
', 'BatchGetBuildBatchesOutput$buildBatchesNotFound' => 'An array that contains the identifiers of any batch builds that are not found.
', 'ListBuildBatchesForProjectOutput$ids' => 'An array of strings that contains the batch build identifiers.
', 'ListBuildBatchesOutput$ids' => 'An array of strings that contains the batch build identifiers.
', ], ], 'BuildBatchPhase' => [ 'base' => 'Contains information about a stage for a batch build.
', 'refs' => [ 'BuildBatchPhases$member' => NULL, ], ], 'BuildBatchPhaseType' => [ 'base' => NULL, 'refs' => [ 'BuildBatchPhase$phaseType' => 'The name of the batch build phase. Valid values include:
Build output artifacts are being combined and uploaded to the output location.
The batch build specification is being downloaded.
One or more of the builds failed.
The batch build is in progress.
The batch build was stopped.
The btach build has been submitted.
The batch build succeeded.
An array of BuildBatchPhase objects the specify the phases of the batch build.
An array of BuildBatch objects that represent the retrieved batch builds.
Contains information about a batch build build group. Build groups are used to combine builds that can run in parallel, while still being able to set dependencies on other build groups.
', 'refs' => [ 'BuildGroups$member' => NULL, ], ], 'BuildGroups' => [ 'base' => NULL, 'refs' => [ 'BuildBatch$buildGroups' => 'An array of BuildGroup objects that define the build groups for the batch build.
The IDs of the builds to delete.
', 'BatchDeleteBuildsOutput$buildsDeleted' => 'The IDs of the builds that were successfully deleted.
', 'BatchGetBuildsInput$ids' => 'The IDs of the builds.
', 'BatchGetBuildsOutput$buildsNotFound' => 'The IDs of builds for which information could not be found.
', 'DeleteBuildBatchOutput$buildsDeleted' => 'An array of strings that contain the identifiers of the builds that were deleted.
', 'ListBuildsForProjectOutput$ids' => 'A list of build identifiers for the specified build project, with each build ID representing a single build.
', 'ListBuildsOutput$ids' => 'A list of build IDs, with each build ID representing a single build.
', ], ], 'BuildNotDeleted' => [ 'base' => 'Information about a build that could not be successfully deleted.
', 'refs' => [ 'BuildsNotDeleted$member' => NULL, ], ], 'BuildPhase' => [ 'base' => 'Information about a stage for a build.
', 'refs' => [ 'BuildPhases$member' => NULL, ], ], 'BuildPhaseType' => [ 'base' => NULL, 'refs' => [ 'BuildPhase$phaseType' => 'The name of the build phase. Valid values include:
Core build activities typically occur in this build phase.
The build has been completed.
Source code is being downloaded in this build phase.
The build process is completing in this build phase.
Installation activities typically occur in this build phase.
Post-build activities typically occur in this build phase.
Pre-build activities typically occur in this build phase.
The build environment is being set up.
The build has been submitted and is queued behind other submitted builds.
The build has been submitted.
Build output artifacts are being uploaded to the output location.
Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
', ], ], 'BuildReportArns' => [ 'base' => NULL, 'refs' => [ 'Build$reportArns' => 'An array of the ARNs associated with this build\'s reports.
', ], ], 'BuildStatusConfig' => [ 'base' => 'Contains information that defines how the CodeBuild build project reports the build status to the source provider.
', 'refs' => [ 'ProjectSource$buildStatusConfig' => 'Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
An array of BuildSummary objects that contain summaries of previous build groups.
Contains summary information about a batch build group.
', 'refs' => [ 'BuildGroup$currentBuildSummary' => 'A BuildSummary object that contains a summary of the current build group.
How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.
', 'Project$timeoutInMinutes' => 'How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
', 'StartBuildBatchInput$buildTimeoutInMinutesOverride' => 'Overrides the build timeout specified in the batch build project.
', 'StartBuildInput$timeoutInMinutesOverride' => 'The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the latest setting already defined in the build project.
', 'UpdateProjectInput$timeoutInMinutes' => 'The replacement value in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.
', ], ], 'Builds' => [ 'base' => NULL, 'refs' => [ 'BatchGetBuildsOutput$builds' => 'Information about the requested builds.
', ], ], 'BuildsNotDeleted' => [ 'base' => NULL, 'refs' => [ 'BatchDeleteBuildsOutput$buildsNotDeleted' => 'Information about any builds that could not be successfully deleted.
', 'DeleteBuildBatchOutput$buildsNotDeleted' => 'An array of BuildNotDeleted objects that specify the builds that could not be deleted.
The type of cache used by the build project. Valid values include:
NO_CACHE: The build project does not use any cache.
S3: The build project reads and writes from and to S3.
LOCAL: The build project stores a cache locally on a build host that is only available to that build host.
Information about CloudWatch Logs for a build project.
', 'refs' => [ 'LogsConfig$cloudWatchLogs' => 'Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.
', 'LogsLocation$cloudWatchLogs' => 'Information about CloudWatch Logs for a build project.
', ], ], 'CodeCoverage' => [ 'base' => 'Contains code coverage report information.
Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.
Branch coverage determines if your tests cover every possible branch of a control structure, such as an if or case statement.
Contains a summary of a code coverage report.
Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.
Branch coverage determines if your tests cover every possible branch of a control structure, such as an if or case statement.
A CodeCoverageReportSummary object that contains a code coverage summary for this report.
An array of CodeCoverage objects that contain the results.
Information about the compute resources the compute fleet uses. Available values include:
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 3 GB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see Build environment compute types in the CodeBuild User Guide.
', 'Fleet$computeType' => 'Information about the compute resources the compute fleet uses. Available values include:
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 3 GB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see Build environment compute types in the CodeBuild User Guide.
', 'ProjectEnvironment$computeType' => 'Information about the compute resources the build project uses. Available values include:
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 3 GB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
If you\'re using compute fleets during project creation, computeType will be ignored.
For more information, see Build Environment Compute Types in the CodeBuild User Guide.
', 'StartBuildBatchInput$computeTypeOverride' => 'The name of a compute type for this batch build that overrides the one specified in the batch build project.
', 'StartBuildInput$computeTypeOverride' => 'The name of a compute type for this build that overrides the one specified in the build project.
', 'UpdateFleetInput$computeType' => 'Information about the compute resources the compute fleet uses. Available values include:
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
If you use BUILD_GENERAL1_SMALL:
For environment type LINUX_CONTAINER, you can use up to 3 GB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see Build environment compute types in the CodeBuild User Guide.
', ], ], 'ComputeTypesAllowed' => [ 'base' => NULL, 'refs' => [ 'BatchRestrictions$computeTypesAllowed' => 'An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the CodeBuild User Guide for these values.
', ], ], 'CreateFleetInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateFleetOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateReportGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateReportGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateWebhookInput' => [ 'base' => NULL, 'refs' => [], ], 'CreateWebhookOutput' => [ 'base' => NULL, 'refs' => [], ], 'CredentialProviderType' => [ 'base' => NULL, 'refs' => [ 'RegistryCredential$credentialProvider' => 'The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager.
', ], ], 'DebugSession' => [ 'base' => 'Contains information about the debug session for a build. For more information, see Viewing a running build in Session Manager.
', 'refs' => [ 'Build$debugSession' => 'Contains information about the debug session for this build.
', ], ], 'DeleteBuildBatchInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBuildBatchOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFleetInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteFleetOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteReportGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteReportGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteReportInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteReportOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSourceCredentialsInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSourceCredentialsOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWebhookInput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteWebhookOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCodeCoveragesInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCodeCoveragesOutput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTestCasesInput' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTestCasesOutput' => [ 'base' => NULL, 'refs' => [], ], 'EnvironmentImage' => [ 'base' => 'Information about a Docker image that is managed by CodeBuild.
', 'refs' => [ 'EnvironmentImages$member' => NULL, ], ], 'EnvironmentImages' => [ 'base' => NULL, 'refs' => [ 'EnvironmentLanguage$images' => 'The list of Docker images that are related by the specified programming language.
', ], ], 'EnvironmentLanguage' => [ 'base' => 'A set of Docker images that are related by programming language and are managed by CodeBuild.
', 'refs' => [ 'EnvironmentLanguages$member' => NULL, ], ], 'EnvironmentLanguages' => [ 'base' => NULL, 'refs' => [ 'EnvironmentPlatform$languages' => 'The list of programming languages that are available for the specified platform.
', ], ], 'EnvironmentPlatform' => [ 'base' => 'A set of Docker images that are related by platform and are managed by CodeBuild.
', 'refs' => [ 'EnvironmentPlatforms$member' => NULL, ], ], 'EnvironmentPlatforms' => [ 'base' => NULL, 'refs' => [ 'ListCuratedEnvironmentImagesOutput$platforms' => 'Information about supported platforms for Docker images that are managed by CodeBuild.
', ], ], 'EnvironmentType' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$environmentType' => 'The environment type of the compute fleet.
The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo).
The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).
The environment type WINDOWS_SERVER_2019_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland).
The environment type WINDOWS_SERVER_2022_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).
For more information, see Build environment compute types in the CodeBuild user guide.
', 'Fleet$environmentType' => 'The environment type of the compute fleet.
The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo).
The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).
The environment type WINDOWS_SERVER_2019_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland).
The environment type WINDOWS_SERVER_2022_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).
For more information, see Build environment compute types in the CodeBuild user guide.
', 'ProjectEnvironment$type' => 'The type of build environment to use for related builds.
The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).
The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).
The environment types ARM_LAMBDA_CONTAINER and LINUX_LAMBDA_CONTAINER are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), EU (Frankfurt), EU (Ireland), and South America (São Paulo).
The environment types WINDOWS_CONTAINER and WINDOWS_SERVER_2019_CONTAINER are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).
If you\'re using compute fleets during project creation, type will be ignored.
For more information, see Build environment compute types in the CodeBuild user guide.
', 'StartBuildBatchInput$environmentTypeOverride' => 'A container type for this batch build that overrides the one specified in the batch build project.
', 'StartBuildInput$environmentTypeOverride' => 'A container type for this build that overrides the one specified in the build project.
', 'UpdateFleetInput$environmentType' => 'The environment type of the compute fleet.
The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo).
The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).
The environment type WINDOWS_SERVER_2019_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland).
The environment type WINDOWS_SERVER_2022_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).
For more information, see Build environment compute types in the CodeBuild user guide.
', ], ], 'EnvironmentVariable' => [ 'base' => 'Information about an environment variable for a build project or a build.
', 'refs' => [ 'EnvironmentVariables$member' => NULL, ], ], 'EnvironmentVariableType' => [ 'base' => NULL, 'refs' => [ 'EnvironmentVariable$type' => 'The type of environment variable. Valid values include:
PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the value of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.
PLAINTEXT: An environment variable in plain text format. This is the default value.
SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the value of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.
A set of environment variables to make available to builds for this build project.
', 'StartBuildBatchInput$environmentVariablesOverride' => 'An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.
A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
', ], ], 'ExportedEnvironmentVariable' => [ 'base' => 'Contains information about an exported environment variable.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
During a build, the value of a variable is available starting with the install phase. It can be updated between the start of the install phase and the end of the post_build phase. After the post_build phase ends, the value of exported variables cannot change.
A list of exported environment variables for this build.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
', ], ], 'FileSystemType' => [ 'base' => NULL, 'refs' => [ 'ProjectFileSystemLocation$type' => ' The type of the file system. The one supported type is EFS.
An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.
For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.
An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must contain at least one EVENT WebhookFilter.
An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.
For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.
A set of dedicated instances for your build environment.
', 'refs' => [ 'CreateFleetOutput$fleet' => 'Information about the compute fleet
', 'Fleets$member' => NULL, 'UpdateFleetOutput$fleet' => 'A Fleet object.
The list of compute fleet names.
', ], ], 'FleetCapacity' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$baseCapacity' => 'The initial number of machines allocated to the fleet, which defines the number of builds that can run in parallel.
', 'Fleet$baseCapacity' => 'The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.
', 'ScalingConfigurationInput$maxCapacity' => 'The maximum number of instances in the fleet when auto-scaling.
', 'ScalingConfigurationOutput$maxCapacity' => 'The maximum number of instances in the fleet when auto-scaling.
', 'ScalingConfigurationOutput$desiredCapacity' => 'The desired number of instances in the fleet when auto-scaling.
', 'UpdateFleetInput$baseCapacity' => 'The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.
', ], ], 'FleetContextCode' => [ 'base' => NULL, 'refs' => [ 'FleetStatus$context' => 'Additional information about a compute fleet. Valid values include:
CREATE_FAILED: The compute fleet has failed to create.
UPDATE_FAILED: The compute fleet has failed to update.
The name of the compute fleet.
', 'Fleet$name' => 'The name of the compute fleet.
', ], ], 'FleetNames' => [ 'base' => NULL, 'refs' => [ 'BatchGetFleetsInput$names' => 'The names or ARNs of the compute fleets.
', 'BatchGetFleetsOutput$fleetsNotFound' => 'The names of compute fleets for which information could not be found.
', ], ], 'FleetOverflowBehavior' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$overflowBehavior' => 'The compute fleet overflow behavior.
For overflow behavior QUEUE, your overflow builds need to wait on the existing fleet instance to become available.
For overflow behavior ON_DEMAND, your overflow builds run on CodeBuild on-demand.
If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to Amazon Web Services services required to create a VPC network interface.
The compute fleet overflow behavior.
For overflow behavior QUEUE, your overflow builds need to wait on the existing fleet instance to become available.
For overflow behavior ON_DEMAND, your overflow builds run on CodeBuild on-demand.
If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to Amazon Web Services services required to create a VPC network interface.
The compute fleet overflow behavior.
For overflow behavior QUEUE, your overflow builds need to wait on the existing fleet instance to become available.
For overflow behavior ON_DEMAND, your overflow builds run on CodeBuild on-demand.
If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to Amazon Web Services services required to create a VPC network interface.
The metric type to determine auto-scaling.
', ], ], 'FleetScalingType' => [ 'base' => NULL, 'refs' => [ 'ScalingConfigurationInput$scalingType' => 'The scaling type for a compute fleet.
', 'ScalingConfigurationOutput$scalingType' => 'The scaling type for a compute fleet.
', ], ], 'FleetSortByType' => [ 'base' => NULL, 'refs' => [ 'ListFleetsInput$sortBy' => 'The criterion to be used to list compute fleet names. Valid values include:
CREATED_TIME: List based on when each compute fleet was created.
LAST_MODIFIED_TIME: List based on when information about each compute fleet was last changed.
NAME: List based on each compute fleet\'s name.
Use sortOrder to specify in what order to list the compute fleet names based on the preceding criteria.
The status of the compute fleet.
', 'refs' => [ 'Fleet$status' => 'The status of the compute fleet.
', ], ], 'FleetStatusCode' => [ 'base' => NULL, 'refs' => [ 'FleetStatus$statusCode' => 'The status code of the compute fleet. Valid values include:
CREATING: The compute fleet is being created.
UPDATING: The compute fleet is being updated.
ROTATING: The compute fleet is being rotated.
PENDING_DELETION: The compute fleet is pending deletion.
DELETING: The compute fleet is being deleted.
CREATE_FAILED: The compute fleet has failed to create.
UPDATE_ROLLBACK_FAILED: The compute fleet has failed to update and could not rollback to previous state.
ACTIVE: The compute fleet has succeeded and is active.
Information about the requested compute fleets.
', ], ], 'GetReportGroupTrendInput' => [ 'base' => NULL, 'refs' => [], ], 'GetReportGroupTrendOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'GitCloneDepth' => [ 'base' => NULL, 'refs' => [ 'ProjectSource$gitCloneDepth' => 'Information about the Git clone depth for the build project.
', 'StartBuildBatchInput$gitCloneDepthOverride' => 'The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build only, any previous depth of history defined in the batch build project.
', 'StartBuildInput$gitCloneDepthOverride' => 'The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.
', ], ], 'GitSubmodulesConfig' => [ 'base' => 'Information about the Git submodules configuration for an CodeBuild build project.
', 'refs' => [ 'ProjectSource$gitSubmodulesConfig' => 'Information about the Git submodules configuration for the build project.
', 'StartBuildBatchInput$gitSubmodulesConfigOverride' => 'A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.
Information about the Git submodules configuration for this build of an CodeBuild build project.
', ], ], 'Identifiers' => [ 'base' => NULL, 'refs' => [ 'BuildGroup$dependsOn' => 'An array of strings that contain the identifiers of the build groups that this build group depends on.
', ], ], 'ImagePullCredentialsType' => [ 'base' => NULL, 'refs' => [ 'ProjectEnvironment$imagePullCredentialsType' => 'The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal.
SERVICE_ROLE specifies that CodeBuild uses your build project\'s service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.
', 'StartBuildBatchInput$imagePullCredentialsTypeOverride' => 'The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild\'s service principal.
Specifies that CodeBuild uses your build project\'s service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.
The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild\'s service principal.
Specifies that CodeBuild uses your build project\'s service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.
A list of environment image versions.
', ], ], 'ImportSourceCredentialsInput' => [ 'base' => NULL, 'refs' => [], ], 'ImportSourceCredentialsOutput' => [ 'base' => NULL, 'refs' => [], ], 'InvalidInputException' => [ 'base' => 'The input value that was provided is not valid.
', 'refs' => [], ], 'InvalidateProjectCacheInput' => [ 'base' => NULL, 'refs' => [], ], 'InvalidateProjectCacheOutput' => [ 'base' => NULL, 'refs' => [], ], 'KeyInput' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => 'The tag\'s key.
', ], ], 'LanguageType' => [ 'base' => NULL, 'refs' => [ 'EnvironmentLanguage$language' => 'The programming language for the Docker images.
', ], ], 'ListBuildBatchesForProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'ListBuildBatchesForProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBuildBatchesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListBuildBatchesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBuildsForProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'ListBuildsForProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBuildsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListBuildsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListCuratedEnvironmentImagesInput' => [ 'base' => NULL, 'refs' => [], ], 'ListCuratedEnvironmentImagesOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListFleetsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListFleetsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListProjectsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListProjectsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListReportGroupsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListReportGroupsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListReportsForReportGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'ListReportsForReportGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListReportsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListReportsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListSharedProjectsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSharedProjectsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListSharedReportGroupsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSharedReportGroupsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListSourceCredentialsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListSourceCredentialsOutput' => [ 'base' => NULL, 'refs' => [], ], 'LogsConfig' => [ 'base' => 'Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both.
', 'refs' => [ 'BuildBatch$logConfig' => NULL, 'CreateProjectInput$logsConfig' => 'Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.
', 'Project$logsConfig' => 'Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.
', 'StartBuildBatchInput$logsConfigOverride' => 'A LogsConfig object that override the log settings defined in the batch build project.
Log settings for this build that override the log settings defined in the build project.
', 'UpdateProjectInput$logsConfig' => 'Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.
', ], ], 'LogsConfigStatusType' => [ 'base' => NULL, 'refs' => [ 'CloudWatchLogsConfig$status' => 'The current status of the logs in CloudWatch Logs for a build project. Valid values are:
ENABLED: CloudWatch Logs are enabled for this build project.
DISABLED: CloudWatch Logs are not enabled for this build project.
The current status of the S3 build logs. Valid values are:
ENABLED: S3 build logs are enabled for this build project.
DISABLED: S3 build logs are not enabled for this build project.
Information about build logs in CloudWatch Logs.
', 'refs' => [ 'Build$logs' => 'Information about the build\'s logs in CloudWatch Logs.
', ], ], 'NetworkInterface' => [ 'base' => 'Describes a network interface.
', 'refs' => [ 'Build$networkInterface' => 'Describes a network interface.
', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'Build$id' => 'The unique ID for the build.
', 'Build$arn' => 'The Amazon Resource Name (ARN) of the build.
', 'Build$sourceVersion' => 'Any version identifier for the version of the source code to be built. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
', 'Build$resolvedSourceVersion' => 'An identifier for the version of this build\'s source code.
For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For CodePipeline, the source revision provided by CodePipeline.
For Amazon S3, this does not apply.
The name of the CodeBuild project.
', 'Build$serviceRole' => 'The name of a service role used for this build.
', 'Build$encryptionKey' => 'The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK\'s alias (using the format alias/<alias-name>).
The identifier of the batch build.
', 'BuildBatch$arn' => 'The ARN of the batch build.
', 'BuildBatch$sourceVersion' => 'The identifier of the version of the source code to be built.
', 'BuildBatch$resolvedSourceVersion' => 'The identifier of the resolved version of this batch build\'s source code.
For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For CodePipeline, the source revision provided by CodePipeline.
For Amazon S3, this does not apply.
The name of the batch build project.
', 'BuildBatch$serviceRole' => 'The name of a service role used for builds in the batch.
', 'BuildBatch$encryptionKey' => 'The Key Management Service customer master key (CMK) to be used for encrypting the batch build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK\'s alias (using the format alias/<alias-name>).
The ID of the build that could not be successfully deleted.
', 'CodeCoverage$id' => 'The identifier of the code coverage report.
', 'CodeCoverage$reportARN' => 'The ARN of the report.
', 'CodeCoverage$filePath' => 'The path of the test report file.
', 'ComputeTypesAllowed$member' => NULL, 'CreateFleetInput$fleetServiceRole' => 'The service role associated with the compute fleet. For more information, see Allow a user to add a permission policy for a fleet service role in the CodeBuild User Guide.
', 'CreateProjectInput$serviceRole' => 'The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
', 'CreateProjectInput$encryptionKey' => 'The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK\'s alias (using the format alias/<alias-name>).
Contains the identifier of the Session Manager session used for the build. To work with the paused build, you open this session to examine, control, and resume the build.
', 'DeleteBuildBatchInput$id' => 'The identifier of the batch build to delete.
', 'DeleteFleetInput$arn' => 'The ARN of the compute fleet.
', 'DeleteProjectInput$name' => 'The name of the build project.
', 'DeleteReportGroupInput$arn' => 'The ARN of the report group to delete.
', 'DeleteReportInput$arn' => 'The ARN of the report to delete.
', 'DeleteResourcePolicyInput$resourceArn' => 'The ARN of the resource that is associated with the resource policy.
', 'DeleteSourceCredentialsInput$arn' => 'The Amazon Resource Name (ARN) of the token.
', 'DeleteSourceCredentialsOutput$arn' => 'The Amazon Resource Name (ARN) of the token.
', 'DescribeCodeCoveragesInput$reportArn' => 'The ARN of the report for which test cases are returned.
', 'EnvironmentVariable$name' => 'The name or key of the environment variable.
', 'ExportedEnvironmentVariable$name' => 'The name of the exported environment variable.
', 'Fleet$arn' => 'The ARN of the compute fleet.
', 'Fleet$id' => 'The ID of the compute fleet.
', 'Fleet$fleetServiceRole' => 'The service role associated with the compute fleet. For more information, see Allow a user to add a permission policy for a fleet service role in the CodeBuild User Guide.
', 'FleetArns$member' => NULL, 'FleetNames$member' => NULL, 'GetReportGroupTrendInput$reportGroupArn' => 'The ARN of the report group that contains the reports to analyze.
', 'GetResourcePolicyInput$resourceArn' => 'The ARN of the resource that is associated with the resource policy.
', 'GetResourcePolicyOutput$policy' => 'The resource policy for the resource identified by the input ARN parameter.
', 'Identifiers$member' => NULL, 'ImportSourceCredentialsInput$username' => ' The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.
The Amazon Resource Name (ARN) of the token.
', 'InvalidateProjectCacheInput$projectName' => 'The name of the CodeBuild build project that the cache is reset for.
', 'ListBuildBatchesForProjectInput$projectName' => 'The name of the project.
', 'ListBuildsForProjectInput$projectName' => 'The name of the CodeBuild project.
', 'ListProjectsInput$nextToken' => 'During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
', 'ListSharedProjectsInput$nextToken' => ' During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
The ID of the subnet.
', 'NetworkInterface$networkInterfaceId' => 'The ID of the network interface.
', 'Project$serviceRole' => 'The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
', 'Project$encryptionKey' => 'The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK\'s alias (using the format alias/<alias-name>). If you don\'t specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).
Contains the project identifier used with the public build APIs.
', 'Project$resourceAccessRole' => 'The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project\'s builds.
', 'ProjectArns$member' => NULL, 'ProjectBuildBatchConfig$serviceRole' => 'Specifies the service role ARN for the batch build project.
', 'ProjectEnvironment$image' => 'The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:
For an image tag: <registry>/<repository>:<tag>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be aws/codebuild/standard:4.0.
For an image digest: <registry>/<repository>@<digest>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use <registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
For more information, see Docker images provided by CodeBuild in the CodeBuild user guide.
', 'ProjectNames$member' => NULL, 'PutResourcePolicyInput$policy' => 'A JSON-formatted resource policy. For more information, see Sharing a Project and Sharing a Report Group in the CodeBuild User Guide.
', 'PutResourcePolicyInput$resourceArn' => ' The ARN of the Project or ReportGroup resource you want to associate with a resource policy.
The ARN of the Project or ReportGroup resource that is associated with a resource policy.
The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager.
The credential can use the name of the credentials only if they exist in your current Amazon Web Services Region.
The ARN of the report run.
', 'Report$reportGroupArn' => 'The ARN of the report group associated with this report.
', 'ReportArns$member' => NULL, 'ReportGroup$arn' => 'The ARN of the ReportGroup.
The ARN of the report.
', 'RetryBuildBatchInput$id' => 'Specifies the identifier of the batch build to restart.
', 'RetryBuildInput$id' => 'Specifies the identifier of the build to restart.
', 'S3ReportExportConfig$bucket' => 'The name of the S3 bucket where the raw data of a report are exported.
', 'S3ReportExportConfig$encryptionKey' => 'The encryption key for the report\'s encrypted raw data.
', 'SecurityGroupIds$member' => NULL, 'SourceCredentialsInfo$arn' => 'The Amazon Resource Name (ARN) of the token.
', 'StartBuildBatchInput$projectName' => 'The name of the project.
', 'StartBuildBatchInput$imageOverride' => 'The name of an image for this batch build that overrides the one specified in the batch build project.
', 'StartBuildBatchInput$serviceRoleOverride' => 'The name of a service role for this batch build that overrides the one specified in the batch build project.
', 'StartBuildBatchInput$encryptionKeyOverride' => 'The Key Management Service customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK\'s alias (using the format alias/<alias-name>).
The name of the CodeBuild build project to start running a build.
', 'StartBuildInput$imageOverride' => 'The name of an image for this build that overrides the one specified in the build project.
', 'StartBuildInput$serviceRoleOverride' => 'The name of a service role for this build that overrides the one specified in the build project.
', 'StartBuildInput$encryptionKeyOverride' => 'The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK\'s alias (using the format alias/<alias-name>).
The identifier of the batch build to stop.
', 'StopBuildInput$id' => 'The ID of the build.
', 'Subnets$member' => NULL, 'TestCase$reportArn' => 'The ARN of the report to which the test case belongs.
', 'UpdateFleetInput$arn' => 'The ARN of the compute fleet.
', 'UpdateFleetInput$fleetServiceRole' => 'The service role associated with the compute fleet. For more information, see Allow a user to add a permission policy for a fleet service role in the CodeBuild User Guide.
', 'UpdateProjectInput$name' => 'The name of the build project.
You cannot change a build project\'s name.
The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
', 'UpdateProjectInput$encryptionKey' => 'The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK\'s alias (using the format alias/<alias-name>).
The Amazon Resource Name (ARN) of the build project.
', 'UpdateProjectVisibilityInput$resourceAccessRole' => 'The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project\'s builds.
', 'UpdateProjectVisibilityOutput$projectArn' => 'The Amazon Resource Name (ARN) of the build project.
', 'UpdateProjectVisibilityOutput$publicProjectAlias' => 'Contains the project identifier used with the public build APIs.
', 'UpdateReportGroupInput$arn' => 'The ARN of the report group to update.
', 'VpcConfig$vpcId' => 'The ID of the Amazon VPC.
', 'Webhook$url' => 'The URL to the webhook.
', 'Webhook$payloadUrl' => 'The CodeBuild endpoint where webhook events are sent.
', 'Webhook$secret' => 'The secret token of the associated repository.
A Bitbucket webhook does not support secret.
The number of lines that are covered by your tests.
', 'CodeCoverage$linesMissed' => 'The number of lines that are not covered by your tests.
', 'CodeCoverage$branchesCovered' => 'The number of conditional branches that are covered by your tests.
', 'CodeCoverage$branchesMissed' => 'The number of conditional branches that are not covered by your tests.
', 'CodeCoverageReportSummary$linesCovered' => 'The number of lines that are covered by your tests.
', 'CodeCoverageReportSummary$linesMissed' => 'The number of lines that are not covered by your tests.
', 'CodeCoverageReportSummary$branchesCovered' => 'The number of conditional branches that are covered by your tests.
', 'CodeCoverageReportSummary$branchesMissed' => 'The number of conditional branches that are not covered by your tests.
', ], ], 'OAuthProviderException' => [ 'base' => 'There was a problem with the underlying OAuth provider.
', 'refs' => [], ], 'PageSize' => [ 'base' => NULL, 'refs' => [ 'DescribeCodeCoveragesInput$maxResults' => 'The maximum number of results to return.
', 'DescribeTestCasesInput$maxResults' => ' The maximum number of paginated test cases returned per response. Use nextToken to iterate pages in the list of returned TestCase objects. The default value is 100.
The number of reports to analyze. This operation always retrieves the most recent reports.
If this parameter is omitted, the most recent 100 reports are analyzed.
', 'ListBuildBatchesForProjectInput$maxResults' => 'The maximum number of results to return.
', 'ListBuildBatchesInput$maxResults' => 'The maximum number of results to return.
', 'ListFleetsInput$maxResults' => 'The maximum number of paginated compute fleets returned per response. Use nextToken to iterate pages in the list of returned compute fleets.
The maximum number of paginated report groups returned per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.
The maximum number of paginated reports in this report group returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.
The maximum number of paginated reports returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.
The maximum number of paginated shared build projects returned per response. Use nextToken to iterate pages in the list of returned Project objects. The default value is 100.
The maximum number of paginated shared report groups per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.
The percentage of lines that are covered by your tests.
', 'CodeCoverage$branchCoveragePercentage' => 'The percentage of branches that are covered by your tests.
', 'CodeCoverageReportSummary$lineCoveragePercentage' => 'The percentage of lines that are covered by your tests.
', 'CodeCoverageReportSummary$branchCoveragePercentage' => 'The percentage of branches that are covered by your tests.
', 'DescribeCodeCoveragesInput$minLineCoveragePercentage' => 'The minimum line coverage percentage to report.
', 'DescribeCodeCoveragesInput$maxLineCoveragePercentage' => 'The maximum line coverage percentage to report.
', ], ], 'PhaseContext' => [ 'base' => 'Additional information about a build phase that has an error. You can use this information for troubleshooting.
', 'refs' => [ 'PhaseContexts$member' => NULL, ], ], 'PhaseContexts' => [ 'base' => NULL, 'refs' => [ 'BuildBatchPhase$contexts' => 'Additional information about the batch build phase. Especially to help troubleshoot a failed batch build.
', 'BuildPhase$contexts' => 'Additional information about a build phase, especially to help troubleshoot a failed build.
', ], ], 'PlatformType' => [ 'base' => NULL, 'refs' => [ 'EnvironmentPlatform$platform' => 'The platform\'s name.
', ], ], 'Project' => [ 'base' => 'Information about a build project.
', 'refs' => [ 'CreateProjectOutput$project' => 'Information about the build project that was created.
', 'Projects$member' => NULL, 'UpdateProjectOutput$project' => 'Information about the build project that was changed.
', ], ], 'ProjectArns' => [ 'base' => NULL, 'refs' => [ 'ListSharedProjectsOutput$projects' => 'The list of ARNs for the build projects shared with the current Amazon Web Services account or user.
', ], ], 'ProjectArtifacts' => [ 'base' => 'Information about the build output artifacts for the build project.
', 'refs' => [ 'CreateProjectInput$artifacts' => 'Information about the build output artifacts for the build project.
', 'Project$artifacts' => 'Information about the build output artifacts for the build project.
', 'ProjectArtifactsList$member' => NULL, 'StartBuildBatchInput$artifactsOverride' => 'An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.
Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
', 'UpdateProjectInput$artifacts' => 'Information to be changed about the build output artifacts for the build project.
', ], ], 'ProjectArtifactsList' => [ 'base' => NULL, 'refs' => [ 'CreateProjectInput$secondaryArtifacts' => 'An array of ProjectArtifacts objects.
An array of ProjectArtifacts objects.
An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch build project.
An array of ProjectArtifacts objects.
An array of ProjectArtifact objects.
Information about the build badge for the build project.
', 'refs' => [ 'Project$badge' => 'Information about the build badge for the build project.
', ], ], 'ProjectBuildBatchConfig' => [ 'base' => 'Contains configuration information about a batch build project.
', 'refs' => [ 'BuildBatch$buildBatchConfig' => NULL, 'CreateProjectInput$buildBatchConfig' => 'A ProjectBuildBatchConfig object that defines the batch build options for the project.
', 'Project$buildBatchConfig' => 'A ProjectBuildBatchConfig object that defines the batch build options for the project.
', 'StartBuildBatchInput$buildBatchConfigOverride' => 'A BuildBatchConfigOverride object that contains batch build configuration overrides.
Information about the cache for the build project.
', 'refs' => [ 'Build$cache' => 'Information about the cache for the build.
', 'BuildBatch$cache' => NULL, 'CreateProjectInput$cache' => 'Stores recently used information so that it can be quickly accessed at a later time.
', 'Project$cache' => 'Information about the cache for the build project.
', 'StartBuildBatchInput$cacheOverride' => 'A ProjectCache object that specifies cache overrides.
A ProjectCache object specified for this build that overrides the one defined in the build project.
', 'UpdateProjectInput$cache' => 'Stores recently used information so that it can be quickly accessed at a later time.
', ], ], 'ProjectCacheModes' => [ 'base' => NULL, 'refs' => [ 'ProjectCache$modes' => 'An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for LOCAL cache types.
Possible values are:
Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.
Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.
You can use a Docker layer cache in the Linux environment only.
The privileged flag must be set so that your project has the required Docker permissions.
You should consider the security implications before you use a Docker layer cache.
Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:
Only directories can be specified for caching. You cannot specify individual files.
Symlinks are used to reference cached directories.
Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.
A description that makes the build project easy to identify.
', 'Project$description' => 'A description that makes the build project easy to identify.
', 'UpdateProjectInput$description' => 'A new or replacement description of the build project.
', ], ], 'ProjectEnvironment' => [ 'base' => 'Information about the build environment of the build project.
', 'refs' => [ 'Build$environment' => 'Information about the build environment for this build.
', 'BuildBatch$environment' => NULL, 'CreateProjectInput$environment' => 'Information about the build environment for the build project.
', 'Project$environment' => 'Information about the build environment for this build project.
', 'UpdateProjectInput$environment' => 'Information to be changed about the build environment for the build project.
', ], ], 'ProjectFileSystemLocation' => [ 'base' => 'Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?
', 'refs' => [ 'ProjectFileSystemLocations$member' => NULL, ], ], 'ProjectFileSystemLocations' => [ 'base' => NULL, 'refs' => [ 'Build$fileSystemLocations' => ' An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
An array of ProjectFileSystemLocation objects for the batch build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
Information about the compute fleet of the build project. For more information, see Working with reserved capacity in CodeBuild.
', 'refs' => [ 'ProjectEnvironment$fleet' => 'A ProjectFleet object to use for this build project.
', 'StartBuildInput$fleetOverride' => 'A ProjectFleet object specified for this build that overrides the one defined in the build project.
', ], ], 'ProjectName' => [ 'base' => NULL, 'refs' => [ 'CreateProjectInput$name' => 'The name of the build project.
', 'CreateWebhookInput$projectName' => 'The name of the CodeBuild project.
', 'DeleteWebhookInput$projectName' => 'The name of the CodeBuild project.
', 'Project$name' => 'The name of the build project.
', 'UpdateWebhookInput$projectName' => 'The name of the CodeBuild project.
', ], ], 'ProjectNames' => [ 'base' => NULL, 'refs' => [ 'BatchGetProjectsInput$names' => 'The names or ARNs of the build projects. To get information about a project shared with your Amazon Web Services account, its ARN must be specified. You cannot specify a shared project using its name.
', 'BatchGetProjectsOutput$projectsNotFound' => 'The names of build projects for which information could not be found.
', 'ListProjectsOutput$projects' => 'The list of build project names, with each build project name representing a single build project.
', ], ], 'ProjectSecondarySourceVersions' => [ 'base' => NULL, 'refs' => [ 'Build$secondarySourceVersions' => ' An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take precedence over these secondarySourceVersions (at the project level).
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
An array of ProjectSourceVersion objects that override the secondary source versions in the batch build project.
An array of ProjectSourceVersion objects that specify one or more versions of the project\'s secondary sources to be used for this build only.
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
The criterion to be used to list build project names. Valid values include:
CREATED_TIME: List based on when each build project was created.
LAST_MODIFIED_TIME: List based on when information about each build project was last changed.
NAME: List based on each build project\'s name.
Use sortOrder to specify in what order to list the build project names based on the preceding criteria.
Information about the build input source code for the build project.
', 'refs' => [ 'Build$source' => 'Information about the source code to be built.
', 'BuildBatch$source' => NULL, 'CreateProjectInput$source' => 'Information about the build input source code for the build project.
', 'Project$source' => 'Information about the build input source code for this build project.
', 'ProjectSources$member' => NULL, 'UpdateProjectInput$source' => 'Information to be changed about the build input source code for the build project.
', ], ], 'ProjectSourceVersion' => [ 'base' => 'A source identifier and its corresponding version.
', 'refs' => [ 'ProjectSecondarySourceVersions$member' => NULL, ], ], 'ProjectSources' => [ 'base' => NULL, 'refs' => [ 'Build$secondarySources' => ' An array of ProjectSource objects.
An array of ProjectSource objects that define the sources for the batch build.
An array of ProjectSource objects.
An array of ProjectSource objects.
An array of ProjectSource objects that override the secondary sources defined in the batch build project.
An array of ProjectSource objects.
An array of ProjectSource objects.
Specifies the visibility of the project\'s builds. Possible values are:
The project builds are visible to the public.
The project builds are not visible to the public.
Information about the requested build projects.
', ], ], 'PutResourcePolicyInput' => [ 'base' => NULL, 'refs' => [], ], 'PutResourcePolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'RegistryCredential' => [ 'base' => 'Information about credentials that provide access to a private Docker registry. When this is set:
imagePullCredentialsType must be set to SERVICE_ROLE.
images cannot be curated or an Amazon ECR image.
For more information, see Private Registry with Secrets Manager Sample for CodeBuild.
', 'refs' => [ 'ProjectEnvironment$registryCredential' => 'The credentials for access to a private registry.
', 'StartBuildBatchInput$registryCredentialOverride' => 'A RegistryCredential object that overrides credentials for access to a private registry.
The credentials for access to a private registry.
', ], ], 'Report' => [ 'base' => 'Information about the results from running a series of test cases during the run of a build project. The test cases are specified in the buildspec for the build project using one or more paths to the test case files. You can specify any type of tests you want, such as unit tests, integration tests, and functional tests.
', 'refs' => [ 'Reports$member' => NULL, ], ], 'ReportArns' => [ 'base' => NULL, 'refs' => [ 'BatchGetReportsInput$reportArns' => ' An array of ARNs that identify the Report objects to return.
An array of ARNs passed to BatchGetReportGroups that are not associated with a Report.
The list of report ARNs.
', 'ListReportsOutput$reports' => 'The list of returned ARNs for the reports in the current Amazon Web Services account.
', ], ], 'ReportCodeCoverageSortByType' => [ 'base' => NULL, 'refs' => [ 'DescribeCodeCoveragesInput$sortBy' => 'Specifies how the results are sorted. Possible values are:
The results are sorted by file path.
The results are sorted by the percentage of lines that are covered.
Information about the location where the run of a report is exported.
', 'refs' => [ 'CreateReportGroupInput$exportConfig' => ' A ReportExportConfig object that contains information about where the report group test results are exported.
Information about where the raw data used to generate this report was exported.
', 'ReportGroup$exportConfig' => 'Information about the destination where the raw data of this ReportGroup is exported.
Used to specify an updated export type. Valid values are:
S3: The report results are exported to an S3 bucket.
NO_EXPORT: The report results are not exported.
The export configuration type. Valid values are:
S3: The report results are exported to an S3 bucket.
NO_EXPORT: The report results are not exported.
A filter used to return reports with the status specified by the input status parameter.
A ReportFilter object used to filter the returned reports.
A ReportFilter object used to filter the returned reports.
A series of reports. Each report contains information about the results from running a series of test cases. You specify the test cases for a report group in the buildspec for a build project using one or more paths to the test case files.
', 'refs' => [ 'CreateReportGroupOutput$reportGroup' => 'Information about the report group that was created.
', 'ReportGroups$member' => NULL, 'UpdateReportGroupOutput$reportGroup' => 'Information about the updated report group.
', ], ], 'ReportGroupArns' => [ 'base' => NULL, 'refs' => [ 'BatchGetReportGroupsInput$reportGroupArns' => 'An array of report group ARNs that identify the report groups to return.
', 'BatchGetReportGroupsOutput$reportGroupsNotFound' => ' An array of ARNs passed to BatchGetReportGroups that are not associated with a ReportGroup.
The list of ARNs for the report groups in the current Amazon Web Services account.
', 'ListSharedReportGroupsOutput$reportGroups' => 'The list of ARNs for the report groups shared with the current Amazon Web Services account or user.
', ], ], 'ReportGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateReportGroupInput$name' => 'The name of the report group.
', 'ReportGroup$name' => 'The name of the ReportGroup.
The criterion to be used to list build report groups. Valid values include:
CREATED_TIME: List based on when each report group was created.
LAST_MODIFIED_TIME: List based on when each report group was last changed.
NAME: List based on each report group\'s name.
The status of the report group. This property is read-only.
This can be one of the following values:
The report group is active.
The report group is in the process of being deleted.
The test report value to accumulate. This must be one of the following values:
Accumulate the test run times for the specified reports.
Accumulate the percentage of tests that passed for the specified test reports.
Accumulate the total number of tests for the specified test reports.
Accumulate the branch coverage percentages for the specified test reports.
Accumulate the branches covered values for the specified test reports.
Accumulate the branches missed values for the specified test reports.
Accumulate the line coverage percentages for the specified test reports.
Accumulate the lines covered values for the specified test reports.
Accumulate the lines not covered values for the specified test reports.
An array that contains the raw data for each report.
', ], ], 'ReportGroupTrendStats' => [ 'base' => 'Contains trend statistics for a set of reports. The actual values depend on the type of trend being collected. For more information, see .
', 'refs' => [ 'GetReportGroupTrendOutput$stats' => 'Contains the accumulated trend data.
', ], ], 'ReportGroups' => [ 'base' => NULL, 'refs' => [ 'BatchGetReportGroupsOutput$reportGroups' => ' The array of report groups returned by BatchGetReportGroups.
The type of build output artifact to create. Valid values include:
NONE: CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified.
ZIP: CodeBuild creates a ZIP file with the raw data in the output bucket.
A map that contains the number of each type of status returned by the test results in this TestReportSummary.
The status of this report.
', 'ReportFilter$status' => 'The status used to filter reports. You can filter using one status only.
', ], ], 'ReportType' => [ 'base' => NULL, 'refs' => [ 'CreateReportGroupInput$type' => 'The type of report group.
', 'Report$type' => 'The type of the report that was run.
A code coverage report.
A test report.
The type of the ReportGroup. This can be one of the following values:
The report group contains code coverage reports.
The report group contains test reports.
Contains the unmodified data for the report. For more information, see .
', 'refs' => [ 'ReportGroupTrendRawDataList$member' => NULL, ], ], 'Reports' => [ 'base' => NULL, 'refs' => [ 'BatchGetReportsOutput$reports' => ' The array of Report objects returned by BatchGetReports.
Represents a resolved build artifact. A resolved artifact is an artifact that is built and deployed to the destination, such as Amazon S3.
', 'refs' => [ 'BuildSummary$primaryArtifact' => 'A ResolvedArtifact object that represents the primary build artifacts for the build group.
An array of ResolvedArtifact objects that represents the secondary build artifacts for the build group.
The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource with the same settings already exists.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'The specified Amazon Web Services resource cannot be found.
', 'refs' => [], ], 'RetryBuildBatchInput' => [ 'base' => NULL, 'refs' => [], ], 'RetryBuildBatchOutput' => [ 'base' => NULL, 'refs' => [], ], 'RetryBuildBatchType' => [ 'base' => NULL, 'refs' => [ 'RetryBuildBatchInput$retryType' => 'Specifies the type of retry to perform.
', ], ], 'RetryBuildInput' => [ 'base' => NULL, 'refs' => [], ], 'RetryBuildOutput' => [ 'base' => NULL, 'refs' => [], ], 'S3LogsConfig' => [ 'base' => 'Information about S3 logs for a build project.
', 'refs' => [ 'LogsConfig$s3Logs' => 'Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.
', 'LogsLocation$s3Logs' => 'Information about S3 logs for a build project.
', ], ], 'S3ReportExportConfig' => [ 'base' => 'Information about the S3 bucket where the raw data of a report are exported.
', 'refs' => [ 'ReportExportConfig$s3Destination' => ' A S3ReportExportConfig object that contains information about the S3 bucket where the run of a report is exported.
The scaling configuration input of a compute fleet.
', 'refs' => [ 'CreateFleetInput$scalingConfiguration' => 'The scaling configuration of the compute fleet.
', 'UpdateFleetInput$scalingConfiguration' => 'The scaling configuration of the compute fleet.
', ], ], 'ScalingConfigurationOutput' => [ 'base' => 'The scaling configuration output of a compute fleet.
', 'refs' => [ 'Fleet$scalingConfiguration' => 'The scaling configuration of the compute fleet.
', ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'VpcConfig$securityGroupIds' => 'A list of one or more security groups IDs in your Amazon VPC.
', ], ], 'SensitiveNonEmptyString' => [ 'base' => NULL, 'refs' => [ 'ImportSourceCredentialsInput$token' => ' For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is either the access token or the app password. For the authType CODECONNECTIONS, this is the connectionArn.
During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
', ], ], 'ServerType' => [ 'base' => NULL, 'refs' => [ 'ImportSourceCredentialsInput$serverType' => 'The source provider used for this project.
', 'SourceCredentialsInfo$serverType' => 'The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, GITLAB, GITLAB_SELF_MANAGED, or BITBUCKET.
', ], ], 'SharedResourceSortByType' => [ 'base' => NULL, 'refs' => [ 'ListSharedProjectsInput$sortBy' => 'The criterion to be used to list build projects shared with the current Amazon Web Services account or user. Valid values include:
ARN: List based on the ARN.
MODIFIED_TIME: List based on when information about the shared project was last changed.
The criterion to be used to list report groups shared with the current Amazon Web Services account or user. Valid values include:
ARN: List based on the ARN.
MODIFIED_TIME: List based on when information about the shared report group was last changed.
Specifies if the results are sorted in ascending or descending order.
', 'ListBuildBatchesForProjectInput$sortOrder' => 'Specifies the sort order of the returned items. Valid values include:
ASCENDING: List the batch build identifiers in ascending order by identifier.
DESCENDING: List the batch build identifiers in descending order by identifier.
Specifies the sort order of the returned items. Valid values include:
ASCENDING: List the batch build identifiers in ascending order by identifier.
DESCENDING: List the batch build identifiers in descending order by identifier.
The order to sort the results in. The results are sorted by build number, not the build identifier. If this is not specified, the results are sorted in descending order.
Valid values include:
ASCENDING: List the build identifiers in ascending order, by build number.
DESCENDING: List the build identifiers in descending order, by build number.
If the project has more than 100 builds, setting the sort order will result in an error.
', 'ListBuildsInput$sortOrder' => 'The order to list build IDs. Valid values include:
ASCENDING: List the build IDs in ascending order by build ID.
DESCENDING: List the build IDs in descending order by build ID.
The order in which to list compute fleets. Valid values include:
ASCENDING: List in ascending order.
DESCENDING: List in descending order.
Use sortBy to specify the criterion to be used to list compute fleet names.
The order in which to list build projects. Valid values include:
ASCENDING: List in ascending order.
DESCENDING: List in descending order.
Use sortBy to specify the criterion to be used to list build project names.
Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.
Use to specify whether the results are returned in ascending or descending order.
', 'ListReportsInput$sortOrder' => 'Specifies the sort order for the list of returned reports. Valid values are:
ASCENDING: return reports in chronological order based on their creation date.
DESCENDING: return reports in the reverse chronological order based on their creation date.
The order in which to list shared build projects. Valid values include:
ASCENDING: List in ascending order.
DESCENDING: List in descending order.
The order in which to list shared report groups. Valid values include:
ASCENDING: List in ascending order.
DESCENDING: List in descending order.
Information about the authorization settings for CodeBuild to access the source code to be built.
This information is for the CodeBuild console\'s use only. Your code should not get or set this information directly.
', 'refs' => [ 'ProjectSource$auth' => 'Information about the authorization settings for CodeBuild to access the source code to be built.
This information is for the CodeBuild console\'s use only. Your code should not get or set this information directly.
', 'StartBuildBatchInput$sourceAuthOverride' => 'A SourceAuth object that overrides the one defined in the batch build project. This override applies only if the build project\'s source is BitBucket or GitHub.
An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project\'s source is BitBucket, GitHub, GitLab, or GitLab Self Managed.
', ], ], 'SourceAuthType' => [ 'base' => NULL, 'refs' => [ 'SourceAuth$type' => 'The authorization type to use. Valid options are OAUTH or CODECONNECTIONS.
', ], ], 'SourceCredentialsInfo' => [ 'base' => 'Information about the credentials for a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository.
', 'refs' => [ 'SourceCredentialsInfos$member' => NULL, ], ], 'SourceCredentialsInfos' => [ 'base' => NULL, 'refs' => [ 'ListSourceCredentialsOutput$sourceCredentialsInfos' => ' A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials.
The type of repository that contains the source code to be built. Valid values include:
BITBUCKET: The source code is in a Bitbucket repository.
CODECOMMIT: The source code is in an CodeCommit repository.
CODEPIPELINE: The source code settings are specified in the source action of a pipeline in CodePipeline.
GITHUB: The source code is in a GitHub repository.
GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.
GITLAB: The source code is in a GitLab repository.
GITLAB_SELF_MANAGED: The source code is in a self-managed GitLab repository.
NO_SOURCE: The project does not have input source code.
S3: The source code is in an Amazon S3 bucket.
The source input type that overrides the source input defined in the batch build project.
', 'StartBuildInput$sourceTypeOverride' => 'A source input type, for this build, that overrides the source input defined in the build project.
', ], ], 'StartBuildBatchInput' => [ 'base' => NULL, 'refs' => [], ], 'StartBuildBatchOutput' => [ 'base' => NULL, 'refs' => [], ], 'StartBuildInput' => [ 'base' => NULL, 'refs' => [], ], 'StartBuildOutput' => [ 'base' => NULL, 'refs' => [], ], 'StatusType' => [ 'base' => NULL, 'refs' => [ 'Build$buildStatus' => 'The current status of the build. Valid values include:
FAILED: The build failed.
FAULT: The build faulted.
IN_PROGRESS: The build is still in progress.
STOPPED: The build stopped.
SUCCEEDED: The build succeeded.
TIMED_OUT: The build timed out.
The status of the batch build.
', 'BuildBatchFilter$status' => 'The status of the batch builds to retrieve. Only batch builds that have this status will be retrieved.
', 'BuildBatchPhase$phaseStatus' => 'The current status of the batch build phase. Valid values include:
The build phase failed.
The build phase faulted.
The build phase is still in progress.
The build phase stopped.
The build phase succeeded.
The build phase timed out.
The current status of the build phase. Valid values include:
The build phase failed.
The build phase faulted.
The build phase is still in progress.
The build phase stopped.
The build phase succeeded.
The build phase timed out.
The status of the build group.
The build group failed.
The build group faulted.
The build group is still in progress.
The build group stopped.
The build group succeeded.
The build group timed out.
The current build phase.
', 'Build$initiator' => 'The entity that started the build. Valid values include:
If CodePipeline started the build, the pipeline\'s name (for example, codepipeline/my-demo-pipeline).
If a user started the build, the user\'s name (for example, MyUserName).
If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
The ARN of the batch build that this build is a member of, if applicable.
', 'BuildArtifacts$location' => 'Information about the location of the build artifacts.
', 'BuildArtifacts$sha256sum' => 'The SHA-256 hash of the build artifact.
You can use this hash along with a checksum tool to confirm file integrity and authenticity.
This value is available only if the build project\'s packaging value is set to ZIP.
The MD5 hash of the build artifact.
You can use this hash along with a checksum tool to confirm file integrity and authenticity.
This value is available only if the build project\'s packaging value is set to ZIP.
An identifier for this artifact definition.
', 'BuildBatch$currentPhase' => 'The current phase of the batch build.
', 'BuildBatch$initiator' => 'The entity that started the batch build. Valid values include:
If CodePipeline started the build, the pipeline\'s name (for example, codepipeline/my-demo-pipeline).
If a user started the build, the user\'s name.
If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
Contains the identifier of the build group.
', 'BuildNotDeleted$statusCode' => 'Additional information about the build that could not be successfully deleted.
', 'BuildReportArns$member' => NULL, 'BuildStatusConfig$context' => 'Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
This parameter is used for the name parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.
This parameter is used for the context parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
This parameter is used for the url parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.
This parameter is used for the target_url parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
The batch build ARN.
', 'CloudWatchLogsConfig$groupName' => 'The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
', 'CloudWatchLogsConfig$streamName' => 'The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
', 'CreateProjectInput$sourceVersion' => 'A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For GitLab: the commit ID, branch, or Git tag to use.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
', 'CreateWebhookInput$branchFilter' => 'A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
The status code.
', 'DescribeCodeCoveragesInput$nextToken' => 'The nextToken value returned from a previous call to DescribeCodeCoverages. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
If there are more items to return, this contains a token that is passed to a subsequent call to DescribeCodeCoverages to retrieve the next set of items.
The ARN of the report for which test cases are returned.
', 'DescribeTestCasesInput$nextToken' => ' During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
The name of the Docker image.
', 'EnvironmentImage$description' => 'The description of the Docker image.
', 'EnvironmentVariable$value' => 'The value of the environment variable.
We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.
The value assigned to the exported environment variable.
', 'FleetStatus$message' => 'A message associated with the status of a compute fleet.
', 'ImageVersions$member' => NULL, 'ListBuildBatchesForProjectInput$nextToken' => 'The nextToken value returned from a previous call to ListBuildBatchesForProject. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
If there are more items to return, this contains a token that is passed to a subsequent call to ListBuildBatchesForProject to retrieve the next set of items.
The nextToken value returned from a previous call to ListBuildBatches. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
If there are more items to return, this contains a token that is passed to a subsequent call to ListBuildBatches to retrieve the next set of items.
During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
', 'ListBuildsForProjectOutput$nextToken' => 'If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.
', 'ListBuildsInput$nextToken' => 'During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
', 'ListBuildsOutput$nextToken' => 'If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.
', 'ListFleetsOutput$nextToken' => 'If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.
', 'ListProjectsOutput$nextToken' => 'If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.
', 'ListReportGroupsInput$nextToken' => ' During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
The ARN of the report group for which you want to return report ARNs.
', 'ListReportsForReportGroupInput$nextToken' => ' During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
The name of the CloudWatch Logs group for the build logs.
', 'LogsLocation$streamName' => 'The name of the CloudWatch Logs stream for the build logs.
', 'LogsLocation$deepLink' => 'The URL to an individual build log in CloudWatch Logs. The log stream is created during the PROVISIONING phase of a build and the deeplink will not be valid until it is created.
The URL to a build log in an S3 bucket.
', 'LogsLocation$cloudWatchLogsArn' => 'The ARN of the CloudWatch Logs stream for a build execution. Its format is arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}. The CloudWatch Logs stream is created during the PROVISIONING phase of a build and the ARN will not be valid until it is created. For more information, see Resources Defined by CloudWatch Logs.
The ARN of S3 logs for a build project. Its format is arn:${Partition}:s3:::${BucketName}/${ObjectName}. For more information, see Resources Defined by Amazon S3.
The status code for the context of the build phase.
', 'PhaseContext$message' => 'An explanation of the build phase\'s context. This might include a command ID and an exit code.
', 'Project$arn' => 'The Amazon Resource Name (ARN) of the build project.
', 'Project$sourceVersion' => 'A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For GitLab: the commit ID, branch, or Git tag to use.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
', 'ProjectArtifacts$location' => 'Information about the build output artifact location:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, this is the name of the output bucket.
Along with namespaceType and name, the pattern that CodeBuild uses to name and store the output artifact:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.
For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.
Along with path and namespaceType, the pattern that CodeBuild uses to name and store the output artifact:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.
For example:
If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
If path is empty, namespaceType is set to NONE, and name is set to "/", the output artifact is stored in the root of the output bucket.
If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to "/", the output artifact is stored in MyArtifacts/<build-ID>.
An identifier for this artifact definition.
', 'ProjectBadge$badgeRequestUrl' => 'The publicly-accessible URL through which you can access the build badge for your project.
', 'ProjectCache$location' => 'Information about the cache location:
NO_CACHE or LOCAL: This value is ignored.
S3: This is the S3 bucket name/prefix.
The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the CodeBuild User Guide.
', 'ProjectFileSystemLocation$location' => 'A string that specifies the location of the file system created by Amazon EFS. Its format is efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory is my-efs-mount-directory, then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.
The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.
The location in the container where you mount the file system.
', 'ProjectFileSystemLocation$identifier' => 'The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the identifier in all capital letters to CODEBUILD_. For example, if you specify my_efs for identifier, a new environment variable is create named CODEBUILD_MY_EFS.
The identifier is used to mount your file system.
The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options.
Specifies the compute fleet ARN for the build project.
', 'ProjectSource$location' => 'Information about the location of the source code to be built. Valid values include:
For source code settings that are specified in the source action of a pipeline in CodePipeline, location should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline\'s source action instead of this value.
For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).
For source code in an Amazon S3 input bucket, one of the following.
The path to the ZIP file that contains the source code (for example, <bucket-name>/<path>/<object-name>.zip).
The path to the folder that contains the source code (for example, <bucket-name>/<path-to-source-code>/<folder>/).
For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitHub account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object\'s type value to OAUTH.
For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitLab account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections Authorize application page, choose Authorize. Then on the CodeConnections Create GitLab connection page, choose Connect to GitLab. (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to override the default connection and use this connection instead, set the auth object\'s type value to CODECONNECTIONS in the source object.
For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object\'s type value to OAUTH.
If you specify CODEPIPELINE for the Type property, don\'t specify this property. For all of the other types, you must specify Location.
The buildspec file declaration to use for the builds in this build project.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
', 'ProjectSourceVersion$sourceIdentifier' => 'An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
', 'ProjectSourceVersion$sourceVersion' => 'The source version for the corresponding source identifier. If specified, must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For GitLab: the commit ID, branch, or Git tag to use.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
', 'Report$name' => 'The name of the report that was run.
', 'Report$executionId' => 'The ARN of the build run that generated this report.
', 'ReportGroupTrendStats$average' => 'Contains the average of all values analyzed.
', 'ReportGroupTrendStats$max' => 'Contains the maximum value analyzed.
', 'ReportGroupTrendStats$min' => 'Contains the minimum value analyzed.
', 'ReportStatusCounts$key' => NULL, 'ReportWithRawData$data' => 'The value of the requested data field from the report.
', 'ResolvedArtifact$location' => 'The location of the artifact.
', 'ResolvedArtifact$identifier' => 'The identifier of the artifact.
', 'RetryBuildBatchInput$idempotencyToken' => 'A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuildBatch request. The token is included in the RetryBuildBatch request and is valid for five minutes. If you repeat the RetryBuildBatch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuild request. The token is included in the RetryBuild request and is valid for five minutes. If you repeat the RetryBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket, and your path prefix is build-log, then acceptable formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log.
The Amazon Web Services account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build.
', 'S3ReportExportConfig$path' => 'The path to the exported report\'s raw data results.
', 'SourceAuth$resource' => 'The resource value that applies to the specified authorization type.
', 'SourceCredentialsInfo$resource' => 'The connection ARN if your serverType type is GITLAB or GITLAB_SELF_MANAGED and your authType is CODECONNECTIONS.
', 'StartBuildBatchInput$sourceVersion' => 'The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:
The commit ID, branch, or Git tag to use.
The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
The version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
', 'StartBuildBatchInput$sourceLocationOverride' => 'A location that overrides, for this batch build, the source location defined in the batch build project.
', 'StartBuildBatchInput$buildspecOverride' => 'A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
The name of a certificate for this batch build that overrides the one specified in the batch build project.
', 'StartBuildBatchInput$idempotencyToken' => 'A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch request. The token is included in the StartBuildBatch request and is valid for five minutes. If you repeat the StartBuildBatch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:
The commit ID, branch, or Git tag to use.
The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
The commit ID, branch, or Git tag to use.
The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
The version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
', 'StartBuildInput$sourceLocationOverride' => 'A location that overrides, for this build, the source location for the one defined in the build project.
', 'StartBuildInput$buildspecOverride' => 'A buildspec file declaration that overrides the latest one defined in the build project, for this build only. The buildspec defined on the project is not changed.
If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.
The name of a certificate for this build that overrides the one specified in the build project.
', 'StartBuildInput$idempotencyToken' => 'A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
', 'TestCase$testRawDataPath' => 'The path to the raw data file that contains the test result.
', 'TestCase$prefix' => 'A string that is applied to a series of related test cases. CodeBuild generates the prefix. The prefix depends on the framework used to generate the tests.
', 'TestCase$name' => 'The name of the test case.
', 'TestCase$status' => ' The status returned by the test case after it was run. Valid statuses are SUCCEEDED, FAILED, ERROR, SKIPPED, and UNKNOWN.
A message associated with a test case. For example, an error message or stack trace.
', 'TestCaseFilter$status' => 'The status used to filter test cases. A TestCaseFilter can have one status. Valid values are:
SUCCEEDED
FAILED
ERROR
SKIPPED
UNKNOWN
A keyword that is used to filter on the name or the prefix of the test cases. Only test cases where the keyword is a substring of the name or the prefix will be returned.
A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For GitLab: the commit ID, branch, or Git tag to use.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch\'s HEAD commit ID is used. If not specified, the default branch\'s HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
', 'UpdateWebhookInput$branchFilter' => 'A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
For a WebHookFilter that uses EVENT type, a comma-separated string that specifies one or more events. For example, the webhook filter PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED allows all push, pull request created, and pull request updated events to trigger a build.
For a WebHookFilter that uses any of the other filter types, a regular expression pattern. For example, a WebHookFilter that uses HEAD_REF for its type and the pattern ^refs/heads/ triggers a build when the head reference is a branch with a reference name refs/heads/branch-name.
A list of one or more subnet IDs in your Amazon VPC.
', ], ], 'Tag' => [ 'base' => 'A tag, consisting of a key and a value.
This tag is available for use by Amazon Web Services services that support tags in CodeBuild.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreateFleetInput$tags' => 'A list of tag key and value pairs associated with this compute fleet.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
', 'CreateProjectInput$tags' => 'A list of tag key and value pairs associated with this build project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
', 'CreateReportGroupInput$tags' => 'A list of tag key and value pairs associated with this report group.
These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
', 'Fleet$tags' => 'A list of tag key and value pairs associated with this compute fleet.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
', 'Project$tags' => 'A list of tag key and value pairs associated with this build project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
', 'ReportGroup$tags' => 'A list of tag key and value pairs associated with this report group.
These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
', 'UpdateFleetInput$tags' => 'A list of tag key and value pairs associated with this compute fleet.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
', 'UpdateProjectInput$tags' => 'An updated list of tag key and value pairs associated with this build project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
', 'UpdateReportGroupInput$tags' => 'An updated list of tag key and value pairs associated with this report group.
These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
', ], ], 'TargetTrackingScalingConfiguration' => [ 'base' => 'Defines when a new instance is auto-scaled into the compute fleet.
', 'refs' => [ 'TargetTrackingScalingConfigurations$member' => NULL, ], ], 'TargetTrackingScalingConfigurations' => [ 'base' => NULL, 'refs' => [ 'ScalingConfigurationInput$targetTrackingScalingConfigs' => 'A list of TargetTrackingScalingConfiguration objects.
A list of TargetTrackingScalingConfiguration objects.
Information about a test case created using a framework such as NUnit or Cucumber. A test case might be a unit test or a configuration test.
', 'refs' => [ 'TestCases$member' => NULL, ], ], 'TestCaseFilter' => [ 'base' => 'A filter used to return specific types of test cases. In order to pass the filter, the report must meet all of the filter properties.
', 'refs' => [ 'DescribeTestCasesInput$filter' => ' A TestCaseFilter object used to filter the returned reports.
The returned list of test cases.
', ], ], 'TestReportSummary' => [ 'base' => 'Information about a test report.
', 'refs' => [ 'Report$testSummary' => ' A TestReportSummary object that contains information about this test report.
The number of minutes a build is allowed to be queued before it times out.
', 'Project$queuedTimeoutInMinutes' => 'The number of minutes a build is allowed to be queued before it times out.
', 'StartBuildBatchInput$queuedTimeoutInMinutesOverride' => 'The number of minutes a batch build is allowed to be queued before it times out.
', 'StartBuildInput$queuedTimeoutInMinutesOverride' => 'The number of minutes a build is allowed to be queued before it times out.
', 'UpdateProjectInput$queuedTimeoutInMinutes' => 'The number of minutes a build is allowed to be queued before it times out.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'Build$startTime' => 'When the build process started, expressed in Unix time format.
', 'Build$endTime' => 'When the build process ended, expressed in Unix time format.
', 'BuildBatch$startTime' => 'The date and time that the batch build started.
', 'BuildBatch$endTime' => 'The date and time that the batch build ended.
', 'BuildBatchPhase$startTime' => 'When the batch build phase started, expressed in Unix time format.
', 'BuildBatchPhase$endTime' => 'When the batch build phase ended, expressed in Unix time format.
', 'BuildPhase$startTime' => 'When the build phase started, expressed in Unix time format.
', 'BuildPhase$endTime' => 'When the build phase ended, expressed in Unix time format.
', 'BuildSummary$requestedOn' => 'When the build was started, expressed in Unix time format.
', 'CodeCoverage$expired' => 'The date and time that the tests were run.
', 'Fleet$created' => 'The time at which the compute fleet was created.
', 'Fleet$lastModified' => 'The time at which the compute fleet was last modified.
', 'Project$created' => 'When the build project was created, expressed in Unix time format.
', 'Project$lastModified' => 'When the build project\'s settings were last modified, expressed in Unix time format.
', 'Report$created' => 'The date and time this report run occurred.
', 'Report$expired' => 'The date and time a report expires. A report expires 30 days after it is created. An expired report is not available to view in CodeBuild.
', 'ReportGroup$created' => 'The date and time this ReportGroup was created.
The date and time this ReportGroup was last modified.
The date and time a test case expires. A test case expires 30 days after it is created. An expired test case is not available to view in CodeBuild.
', 'Webhook$lastModifiedSecret' => 'A timestamp that indicates the last time a repository\'s secret token was modified.
', ], ], 'UpdateFleetInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateFleetOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectVisibilityInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectVisibilityOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateReportGroupInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateReportGroupOutput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWebhookInput' => [ 'base' => NULL, 'refs' => [], ], 'UpdateWebhookOutput' => [ 'base' => NULL, 'refs' => [], ], 'ValueInput' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => 'The tag\'s value.
', ], ], 'VpcConfig' => [ 'base' => 'Information about the VPC configuration that CodeBuild accesses.
', 'refs' => [ 'Build$vpcConfig' => 'If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
', 'BuildBatch$vpcConfig' => NULL, 'CreateFleetInput$vpcConfig' => NULL, 'CreateProjectInput$vpcConfig' => 'VpcConfig enables CodeBuild to access resources in an Amazon VPC.
If you\'re using compute fleets during project creation, do not provide vpcConfig.
Information about the VPC configuration that CodeBuild accesses.
', 'UpdateFleetInput$vpcConfig' => NULL, 'UpdateProjectInput$vpcConfig' => 'VpcConfig enables CodeBuild to access resources in an Amazon VPC.
', ], ], 'Webhook' => [ 'base' => 'Information about a webhook that connects repository events to a build project in CodeBuild.
', 'refs' => [ 'CreateWebhookOutput$webhook' => 'Information about a webhook that connects repository events to a build project in CodeBuild.
', 'Project$webhook' => 'Information about a webhook that connects repository events to a build project in CodeBuild.
', 'UpdateWebhookOutput$webhook' => 'Information about a repository\'s webhook that is associated with a project in CodeBuild.
', ], ], 'WebhookBuildType' => [ 'base' => NULL, 'refs' => [ 'CreateWebhookInput$buildType' => 'Specifies the type of build this webhook will trigger.
', 'UpdateWebhookInput$buildType' => 'Specifies the type of build this webhook will trigger.
', 'Webhook$buildType' => 'Specifies the type of build this webhook will trigger.
', ], ], 'WebhookFilter' => [ 'base' => 'A filter used to determine which webhooks trigger a build.
', 'refs' => [ 'FilterGroup$member' => NULL, ], ], 'WebhookFilterType' => [ 'base' => NULL, 'refs' => [ 'WebhookFilter$type' => ' 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.
If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.
', 'BuildArtifacts$encryptionDisabled' => 'Information that tells you if encryption for build artifacts is disabled.
', 'BuildBatch$debugSessionEnabled' => 'Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.
', 'CreateProjectInput$badgeEnabled' => 'Set this to true to generate a publicly accessible URL for your project\'s build badge.
', 'CreateWebhookInput$manualCreation' => '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.
Specifies if session debugging is enabled for this build.
', 'GitSubmodulesConfig$fetchSubmodules' => 'Set to true to fetch Git submodules for your CodeBuild build project.
', 'ImportSourceCredentialsInput$shouldOverwrite' => ' Set to false to prevent overwriting the repository source credentials. Set to true to overwrite the repository source credentials. The default value is true.
If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.
', 'ProjectArtifacts$encryptionDisabled' => 'Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown.
', 'ProjectBuildBatchConfig$combineArtifacts' => 'Specifies if the build artifacts for the batch build should be combined into a single artifact location.
', 'ProjectEnvironment$privilegedMode' => 'Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is false.
You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:
If the operating system\'s base image is Ubuntu Linux:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&
- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"
If the operating system\'s base image is Alpine Linux and the previous command does not work, add the -t argument to timeout:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&
- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"
Set to true to report the status of a build\'s start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
If your project\'s builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.
', 'ProjectSource$insecureSsl' => 'Enable this flag to ignore SSL warnings while connecting to the project source code.
', 'Report$truncated' => 'A boolean that specifies if this report run is truncated. The list of test cases is truncated after the maximum number of test cases is reached.
', 'S3LogsConfig$encryptionDisabled' => 'Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
', 'S3ReportExportConfig$encryptionDisabled' => 'A boolean value that specifies if the results of a report are encrypted.
', 'StartBuildBatchInput$insecureSslOverride' => 'Enable this flag to override the insecure SSL setting that is specified in the batch build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build\'s source is GitHub Enterprise.
', 'StartBuildBatchInput$reportBuildBatchStatusOverride' => 'Set to true to report to your source provider the status of a batch build\'s start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.
The status of a build triggered by a webhook is always reported to your source provider.
Enable this flag to override privileged mode in the batch build project.
', 'StartBuildBatchInput$debugSessionEnabled' => 'Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.
', 'StartBuildInput$insecureSslOverride' => 'Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build\'s source is GitHub Enterprise.
', 'StartBuildInput$reportBuildStatusOverride' => ' Set to true to report to your source provider the status of a build\'s start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.
To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
Enable this flag to override privileged mode in the build project.
', 'StartBuildInput$debugSessionEnabled' => 'Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.
', 'UpdateProjectInput$badgeEnabled' => 'Set this to true to generate a publicly accessible URL for your project\'s build badge.
', 'Webhook$manualCreation' => '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.
Used to indicate that the pattern determines which webhook events do not trigger a build. If true, then a webhook event that does not match the pattern triggers a build. If false, then a webhook event that matches the pattern triggers a build.
The value of metricType when to start scaling.
Specifies the maximum number of builds allowed.
', 'Build$timeoutInMinutes' => 'How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out this build if it does not get marked as completed.
', 'Build$queuedTimeoutInMinutes' => 'The number of minutes a build is allowed to be queued before it times out.
', 'BuildBatch$buildTimeoutInMinutes' => 'Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.
', 'BuildBatch$queuedTimeoutInMinutes' => 'Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.
', 'CreateProjectInput$concurrentBuildLimit' => 'The maximum number of concurrent builds that are allowed for this project.
New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
', 'Project$concurrentBuildLimit' => 'The maximum number of concurrent builds that are allowed for this project.
New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
', 'ProjectBuildBatchConfig$timeoutInMins' => 'Specifies the maximum amount of time, in minutes, that the batch build must be completed in.
', 'ReportStatusCounts$value' => NULL, 'TestReportSummary$total' => ' The number of test cases in this TestReportSummary. The total includes truncated test cases.
The maximum number of concurrent builds that are allowed for this project.
New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
To remove this limit, set this value to -1.
', ], ], 'WrapperLong' => [ 'base' => NULL, 'refs' => [ 'Build$buildNumber' => 'The number of the build. For each project, the buildNumber of its first build is 1. The buildNumber of each subsequent build is incremented by 1. If a build is deleted, the buildNumber of other builds does not change.
The number of the batch build. For each project, the buildBatchNumber of its first batch build is 1. The buildBatchNumber of each subsequent batch build is incremented by 1. If a batch build is deleted, the buildBatchNumber of other batch builds does not change.
How long, in seconds, between the starting and ending times of the batch build\'s phase.
', 'BuildPhase$durationInSeconds' => 'How long, in seconds, between the starting and ending times of the build\'s phase.
', 'TestCase$durationInNanoSeconds' => 'The number of nanoseconds it took to run this test case.
', 'TestReportSummary$durationInNanoSeconds' => 'The number of nanoseconds it took to run all of the test cases in this report.
', ], ], ],]; diff --git a/src/data/codeguru-security/2018-05-10/api-2.json b/src/data/codeguru-security/2018-05-10/api-2.json index e096727977..9686b69f54 100644 --- a/src/data/codeguru-security/2018-05-10/api-2.json +++ b/src/data/codeguru-security/2018-05-10/api-2.json @@ -5,6 +5,7 @@ "endpointPrefix":"codeguru-security", "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"Amazon CodeGuru Security", "serviceId":"CodeGuru Security", "signatureVersion":"v4", @@ -125,6 +126,7 @@ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ] }, @@ -434,6 +436,10 @@ "INVALID_SCAN_NAME" ] }, + "ErrorMessage":{ + "type":"string", + "min":1 + }, "FilePath":{ "type":"structure", "members":{ @@ -541,7 +547,7 @@ "GetFindingsRequestMaxResultsInteger":{ "type":"integer", "box":true, - "max":100, + "max":1000, "min":1 }, "GetFindingsResponse":{ @@ -596,6 +602,7 @@ "members":{ "analysisType":{"shape":"AnalysisType"}, "createdAt":{"shape":"Timestamp"}, + "errorMessage":{"shape":"ErrorMessage"}, "numberOfRevisions":{"shape":"Long"}, "runId":{"shape":"Uuid"}, "scanName":{"shape":"ScanName"}, @@ -1058,7 +1065,11 @@ "members":{ "filePath":{"shape":"FilePath"}, "id":{"shape":"String"}, - "itemCount":{"shape":"Integer"}, + "itemCount":{ + "shape":"Integer", + "deprecated":true, + "deprecatedMessage":"This shape is not used." + }, "referenceUrls":{"shape":"ReferenceUrls"}, "relatedVulnerabilities":{"shape":"RelatedVulnerabilities"} } diff --git a/src/data/codeguru-security/2018-05-10/api-2.json.php b/src/data/codeguru-security/2018-05-10/api-2.json.php index 6cc84819dc..f4a3eb9a45 100644 --- a/src/data/codeguru-security/2018-05-10/api-2.json.php +++ b/src/data/codeguru-security/2018-05-10/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2018-05-10', 'endpointPrefix' => 'codeguru-security', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'serviceFullName' => 'Amazon CodeGuru Security', 'serviceId' => 'CodeGuru Security', 'signatureVersion' => 'v4', 'signingName' => 'codeguru-security', 'uid' => 'codeguru-security-2018-05-10', ], 'operations' => [ 'BatchGetFindings' => [ 'name' => 'BatchGetFindings', 'http' => [ 'method' => 'POST', 'requestUri' => '/batchGetFindings', 'responseCode' => 200, ], 'input' => [ 'shape' => 'BatchGetFindingsRequest', ], 'output' => [ 'shape' => 'BatchGetFindingsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateScan' => [ 'name' => 'CreateScan', 'http' => [ 'method' => 'POST', 'requestUri' => '/scans', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateScanRequest', ], 'output' => [ 'shape' => 'CreateScanResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateUploadUrl' => [ 'name' => 'CreateUploadUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/uploadUrl', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateUploadUrlRequest', ], 'output' => [ 'shape' => 'CreateUploadUrlResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetAccountConfiguration' => [ 'name' => 'GetAccountConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/accountConfiguration/get', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAccountConfigurationRequest', ], 'output' => [ 'shape' => 'GetAccountConfigurationResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetFindings' => [ 'name' => 'GetFindings', 'http' => [ 'method' => 'GET', 'requestUri' => '/findings/{scanName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetFindingsRequest', ], 'output' => [ 'shape' => 'GetFindingsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetMetricsSummary' => [ 'name' => 'GetMetricsSummary', 'http' => [ 'method' => 'GET', 'requestUri' => '/metrics/summary', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetMetricsSummaryRequest', ], 'output' => [ 'shape' => 'GetMetricsSummaryResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetScan' => [ 'name' => 'GetScan', 'http' => [ 'method' => 'GET', 'requestUri' => '/scans/{scanName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetScanRequest', ], 'output' => [ 'shape' => 'GetScanResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListFindingsMetrics' => [ 'name' => 'ListFindingsMetrics', 'http' => [ 'method' => 'GET', 'requestUri' => '/metrics/findings', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListFindingsMetricsRequest', ], 'output' => [ 'shape' => 'ListFindingsMetricsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListScans' => [ 'name' => 'ListScans', 'http' => [ 'method' => 'GET', 'requestUri' => '/scans', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListScansRequest', ], 'output' => [ 'shape' => 'ListScansResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'UpdateAccountConfiguration' => [ 'name' => 'UpdateAccountConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/updateAccountConfiguration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAccountConfigurationRequest', ], 'output' => [ 'shape' => 'UpdateAccountConfigurationResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'required' => [ 'errorCode', 'message', ], 'members' => [ 'errorCode' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'AccountFindingsMetric' => [ 'type' => 'structure', 'members' => [ 'closedFindings' => [ 'shape' => 'FindingMetricsValuePerSeverity', ], 'date' => [ 'shape' => 'Timestamp', ], 'meanTimeToClose' => [ 'shape' => 'FindingMetricsValuePerSeverity', ], 'newFindings' => [ 'shape' => 'FindingMetricsValuePerSeverity', ], 'openFindings' => [ 'shape' => 'FindingMetricsValuePerSeverity', ], ], ], 'AnalysisType' => [ 'type' => 'string', 'enum' => [ 'Security', 'All', ], ], 'BatchGetFindingsError' => [ 'type' => 'structure', 'required' => [ 'errorCode', 'findingId', 'message', 'scanName', ], 'members' => [ 'errorCode' => [ 'shape' => 'ErrorCode', ], 'findingId' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], 'scanName' => [ 'shape' => 'ScanName', ], ], ], 'BatchGetFindingsErrors' => [ 'type' => 'list', 'member' => [ 'shape' => 'BatchGetFindingsError', ], ], 'BatchGetFindingsRequest' => [ 'type' => 'structure', 'required' => [ 'findingIdentifiers', ], 'members' => [ 'findingIdentifiers' => [ 'shape' => 'FindingIdentifiers', ], ], ], 'BatchGetFindingsResponse' => [ 'type' => 'structure', 'required' => [ 'failedFindings', 'findings', ], 'members' => [ 'failedFindings' => [ 'shape' => 'BatchGetFindingsErrors', ], 'findings' => [ 'shape' => 'Findings', ], ], ], 'CategoriesWithMostFindings' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoryWithFindingNum', ], 'max' => 5, 'min' => 0, ], 'CategoryWithFindingNum' => [ 'type' => 'structure', 'members' => [ 'categoryName' => [ 'shape' => 'String', ], 'findingNumber' => [ 'shape' => 'Integer', ], ], ], 'ClientToken' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[\\S]+$', ], 'CodeLine' => [ 'type' => 'structure', 'members' => [ 'content' => [ 'shape' => 'String', ], 'number' => [ 'shape' => 'Integer', ], ], ], 'CodeSnippet' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeLine', ], ], 'ConflictException' => [ 'type' => 'structure', 'required' => [ 'errorCode', 'message', 'resourceId', 'resourceType', ], 'members' => [ 'errorCode' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 409, 'senderFault' => true, ], 'exception' => true, ], 'CreateScanRequest' => [ 'type' => 'structure', 'required' => [ 'resourceId', 'scanName', ], 'members' => [ 'analysisType' => [ 'shape' => 'AnalysisType', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'resourceId' => [ 'shape' => 'ResourceId', ], 'scanName' => [ 'shape' => 'ScanName', ], 'scanType' => [ 'shape' => 'ScanType', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateScanResponse' => [ 'type' => 'structure', 'required' => [ 'resourceId', 'runId', 'scanName', 'scanState', ], 'members' => [ 'resourceId' => [ 'shape' => 'ResourceId', ], 'runId' => [ 'shape' => 'Uuid', ], 'scanName' => [ 'shape' => 'ScanName', ], 'scanNameArn' => [ 'shape' => 'ScanNameArn', ], 'scanState' => [ 'shape' => 'ScanState', ], ], ], 'CreateUploadUrlRequest' => [ 'type' => 'structure', 'required' => [ 'scanName', ], 'members' => [ 'scanName' => [ 'shape' => 'ScanName', ], ], ], 'CreateUploadUrlResponse' => [ 'type' => 'structure', 'required' => [ 'codeArtifactId', 'requestHeaders', 's3Url', ], 'members' => [ 'codeArtifactId' => [ 'shape' => 'Uuid', ], 'requestHeaders' => [ 'shape' => 'RequestHeaderMap', ], 's3Url' => [ 'shape' => 'S3Url', ], ], ], 'DetectorTags' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Double' => [ 'type' => 'double', 'box' => true, ], 'EncryptionConfig' => [ 'type' => 'structure', 'members' => [ 'kmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], ], ], 'ErrorCode' => [ 'type' => 'string', 'enum' => [ 'DUPLICATE_IDENTIFIER', 'ITEM_DOES_NOT_EXIST', 'INTERNAL_ERROR', 'INVALID_FINDING_ID', 'INVALID_SCAN_NAME', ], ], 'FilePath' => [ 'type' => 'structure', 'members' => [ 'codeSnippet' => [ 'shape' => 'CodeSnippet', ], 'endLine' => [ 'shape' => 'Integer', ], 'name' => [ 'shape' => 'String', ], 'path' => [ 'shape' => 'String', ], 'startLine' => [ 'shape' => 'Integer', ], ], ], 'Finding' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'Timestamp', ], 'description' => [ 'shape' => 'String', ], 'detectorId' => [ 'shape' => 'String', ], 'detectorName' => [ 'shape' => 'String', ], 'detectorTags' => [ 'shape' => 'DetectorTags', ], 'generatorId' => [ 'shape' => 'String', ], 'id' => [ 'shape' => 'String', ], 'remediation' => [ 'shape' => 'Remediation', ], 'resource' => [ 'shape' => 'Resource', ], 'ruleId' => [ 'shape' => 'String', ], 'severity' => [ 'shape' => 'Severity', ], 'status' => [ 'shape' => 'Status', ], 'title' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'vulnerability' => [ 'shape' => 'Vulnerability', ], ], ], 'FindingIdentifier' => [ 'type' => 'structure', 'required' => [ 'findingId', 'scanName', ], 'members' => [ 'findingId' => [ 'shape' => 'String', ], 'scanName' => [ 'shape' => 'String', ], ], ], 'FindingIdentifiers' => [ 'type' => 'list', 'member' => [ 'shape' => 'FindingIdentifier', ], 'max' => 25, 'min' => 1, ], 'FindingMetricsValuePerSeverity' => [ 'type' => 'structure', 'members' => [ 'critical' => [ 'shape' => 'Double', ], 'high' => [ 'shape' => 'Double', ], 'info' => [ 'shape' => 'Double', ], 'low' => [ 'shape' => 'Double', ], 'medium' => [ 'shape' => 'Double', ], ], ], 'Findings' => [ 'type' => 'list', 'member' => [ 'shape' => 'Finding', ], ], 'FindingsMetricList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountFindingsMetric', ], ], 'GetAccountConfigurationRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetAccountConfigurationResponse' => [ 'type' => 'structure', 'required' => [ 'encryptionConfig', ], 'members' => [ 'encryptionConfig' => [ 'shape' => 'EncryptionConfig', ], ], ], 'GetFindingsRequest' => [ 'type' => 'structure', 'required' => [ 'scanName', ], 'members' => [ 'maxResults' => [ 'shape' => 'GetFindingsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'scanName' => [ 'shape' => 'ScanName', 'location' => 'uri', 'locationName' => 'scanName', ], 'status' => [ 'shape' => 'Status', 'location' => 'querystring', 'locationName' => 'status', ], ], ], 'GetFindingsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'GetFindingsResponse' => [ 'type' => 'structure', 'members' => [ 'findings' => [ 'shape' => 'Findings', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetMetricsSummaryRequest' => [ 'type' => 'structure', 'required' => [ 'date', ], 'members' => [ 'date' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'date', ], ], ], 'GetMetricsSummaryResponse' => [ 'type' => 'structure', 'members' => [ 'metricsSummary' => [ 'shape' => 'MetricsSummary', ], ], ], 'GetScanRequest' => [ 'type' => 'structure', 'required' => [ 'scanName', ], 'members' => [ 'runId' => [ 'shape' => 'Uuid', 'location' => 'querystring', 'locationName' => 'runId', ], 'scanName' => [ 'shape' => 'ScanName', 'location' => 'uri', 'locationName' => 'scanName', ], ], ], 'GetScanResponse' => [ 'type' => 'structure', 'required' => [ 'analysisType', 'createdAt', 'runId', 'scanName', 'scanState', ], 'members' => [ 'analysisType' => [ 'shape' => 'AnalysisType', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'numberOfRevisions' => [ 'shape' => 'Long', ], 'runId' => [ 'shape' => 'Uuid', ], 'scanName' => [ 'shape' => 'ScanName', ], 'scanNameArn' => [ 'shape' => 'ScanNameArn', ], 'scanState' => [ 'shape' => 'ScanState', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'HeaderKey' => [ 'type' => 'string', 'min' => 1, ], 'HeaderValue' => [ 'type' => 'string', 'min' => 1, ], 'Integer' => [ 'type' => 'integer', 'box' => true, ], 'InternalServerException' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, 'retryable' => [ 'throttling' => false, ], ], 'KmsKeyArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws:kms:[\\S]+:[\\d]{12}:key\\/(([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|(mrk-[0-9a-zA-Z]{32}))$', ], 'ListFindingsMetricsRequest' => [ 'type' => 'structure', 'required' => [ 'endDate', 'startDate', ], 'members' => [ 'endDate' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'endDate', ], 'maxResults' => [ 'shape' => 'ListFindingsMetricsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'startDate' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'startDate', ], ], ], 'ListFindingsMetricsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 1000, 'min' => 1, ], 'ListFindingsMetricsResponse' => [ 'type' => 'structure', 'members' => [ 'findingsMetrics' => [ 'shape' => 'FindingsMetricList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListScansRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListScansRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListScansRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListScansResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'summaries' => [ 'shape' => 'ScanSummaries', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'ScanNameArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'TagMap', ], ], ], 'Long' => [ 'type' => 'long', 'box' => true, ], 'MetricsSummary' => [ 'type' => 'structure', 'members' => [ 'categoriesWithMostFindings' => [ 'shape' => 'CategoriesWithMostFindings', ], 'date' => [ 'shape' => 'Timestamp', ], 'openFindings' => [ 'shape' => 'FindingMetricsValuePerSeverity', ], 'scansWithMostOpenCriticalFindings' => [ 'shape' => 'ScansWithMostOpenCriticalFindings', ], 'scansWithMostOpenFindings' => [ 'shape' => 'ScansWithMostOpenFindings', ], ], ], 'NextToken' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^[\\S]+$', ], 'Recommendation' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'String', ], 'url' => [ 'shape' => 'String', ], ], ], 'ReferenceUrls' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RelatedVulnerabilities' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Remediation' => [ 'type' => 'structure', 'members' => [ 'recommendation' => [ 'shape' => 'Recommendation', ], 'suggestedFixes' => [ 'shape' => 'SuggestedFixes', ], ], ], 'RequestHeaderMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'HeaderKey', ], 'value' => [ 'shape' => 'HeaderValue', ], 'sensitive' => true, ], 'Resource' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'subResourceId' => [ 'shape' => 'String', ], ], ], 'ResourceId' => [ 'type' => 'structure', 'members' => [ 'codeArtifactId' => [ 'shape' => 'Uuid', ], ], 'union' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'required' => [ 'errorCode', 'message', 'resourceId', 'resourceType', ], 'members' => [ 'errorCode' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'S3Url' => [ 'type' => 'string', 'min' => 1, 'sensitive' => true, ], 'ScanName' => [ 'type' => 'string', 'max' => 140, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-_$:.]*$', ], 'ScanNameArn' => [ 'type' => 'string', 'max' => 300, 'min' => 1, 'pattern' => '^arn:aws:codeguru-security:[\\S]+:[\\d]{12}:scans\\/[a-zA-Z0-9-_$:.]*$', ], 'ScanNameWithFindingNum' => [ 'type' => 'structure', 'members' => [ 'findingNumber' => [ 'shape' => 'Integer', ], 'scanName' => [ 'shape' => 'String', ], ], ], 'ScanState' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Successful', 'Failed', ], ], 'ScanSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScanSummary', ], ], 'ScanSummary' => [ 'type' => 'structure', 'required' => [ 'createdAt', 'runId', 'scanName', 'scanState', ], 'members' => [ 'createdAt' => [ 'shape' => 'Timestamp', ], 'runId' => [ 'shape' => 'Uuid', ], 'scanName' => [ 'shape' => 'ScanName', ], 'scanNameArn' => [ 'shape' => 'ScanNameArn', ], 'scanState' => [ 'shape' => 'ScanState', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'ScanType' => [ 'type' => 'string', 'enum' => [ 'Standard', 'Express', ], ], 'ScansWithMostOpenCriticalFindings' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScanNameWithFindingNum', ], 'max' => 3, 'min' => 0, ], 'ScansWithMostOpenFindings' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScanNameWithFindingNum', ], 'max' => 3, 'min' => 0, ], 'Severity' => [ 'type' => 'string', 'enum' => [ 'Critical', 'High', 'Medium', 'Low', 'Info', ], ], 'Status' => [ 'type' => 'string', 'enum' => [ 'Closed', 'Open', 'All', ], ], 'String' => [ 'type' => 'string', ], 'SuggestedFix' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'String', ], 'description' => [ 'shape' => 'String', ], ], ], 'SuggestedFixes' => [ 'type' => 'list', 'member' => [ 'shape' => 'SuggestedFix', ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 0, ], 'TagMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], 'max' => 200, 'min' => 0, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'ScanNameArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'ThrottlingException' => [ 'type' => 'structure', 'required' => [ 'errorCode', 'message', ], 'members' => [ 'errorCode' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], 'quotaCode' => [ 'shape' => 'String', ], 'serviceCode' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, 'retryable' => [ 'throttling' => true, ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'ScanNameArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateAccountConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'encryptionConfig', ], 'members' => [ 'encryptionConfig' => [ 'shape' => 'EncryptionConfig', ], ], ], 'UpdateAccountConfigurationResponse' => [ 'type' => 'structure', 'required' => [ 'encryptionConfig', ], 'members' => [ 'encryptionConfig' => [ 'shape' => 'EncryptionConfig', ], ], ], 'Uuid' => [ 'type' => 'string', 'pattern' => '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$', ], 'ValidationException' => [ 'type' => 'structure', 'required' => [ 'errorCode', 'message', 'reason', ], 'members' => [ 'errorCode' => [ 'shape' => 'String', ], 'fieldList' => [ 'shape' => 'ValidationExceptionFieldList', ], 'message' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'ValidationExceptionReason', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ValidationExceptionField' => [ 'type' => 'structure', 'required' => [ 'message', 'name', ], 'members' => [ 'message' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], ], ], 'ValidationExceptionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationExceptionField', ], ], 'ValidationExceptionReason' => [ 'type' => 'string', 'enum' => [ 'unknownOperation', 'cannotParse', 'fieldValidationFailed', 'other', 'lambdaCodeShaMisMatch', ], ], 'Vulnerability' => [ 'type' => 'structure', 'members' => [ 'filePath' => [ 'shape' => 'FilePath', ], 'id' => [ 'shape' => 'String', ], 'itemCount' => [ 'shape' => 'Integer', ], 'referenceUrls' => [ 'shape' => 'ReferenceUrls', ], 'relatedVulnerabilities' => [ 'shape' => 'RelatedVulnerabilities', ], ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2018-05-10', 'endpointPrefix' => 'codeguru-security', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'protocols' => [ 'rest-json', ], 'serviceFullName' => 'Amazon CodeGuru Security', 'serviceId' => 'CodeGuru Security', 'signatureVersion' => 'v4', 'signingName' => 'codeguru-security', 'uid' => 'codeguru-security-2018-05-10', ], 'operations' => [ 'BatchGetFindings' => [ 'name' => 'BatchGetFindings', 'http' => [ 'method' => 'POST', 'requestUri' => '/batchGetFindings', 'responseCode' => 200, ], 'input' => [ 'shape' => 'BatchGetFindingsRequest', ], 'output' => [ 'shape' => 'BatchGetFindingsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateScan' => [ 'name' => 'CreateScan', 'http' => [ 'method' => 'POST', 'requestUri' => '/scans', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateScanRequest', ], 'output' => [ 'shape' => 'CreateScanResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'CreateUploadUrl' => [ 'name' => 'CreateUploadUrl', 'http' => [ 'method' => 'POST', 'requestUri' => '/uploadUrl', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateUploadUrlRequest', ], 'output' => [ 'shape' => 'CreateUploadUrlResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetAccountConfiguration' => [ 'name' => 'GetAccountConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/accountConfiguration/get', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetAccountConfigurationRequest', ], 'output' => [ 'shape' => 'GetAccountConfigurationResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetFindings' => [ 'name' => 'GetFindings', 'http' => [ 'method' => 'GET', 'requestUri' => '/findings/{scanName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetFindingsRequest', ], 'output' => [ 'shape' => 'GetFindingsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetMetricsSummary' => [ 'name' => 'GetMetricsSummary', 'http' => [ 'method' => 'GET', 'requestUri' => '/metrics/summary', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetMetricsSummaryRequest', ], 'output' => [ 'shape' => 'GetMetricsSummaryResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'GetScan' => [ 'name' => 'GetScan', 'http' => [ 'method' => 'GET', 'requestUri' => '/scans/{scanName}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetScanRequest', ], 'output' => [ 'shape' => 'GetScanResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListFindingsMetrics' => [ 'name' => 'ListFindingsMetrics', 'http' => [ 'method' => 'GET', 'requestUri' => '/metrics/findings', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListFindingsMetricsRequest', ], 'output' => [ 'shape' => 'ListFindingsMetricsResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListScans' => [ 'name' => 'ListScans', 'http' => [ 'method' => 'GET', 'requestUri' => '/scans', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListScansRequest', ], 'output' => [ 'shape' => 'ListScansResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTagsForResourceRequest', ], 'output' => [ 'shape' => 'ListTagsForResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], 'idempotent' => true, ], 'UpdateAccountConfiguration' => [ 'name' => 'UpdateAccountConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/updateAccountConfiguration', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UpdateAccountConfigurationRequest', ], 'output' => [ 'shape' => 'UpdateAccountConfigurationResponse', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], ], ], ], 'shapes' => [ 'AccessDeniedException' => [ 'type' => 'structure', 'required' => [ 'errorCode', 'message', ], 'members' => [ 'errorCode' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 403, 'senderFault' => true, ], 'exception' => true, ], 'AccountFindingsMetric' => [ 'type' => 'structure', 'members' => [ 'closedFindings' => [ 'shape' => 'FindingMetricsValuePerSeverity', ], 'date' => [ 'shape' => 'Timestamp', ], 'meanTimeToClose' => [ 'shape' => 'FindingMetricsValuePerSeverity', ], 'newFindings' => [ 'shape' => 'FindingMetricsValuePerSeverity', ], 'openFindings' => [ 'shape' => 'FindingMetricsValuePerSeverity', ], ], ], 'AnalysisType' => [ 'type' => 'string', 'enum' => [ 'Security', 'All', ], ], 'BatchGetFindingsError' => [ 'type' => 'structure', 'required' => [ 'errorCode', 'findingId', 'message', 'scanName', ], 'members' => [ 'errorCode' => [ 'shape' => 'ErrorCode', ], 'findingId' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], 'scanName' => [ 'shape' => 'ScanName', ], ], ], 'BatchGetFindingsErrors' => [ 'type' => 'list', 'member' => [ 'shape' => 'BatchGetFindingsError', ], ], 'BatchGetFindingsRequest' => [ 'type' => 'structure', 'required' => [ 'findingIdentifiers', ], 'members' => [ 'findingIdentifiers' => [ 'shape' => 'FindingIdentifiers', ], ], ], 'BatchGetFindingsResponse' => [ 'type' => 'structure', 'required' => [ 'failedFindings', 'findings', ], 'members' => [ 'failedFindings' => [ 'shape' => 'BatchGetFindingsErrors', ], 'findings' => [ 'shape' => 'Findings', ], ], ], 'CategoriesWithMostFindings' => [ 'type' => 'list', 'member' => [ 'shape' => 'CategoryWithFindingNum', ], 'max' => 5, 'min' => 0, ], 'CategoryWithFindingNum' => [ 'type' => 'structure', 'members' => [ 'categoryName' => [ 'shape' => 'String', ], 'findingNumber' => [ 'shape' => 'Integer', ], ], ], 'ClientToken' => [ 'type' => 'string', 'max' => 64, 'min' => 1, 'pattern' => '^[\\S]+$', ], 'CodeLine' => [ 'type' => 'structure', 'members' => [ 'content' => [ 'shape' => 'String', ], 'number' => [ 'shape' => 'Integer', ], ], ], 'CodeSnippet' => [ 'type' => 'list', 'member' => [ 'shape' => 'CodeLine', ], ], 'ConflictException' => [ 'type' => 'structure', 'required' => [ 'errorCode', 'message', 'resourceId', 'resourceType', ], 'members' => [ 'errorCode' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 409, 'senderFault' => true, ], 'exception' => true, ], 'CreateScanRequest' => [ 'type' => 'structure', 'required' => [ 'resourceId', 'scanName', ], 'members' => [ 'analysisType' => [ 'shape' => 'AnalysisType', ], 'clientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'resourceId' => [ 'shape' => 'ResourceId', ], 'scanName' => [ 'shape' => 'ScanName', ], 'scanType' => [ 'shape' => 'ScanType', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'CreateScanResponse' => [ 'type' => 'structure', 'required' => [ 'resourceId', 'runId', 'scanName', 'scanState', ], 'members' => [ 'resourceId' => [ 'shape' => 'ResourceId', ], 'runId' => [ 'shape' => 'Uuid', ], 'scanName' => [ 'shape' => 'ScanName', ], 'scanNameArn' => [ 'shape' => 'ScanNameArn', ], 'scanState' => [ 'shape' => 'ScanState', ], ], ], 'CreateUploadUrlRequest' => [ 'type' => 'structure', 'required' => [ 'scanName', ], 'members' => [ 'scanName' => [ 'shape' => 'ScanName', ], ], ], 'CreateUploadUrlResponse' => [ 'type' => 'structure', 'required' => [ 'codeArtifactId', 'requestHeaders', 's3Url', ], 'members' => [ 'codeArtifactId' => [ 'shape' => 'Uuid', ], 'requestHeaders' => [ 'shape' => 'RequestHeaderMap', ], 's3Url' => [ 'shape' => 'S3Url', ], ], ], 'DetectorTags' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Double' => [ 'type' => 'double', 'box' => true, ], 'EncryptionConfig' => [ 'type' => 'structure', 'members' => [ 'kmsKeyArn' => [ 'shape' => 'KmsKeyArn', ], ], ], 'ErrorCode' => [ 'type' => 'string', 'enum' => [ 'DUPLICATE_IDENTIFIER', 'ITEM_DOES_NOT_EXIST', 'INTERNAL_ERROR', 'INVALID_FINDING_ID', 'INVALID_SCAN_NAME', ], ], 'ErrorMessage' => [ 'type' => 'string', 'min' => 1, ], 'FilePath' => [ 'type' => 'structure', 'members' => [ 'codeSnippet' => [ 'shape' => 'CodeSnippet', ], 'endLine' => [ 'shape' => 'Integer', ], 'name' => [ 'shape' => 'String', ], 'path' => [ 'shape' => 'String', ], 'startLine' => [ 'shape' => 'Integer', ], ], ], 'Finding' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'Timestamp', ], 'description' => [ 'shape' => 'String', ], 'detectorId' => [ 'shape' => 'String', ], 'detectorName' => [ 'shape' => 'String', ], 'detectorTags' => [ 'shape' => 'DetectorTags', ], 'generatorId' => [ 'shape' => 'String', ], 'id' => [ 'shape' => 'String', ], 'remediation' => [ 'shape' => 'Remediation', ], 'resource' => [ 'shape' => 'Resource', ], 'ruleId' => [ 'shape' => 'String', ], 'severity' => [ 'shape' => 'Severity', ], 'status' => [ 'shape' => 'Status', ], 'title' => [ 'shape' => 'String', ], 'type' => [ 'shape' => 'String', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], 'vulnerability' => [ 'shape' => 'Vulnerability', ], ], ], 'FindingIdentifier' => [ 'type' => 'structure', 'required' => [ 'findingId', 'scanName', ], 'members' => [ 'findingId' => [ 'shape' => 'String', ], 'scanName' => [ 'shape' => 'String', ], ], ], 'FindingIdentifiers' => [ 'type' => 'list', 'member' => [ 'shape' => 'FindingIdentifier', ], 'max' => 25, 'min' => 1, ], 'FindingMetricsValuePerSeverity' => [ 'type' => 'structure', 'members' => [ 'critical' => [ 'shape' => 'Double', ], 'high' => [ 'shape' => 'Double', ], 'info' => [ 'shape' => 'Double', ], 'low' => [ 'shape' => 'Double', ], 'medium' => [ 'shape' => 'Double', ], ], ], 'Findings' => [ 'type' => 'list', 'member' => [ 'shape' => 'Finding', ], ], 'FindingsMetricList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountFindingsMetric', ], ], 'GetAccountConfigurationRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetAccountConfigurationResponse' => [ 'type' => 'structure', 'required' => [ 'encryptionConfig', ], 'members' => [ 'encryptionConfig' => [ 'shape' => 'EncryptionConfig', ], ], ], 'GetFindingsRequest' => [ 'type' => 'structure', 'required' => [ 'scanName', ], 'members' => [ 'maxResults' => [ 'shape' => 'GetFindingsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'scanName' => [ 'shape' => 'ScanName', 'location' => 'uri', 'locationName' => 'scanName', ], 'status' => [ 'shape' => 'Status', 'location' => 'querystring', 'locationName' => 'status', ], ], ], 'GetFindingsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 1000, 'min' => 1, ], 'GetFindingsResponse' => [ 'type' => 'structure', 'members' => [ 'findings' => [ 'shape' => 'Findings', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetMetricsSummaryRequest' => [ 'type' => 'structure', 'required' => [ 'date', ], 'members' => [ 'date' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'date', ], ], ], 'GetMetricsSummaryResponse' => [ 'type' => 'structure', 'members' => [ 'metricsSummary' => [ 'shape' => 'MetricsSummary', ], ], ], 'GetScanRequest' => [ 'type' => 'structure', 'required' => [ 'scanName', ], 'members' => [ 'runId' => [ 'shape' => 'Uuid', 'location' => 'querystring', 'locationName' => 'runId', ], 'scanName' => [ 'shape' => 'ScanName', 'location' => 'uri', 'locationName' => 'scanName', ], ], ], 'GetScanResponse' => [ 'type' => 'structure', 'required' => [ 'analysisType', 'createdAt', 'runId', 'scanName', 'scanState', ], 'members' => [ 'analysisType' => [ 'shape' => 'AnalysisType', ], 'createdAt' => [ 'shape' => 'Timestamp', ], 'errorMessage' => [ 'shape' => 'ErrorMessage', ], 'numberOfRevisions' => [ 'shape' => 'Long', ], 'runId' => [ 'shape' => 'Uuid', ], 'scanName' => [ 'shape' => 'ScanName', ], 'scanNameArn' => [ 'shape' => 'ScanNameArn', ], 'scanState' => [ 'shape' => 'ScanState', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'HeaderKey' => [ 'type' => 'string', 'min' => 1, ], 'HeaderValue' => [ 'type' => 'string', 'min' => 1, ], 'Integer' => [ 'type' => 'integer', 'box' => true, ], 'InternalServerException' => [ 'type' => 'structure', 'members' => [ 'error' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, 'retryable' => [ 'throttling' => false, ], ], 'KmsKeyArn' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^arn:aws:kms:[\\S]+:[\\d]{12}:key\\/(([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|(mrk-[0-9a-zA-Z]{32}))$', ], 'ListFindingsMetricsRequest' => [ 'type' => 'structure', 'required' => [ 'endDate', 'startDate', ], 'members' => [ 'endDate' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'endDate', ], 'maxResults' => [ 'shape' => 'ListFindingsMetricsRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], 'startDate' => [ 'shape' => 'Timestamp', 'location' => 'querystring', 'locationName' => 'startDate', ], ], ], 'ListFindingsMetricsRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 1000, 'min' => 1, ], 'ListFindingsMetricsResponse' => [ 'type' => 'structure', 'members' => [ 'findingsMetrics' => [ 'shape' => 'FindingsMetricList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListScansRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'ListScansRequestMaxResultsInteger', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'nextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListScansRequestMaxResultsInteger' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'ListScansResponse' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'summaries' => [ 'shape' => 'ScanSummaries', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'ScanNameArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'TagMap', ], ], ], 'Long' => [ 'type' => 'long', 'box' => true, ], 'MetricsSummary' => [ 'type' => 'structure', 'members' => [ 'categoriesWithMostFindings' => [ 'shape' => 'CategoriesWithMostFindings', ], 'date' => [ 'shape' => 'Timestamp', ], 'openFindings' => [ 'shape' => 'FindingMetricsValuePerSeverity', ], 'scansWithMostOpenCriticalFindings' => [ 'shape' => 'ScansWithMostOpenCriticalFindings', ], 'scansWithMostOpenFindings' => [ 'shape' => 'ScansWithMostOpenFindings', ], ], ], 'NextToken' => [ 'type' => 'string', 'max' => 2048, 'min' => 1, 'pattern' => '^[\\S]+$', ], 'Recommendation' => [ 'type' => 'structure', 'members' => [ 'text' => [ 'shape' => 'String', ], 'url' => [ 'shape' => 'String', ], ], ], 'ReferenceUrls' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RelatedVulnerabilities' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Remediation' => [ 'type' => 'structure', 'members' => [ 'recommendation' => [ 'shape' => 'Recommendation', ], 'suggestedFixes' => [ 'shape' => 'SuggestedFixes', ], ], ], 'RequestHeaderMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'HeaderKey', ], 'value' => [ 'shape' => 'HeaderValue', ], 'sensitive' => true, ], 'Resource' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'String', ], 'subResourceId' => [ 'shape' => 'String', ], ], ], 'ResourceId' => [ 'type' => 'structure', 'members' => [ 'codeArtifactId' => [ 'shape' => 'Uuid', ], ], 'union' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'required' => [ 'errorCode', 'message', 'resourceId', 'resourceType', ], 'members' => [ 'errorCode' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], 'resourceId' => [ 'shape' => 'String', ], 'resourceType' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'S3Url' => [ 'type' => 'string', 'min' => 1, 'sensitive' => true, ], 'ScanName' => [ 'type' => 'string', 'max' => 140, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-_$:.]*$', ], 'ScanNameArn' => [ 'type' => 'string', 'max' => 300, 'min' => 1, 'pattern' => '^arn:aws:codeguru-security:[\\S]+:[\\d]{12}:scans\\/[a-zA-Z0-9-_$:.]*$', ], 'ScanNameWithFindingNum' => [ 'type' => 'structure', 'members' => [ 'findingNumber' => [ 'shape' => 'Integer', ], 'scanName' => [ 'shape' => 'String', ], ], ], 'ScanState' => [ 'type' => 'string', 'enum' => [ 'InProgress', 'Successful', 'Failed', ], ], 'ScanSummaries' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScanSummary', ], ], 'ScanSummary' => [ 'type' => 'structure', 'required' => [ 'createdAt', 'runId', 'scanName', 'scanState', ], 'members' => [ 'createdAt' => [ 'shape' => 'Timestamp', ], 'runId' => [ 'shape' => 'Uuid', ], 'scanName' => [ 'shape' => 'ScanName', ], 'scanNameArn' => [ 'shape' => 'ScanNameArn', ], 'scanState' => [ 'shape' => 'ScanState', ], 'updatedAt' => [ 'shape' => 'Timestamp', ], ], ], 'ScanType' => [ 'type' => 'string', 'enum' => [ 'Standard', 'Express', ], ], 'ScansWithMostOpenCriticalFindings' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScanNameWithFindingNum', ], 'max' => 3, 'min' => 0, ], 'ScansWithMostOpenFindings' => [ 'type' => 'list', 'member' => [ 'shape' => 'ScanNameWithFindingNum', ], 'max' => 3, 'min' => 0, ], 'Severity' => [ 'type' => 'string', 'enum' => [ 'Critical', 'High', 'Medium', 'Low', 'Info', ], ], 'Status' => [ 'type' => 'string', 'enum' => [ 'Closed', 'Open', 'All', ], ], 'String' => [ 'type' => 'string', ], 'SuggestedFix' => [ 'type' => 'structure', 'members' => [ 'code' => [ 'shape' => 'String', ], 'description' => [ 'shape' => 'String', ], ], ], 'SuggestedFixes' => [ 'type' => 'list', 'member' => [ 'shape' => 'SuggestedFix', ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], 'max' => 200, 'min' => 0, ], 'TagMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], 'max' => 200, 'min' => 0, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'ScanNameArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'TagMap', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'ThrottlingException' => [ 'type' => 'structure', 'required' => [ 'errorCode', 'message', ], 'members' => [ 'errorCode' => [ 'shape' => 'String', ], 'message' => [ 'shape' => 'String', ], 'quotaCode' => [ 'shape' => 'String', ], 'serviceCode' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 429, 'senderFault' => true, ], 'exception' => true, 'retryable' => [ 'throttling' => true, ], ], 'Timestamp' => [ 'type' => 'timestamp', ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'ScanNameArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateAccountConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'encryptionConfig', ], 'members' => [ 'encryptionConfig' => [ 'shape' => 'EncryptionConfig', ], ], ], 'UpdateAccountConfigurationResponse' => [ 'type' => 'structure', 'required' => [ 'encryptionConfig', ], 'members' => [ 'encryptionConfig' => [ 'shape' => 'EncryptionConfig', ], ], ], 'Uuid' => [ 'type' => 'string', 'pattern' => '^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$', ], 'ValidationException' => [ 'type' => 'structure', 'required' => [ 'errorCode', 'message', 'reason', ], 'members' => [ 'errorCode' => [ 'shape' => 'String', ], 'fieldList' => [ 'shape' => 'ValidationExceptionFieldList', ], 'message' => [ 'shape' => 'String', ], 'reason' => [ 'shape' => 'ValidationExceptionReason', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ValidationExceptionField' => [ 'type' => 'structure', 'required' => [ 'message', 'name', ], 'members' => [ 'message' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], ], ], 'ValidationExceptionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationExceptionField', ], ], 'ValidationExceptionReason' => [ 'type' => 'string', 'enum' => [ 'unknownOperation', 'cannotParse', 'fieldValidationFailed', 'other', 'lambdaCodeShaMisMatch', ], ], 'Vulnerability' => [ 'type' => 'structure', 'members' => [ 'filePath' => [ 'shape' => 'FilePath', ], 'id' => [ 'shape' => 'String', ], 'itemCount' => [ 'shape' => 'Integer', 'deprecated' => true, 'deprecatedMessage' => 'This shape is not used.', ], 'referenceUrls' => [ 'shape' => 'ReferenceUrls', ], 'relatedVulnerabilities' => [ 'shape' => 'RelatedVulnerabilities', ], ], ], ],]; diff --git a/src/data/codeguru-security/2018-05-10/docs-2.json b/src/data/codeguru-security/2018-05-10/docs-2.json index 2d05bdf30c..22e6fb5b0b 100644 --- a/src/data/codeguru-security/2018-05-10/docs-2.json +++ b/src/data/codeguru-security/2018-05-10/docs-2.json @@ -2,19 +2,19 @@ "version": "2.0", "service": "Amazon CodeGuru Security is in preview release and is subject to change.
This section provides documentation for the Amazon CodeGuru Security API operations. CodeGuru Security is a service that uses program analysis and machine learning to detect security policy violations and vulnerabilities, and recommends ways to address these security risks.
By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the Amazon CodeGuru Security User Guide.
", "operations": { - "BatchGetFindings": "Returns a list of all requested findings.
", - "CreateScan": "Use to create a scan using code uploaded to an S3 bucket.
", - "CreateUploadUrl": "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.
", - "GetAccountConfiguration": "Use to get account level configuration.
", + "BatchGetFindings": "Returns a list of requested findings from standard scans.
", + "CreateScan": "Use to create a scan using code uploaded to an Amazon S3 bucket.
", + "CreateUploadUrl": "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": "Use to get the encryption configuration for an account.
", "GetFindings": "Returns a list of all findings generated by a particular scan.
", - "GetMetricsSummary": "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.
", + "GetMetricsSummary": "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": "Returns details about a scan, including whether or not a scan has completed.
", "ListFindingsMetrics": "Returns metrics about all findings in an account within a specified time range.
", - "ListScans": "Returns a list of all the standard scans in an account. Does not return express scans.
", + "ListScans": "Returns a list of all scans in an account. Does not return EXPRESS scans.
Returns a list of all tags associated with a scan.
", "TagResource": "Use to add one or more tags to an existing scan.
", "UntagResource": "Use to remove one or more tags from an existing scan.
", - "UpdateAccountConfiguration": "Use to update account-level configuration with an encryption key.
" + "UpdateAccountConfiguration": "Use to update the encryption configuration for an account.
" }, "shapes": { "AccessDeniedException": { @@ -23,7 +23,7 @@ } }, "AccountFindingsMetric": { - "base": "A summary of findings metrics in an account.
", + "base": "A summary of findings metrics for an account on a specified date.
", "refs": { "FindingsMetricList$member": null } @@ -60,7 +60,7 @@ "CategoriesWithMostFindings": { "base": null, "refs": { - "MetricsSummary$categoriesWithMostFindings": "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 severity of the finding is critical and should be addressed immediately.
", - "FindingMetricsValuePerSeverity$high": "The severity of the finding is high and should be addressed as a near-term priority.
", - "FindingMetricsValuePerSeverity$info": "The finding is related to quality or readability improvements and not considered actionable.
", - "FindingMetricsValuePerSeverity$low": "The severity of the finding is low and does require action on its own.
", - "FindingMetricsValuePerSeverity$medium": "The severity of the finding is medium and should be addressed as a mid-term priority.
" + "FindingMetricsValuePerSeverity$critical": "A numeric value corresponding to a critical finding.
", + "FindingMetricsValuePerSeverity$high": "A numeric value corresponding to a high severity finding.
", + "FindingMetricsValuePerSeverity$info": "A numeric value corresponding to an informational finding.
", + "FindingMetricsValuePerSeverity$low": "A numeric value corresponding to a low severity finding.
", + "FindingMetricsValuePerSeverity$medium": "A numeric value corresponding to a medium severity finding.
" } }, "EncryptionConfig": { - "base": "Information about account-level configuration.
", + "base": "Information about the encryption configuration for an account. Required to call UpdateAccountConfiguration.
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.
The KMS key ARN you want to use for encryption. Defaults to service-side encryption if missing.
", - "UpdateAccountConfigurationResponse$encryptionConfig": "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. 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 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.
", + "UpdateAccountConfigurationResponse$encryptionConfig": "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.
A code associated with the type of error.
" } }, + "ErrorMessage": { + "base": null, + "refs": { + "GetScanResponse$errorMessage": "Details about the error that causes a scan to fail to be retrieved.
" + } + }, "FilePath": { "base": "Information about the location of security vulnerabilities that Amazon CodeGuru Security detected in your code.
", "refs": { @@ -167,19 +173,19 @@ } }, "FindingMetricsValuePerSeverity": { - "base": "The severity of the issue in the code that generated a finding.
", + "base": "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.
", "refs": { - "AccountFindingsMetric$closedFindings": "The number of closed findings of each severity in an account on the specified date.
", - "AccountFindingsMetric$meanTimeToClose": "The average time it takes to close findings of each severity in days.
", - "AccountFindingsMetric$newFindings": "The number of new findings of each severity in account on the specified date.
", - "AccountFindingsMetric$openFindings": "The number of open findings of each severity in an account as of the specified date.
", - "MetricsSummary$openFindings": "The number of open findings of each severity in an account.
" + "AccountFindingsMetric$closedFindings": "The number of closed findings of each severity on the specified date.
", + "AccountFindingsMetric$meanTimeToClose": "The average time in days it takes to close findings of each severity as of a specified date.
", + "AccountFindingsMetric$newFindings": "The number of new findings of each severity on the specified date.
", + "AccountFindingsMetric$openFindings": "The number of open findings of each severity as of the specified date.
", + "MetricsSummary$openFindings": "The number of open findings of each severity.
" } }, "Findings": { "base": null, "refs": { - "BatchGetFindingsResponse$findings": "A list of all requested findings.
", + "BatchGetFindingsResponse$findings": "A list of all findings which were successfully fetched.
", "GetFindingsResponse$findings": "A list of findings generated by the specified scan.
" } }, @@ -207,7 +213,7 @@ "GetFindingsRequestMaxResultsInteger": { "base": null, "refs": { - "GetFindingsRequest$maxResults": "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 code line number.
", "FilePath$endLine": "The last line number of the code snippet where the security vulnerability appears in your code.
", "FilePath$startLine": "The first line number of the code snippet where the security vulnerability appears in your code.
", - "ScanNameWithFindingNum$findingNumber": "The number of open findings generated by a scan.
", - "Vulnerability$itemCount": "The number of times the vulnerability appears in your code.
" + "ScanNameWithFindingNum$findingNumber": "The number of findings generated by a scan.
", + "Vulnerability$itemCount": "The number of times the vulnerability appears in your code.
" } }, "InternalServerException": { @@ -266,7 +272,7 @@ "KmsKeyArn": { "base": null, "refs": { - "EncryptionConfig$kmsKeyArn": "The KMS key ARN to use for encryption. This must be provided as a header when uploading your code resource.
" + "EncryptionConfig$kmsKeyArn": "The KMS key ARN that is used for encryption. If an AWS-managed key is used for encryption, returns empty.
" } }, "ListFindingsMetricsRequest": { @@ -277,7 +283,7 @@ "ListFindingsMetricsRequestMaxResultsInteger": { "base": null, "refs": { - "ListFindingsMetricsRequest$maxResults": "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 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.
Information about summary metrics in an account.
", + "base": "A summary of metrics for an account as of a specified date.
", "refs": { "GetMetricsSummaryResponse$metricsSummary": "The summary metrics from the specified date.
" } @@ -365,15 +371,15 @@ } }, "Resource": { - "base": "Information about a resource, such as an Amazon S3 bucket or AWS Lambda function, that contains a finding.
", + "base": "Information about a resource that contains a finding.
", "refs": { "Finding$resource": "The resource where Amazon CodeGuru Security detected a finding.
" } }, "ResourceId": { - "base": "The identifier for a resource object that contains resources where a finding was detected.
", + "base": "The identifier for a resource object that contains resources to scan. Specifying a codeArtifactId is required to create a scan.
", "refs": { - "CreateScanRequest$resourceId": "The identifier for an input resource used to create a scan.
", + "CreateScanRequest$resourceId": "The identifier for the resource object to be scanned.
", "CreateScanResponse$resourceId": "The identifier for the resource object that contains resources that were scanned.
" } }, @@ -385,14 +391,14 @@ "S3Url": { "base": null, "refs": { - "CreateUploadUrlResponse$s3Url": "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 name of the scan that generated the finding.
", - "CreateScanRequest$scanName": "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 name of the scan.
", "CreateUploadUrlRequest$scanName": "The name of the scan that will use the uploaded resource. CodeGuru Security uses the unique scan name to track revisions across multiple scans of the same resource. Use this scanName when you call CreateScan on the code resource you upload to this URL.
The name of the scan you want to retrieve findings from.
", @@ -406,14 +412,14 @@ "refs": { "CreateScanResponse$scanNameArn": "The ARN for the scan name.
", "GetScanResponse$scanNameArn": "The ARN for the scan name.
", - "ListTagsForResourceRequest$resourceArn": "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 for the scan name.
", - "TagResourceRequest$resourceArn": "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 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 CreateScan, ListScans, or GetScan.
Information about a scan with open findings.
", + "base": "Information about the number of findings generated by a scan.
", "refs": { "ScansWithMostOpenCriticalFindings$member": null, "ScansWithMostOpenFindings$member": null @@ -423,7 +429,7 @@ "base": null, "refs": { "CreateScanResponse$scanState": "The current state of the scan. Returns either InProgress, Successful, or Failed.
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 state of the scan. A scan can be In Progress, Complete, or Failed.
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.
The severity of the finding.
" + "Finding$severity": "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": { @@ -491,7 +497,7 @@ "Finding$description": "A description of the finding.
", "Finding$detectorId": "The identifier for the detector that detected the finding in your code. A detector is a defined rule based on industry standards and AWS best practices.
", "Finding$detectorName": "The name of the detector that identified the security vulnerability in your code.
", - "Finding$generatorId": "The identifier for the component that generated a finding such as AWSCodeGuruSecurity or AWSInspector.
", + "Finding$generatorId": "The identifier for the component that generated a finding such as AmazonCodeGuruSecurity.
", "Finding$id": "The identifier for a finding.
", "Finding$ruleId": "The identifier for the rule that generated the finding.
", "Finding$title": "The title of the finding.
", @@ -504,14 +510,14 @@ "Recommendation$url": "The URL address to the recommendation for remediating the finding.
", "ReferenceUrls$member": null, "RelatedVulnerabilities$member": null, - "Resource$id": "The identifier for the resource.
", - "Resource$subResourceId": "The identifier for a section of the resource, such as an AWS Lambda layer.
", + "Resource$id": "The scanName of the scan that was run on the resource.
The identifier for a section of the resource.
", "ResourceNotFoundException$errorCode": "The identifier for the error.
", "ResourceNotFoundException$message": "Description of the error.
", "ResourceNotFoundException$resourceId": "The identifier for the resource that was not found.
", "ResourceNotFoundException$resourceType": "The type of resource that was not found.
", "ScanNameWithFindingNum$scanName": "The name of the scan.
", - "SuggestedFix$code": "The suggested code to add to your file.
", + "SuggestedFix$code": "The suggested code fix. If applicable, includes code patch to replace your source code.
", "SuggestedFix$description": "A description of the suggested code fix and why it is being suggested.
", "ThrottlingException$errorCode": "The identifier for the error.
", "ThrottlingException$message": "Description of the error.
", @@ -581,14 +587,14 @@ "Timestamp": { "base": null, "refs": { - "AccountFindingsMetric$date": "The date from which the finding metrics were retrieved.
", + "AccountFindingsMetric$date": "The date from which the findings metrics were retrieved.
", "Finding$createdAt": "The time when the finding was created.
", "Finding$updatedAt": "The time when the finding was last updated. Findings are updated when you remediate them or when the finding code location changes.
", - "GetMetricsSummaryRequest$date": "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.
", + "GetMetricsSummaryRequest$date": "The date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years.
", "GetScanResponse$createdAt": "The time the scan was created.
", "GetScanResponse$updatedAt": "The time when the scan was last updated. Only available for STANDARD scan types.
The end date of the interval which you want to retrieve metrics from.
", - "ListFindingsMetricsRequest$startDate": "The start date of the interval which you want to retrieve metrics from.
", + "ListFindingsMetricsRequest$endDate": "The end date of the interval which you want to retrieve metrics from. Round to the nearest day.
", + "ListFindingsMetricsRequest$startDate": "The start date of the interval which you want to retrieve metrics from. Rounds to the nearest day.
", "MetricsSummary$date": "The date from which the metrics summary information was retrieved.
", "ScanSummary$createdAt": "The time when the scan was created.
", "ScanSummary$updatedAt": "The time the scan was last updated. A scan is updated when it is re-run.
" @@ -618,10 +624,10 @@ "base": null, "refs": { "CreateScanResponse$runId": "UUID that identifies the individual scan run.
", - "CreateUploadUrlResponse$codeArtifactId": "The identifier for the uploaded code resource.
", + "CreateUploadUrlResponse$codeArtifactId": "The identifier for the uploaded code resource. Pass this to CreateScan to use the uploaded resources.
UUID that identifies the individual scan run you want to view details about. You retrieve this when you call the CreateScan operation. Defaults to the latest scan run if missing.
UUID that identifies the individual scan run.
", - "ResourceId$codeArtifactId": "The identifier for the code file uploaded to the resource where a finding was detected.
", + "ResourceId$codeArtifactId": "The identifier for the code file uploaded to the resource object. Returned by CreateUploadUrl when you upload resources to be scanned.
The identifier for the scan run.
" } }, diff --git a/src/data/codeguru-security/2018-05-10/docs-2.json.php b/src/data/codeguru-security/2018-05-10/docs-2.json.php index 943b821be5..559a5581c0 100644 --- a/src/data/codeguru-security/2018-05-10/docs-2.json.php +++ b/src/data/codeguru-security/2018-05-10/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Amazon CodeGuru Security is in preview release and is subject to change.
This section provides documentation for the Amazon CodeGuru Security API operations. CodeGuru Security is a service that uses program analysis and machine learning to detect security policy violations and vulnerabilities, and recommends ways to address these security risks.
By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the Amazon CodeGuru Security User Guide.
', 'operations' => [ 'BatchGetFindings' => 'Returns a list of all requested findings.
', 'CreateScan' => 'Use to create a scan using code uploaded to an S3 bucket.
', 'CreateUploadUrl' => '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.
', 'GetAccountConfiguration' => 'Use to get account level configuration.
', 'GetFindings' => 'Returns a list of all findings generated by a particular scan.
', 'GetMetricsSummary' => '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.
', 'GetScan' => 'Returns details about a scan, including whether or not a scan has completed.
', 'ListFindingsMetrics' => 'Returns metrics about all findings in an account within a specified time range.
', 'ListScans' => 'Returns a list of all the standard scans in an account. Does not return express scans.
', 'ListTagsForResource' => 'Returns a list of all tags associated with a scan.
', 'TagResource' => 'Use to add one or more tags to an existing scan.
', 'UntagResource' => 'Use to remove one or more tags from an existing scan.
', 'UpdateAccountConfiguration' => 'Use to update account-level configuration with an encryption key.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'You do not have sufficient access to perform this action.
', 'refs' => [], ], 'AccountFindingsMetric' => [ 'base' => 'A summary of findings metrics in an account.
', 'refs' => [ 'FindingsMetricList$member' => NULL, ], ], 'AnalysisType' => [ 'base' => NULL, 'refs' => [ 'CreateScanRequest$analysisType' => 'The type of analysis you want CodeGuru Security to perform in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings. Defaults to Security type if missing.
The type of analysis CodeGuru Security performed in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings.
Contains information about the error that caused a finding to fail to be retrieved.
', 'refs' => [ 'BatchGetFindingsErrors$member' => NULL, ], ], 'BatchGetFindingsErrors' => [ 'base' => NULL, 'refs' => [ 'BatchGetFindingsResponse$failedFindings' => 'A list of errors for individual findings which were not fetched. Each BatchGetFindingsError contains the scanName, findingId, errorCode and error message.
A list of CategoryWithFindingNum objects for the top 5 finding categories with the most open findings in an account.
Information about a finding category with open findings.
', 'refs' => [ 'CategoriesWithMostFindings$member' => NULL, ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateScanRequest$clientToken' => 'The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.
', ], ], 'CodeLine' => [ 'base' => 'The line of code where a finding was detected.
', 'refs' => [ 'CodeSnippet$member' => NULL, ], ], 'CodeSnippet' => [ 'base' => NULL, 'refs' => [ 'FilePath$codeSnippet' => 'A list of CodeLine objects that describe where the security vulnerability appears in your code.
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
', 'refs' => [], ], 'CreateScanRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateScanResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUploadUrlRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUploadUrlResponse' => [ 'base' => NULL, 'refs' => [], ], 'DetectorTags' => [ 'base' => NULL, 'refs' => [ 'Finding$detectorTags' => 'One or more tags or categorizations that are associated with a detector. These tags are defined by type, programming language, or other classification such as maintainability or consistency.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'FindingMetricsValuePerSeverity$critical' => 'The severity of the finding is critical and should be addressed immediately.
', 'FindingMetricsValuePerSeverity$high' => 'The severity of the finding is high and should be addressed as a near-term priority.
', 'FindingMetricsValuePerSeverity$info' => 'The finding is related to quality or readability improvements and not considered actionable.
', 'FindingMetricsValuePerSeverity$low' => 'The severity of the finding is low and does require action on its own.
', 'FindingMetricsValuePerSeverity$medium' => 'The severity of the finding is medium and should be addressed as a mid-term priority.
', ], ], 'EncryptionConfig' => [ 'base' => 'Information about account-level configuration.
', 'refs' => [ 'GetAccountConfigurationResponse$encryptionConfig' => '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.
The KMS key ARN you want to use for encryption. Defaults to service-side encryption if missing.
', 'UpdateAccountConfigurationResponse$encryptionConfig' => 'An EncryptionConfig object that contains the KMS key ARN to use for encryption.
A code associated with the type of error.
', ], ], 'FilePath' => [ 'base' => 'Information about the location of security vulnerabilities that Amazon CodeGuru Security detected in your code.
', 'refs' => [ 'Vulnerability$filePath' => 'An object that describes the location of the detected security vulnerability in your code.
', ], ], 'Finding' => [ 'base' => 'Information about a finding that was detected in your code.
', 'refs' => [ 'Findings$member' => NULL, ], ], 'FindingIdentifier' => [ 'base' => 'An object that contains information about a finding and the scan that generated it.
', 'refs' => [ 'FindingIdentifiers$member' => NULL, ], ], 'FindingIdentifiers' => [ 'base' => NULL, 'refs' => [ 'BatchGetFindingsRequest$findingIdentifiers' => 'A list of finding identifiers. Each identifier consists of a scanName and a findingId. You retrieve the findingId when you call GetFindings.
The severity of the issue in the code that generated a finding.
', 'refs' => [ 'AccountFindingsMetric$closedFindings' => 'The number of closed findings of each severity in an account on the specified date.
', 'AccountFindingsMetric$meanTimeToClose' => 'The average time it takes to close findings of each severity in days.
', 'AccountFindingsMetric$newFindings' => 'The number of new findings of each severity in account on the specified date.
', 'AccountFindingsMetric$openFindings' => 'The number of open findings of each severity in an account as of the specified date.
', 'MetricsSummary$openFindings' => 'The number of open findings of each severity in an account.
', ], ], 'Findings' => [ 'base' => NULL, 'refs' => [ 'BatchGetFindingsResponse$findings' => 'A list of all requested findings.
', 'GetFindingsResponse$findings' => 'A list of findings generated by the specified scan.
', ], ], 'FindingsMetricList' => [ 'base' => NULL, 'refs' => [ 'ListFindingsMetricsResponse$findingsMetrics' => 'A list of AccountFindingsMetric objects retrieved from the specified time interval.
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 number of open findings in the category.
', 'CodeLine$number' => 'The code line number.
', 'FilePath$endLine' => 'The last line number of the code snippet where the security vulnerability appears in your code.
', 'FilePath$startLine' => 'The first line number of the code snippet where the security vulnerability appears in your code.
', 'ScanNameWithFindingNum$findingNumber' => 'The number of open findings generated by a scan.
', 'Vulnerability$itemCount' => 'The number of times the vulnerability appears in your code.
', ], ], 'InternalServerException' => [ 'base' => 'The server encountered an internal error and is unable to complete the request.
', 'refs' => [], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfig$kmsKeyArn' => 'The KMS key ARN to use for encryption. This must be provided as a header when uploading your code resource.
', ], ], 'ListFindingsMetricsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFindingsMetricsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListFindingsMetricsRequest$maxResults' => '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.
The number of times a scan has been re-run on a revised resource.
', ], ], 'MetricsSummary' => [ 'base' => 'Information about summary metrics in an account.
', 'refs' => [ 'GetMetricsSummaryResponse$metricsSummary' => 'The summary metrics from the specified date.
', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'GetFindingsRequest$nextToken' => 'A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
A pagination token. You can use this in future calls to GetFindings to continue listing results after the current page.
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
A pagination token. You can use this in future calls to ListFindingMetrics to continue listing results after the current page.
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
A pagination token. You can use this in future calls to ListScans to continue listing results after the current page.
Information about the recommended course of action to remediate a finding.
', 'refs' => [ 'Remediation$recommendation' => 'An object that contains information about the recommended course of action to remediate a finding.
', ], ], 'ReferenceUrls' => [ 'base' => NULL, 'refs' => [ 'Vulnerability$referenceUrls' => 'One or more URL addresses that contain details about a vulnerability.
', ], ], 'RelatedVulnerabilities' => [ 'base' => NULL, 'refs' => [ 'Vulnerability$relatedVulnerabilities' => 'One or more vulnerabilities that are related to the vulnerability being described.
', ], ], 'Remediation' => [ 'base' => 'Information about how to remediate a finding.
', 'refs' => [ 'Finding$remediation' => 'An object that contains the details about how to remediate a finding.
', ], ], 'RequestHeaderMap' => [ 'base' => NULL, 'refs' => [ 'CreateUploadUrlResponse$requestHeaders' => 'A set of key-value pairs that contain the required headers when uploading your resource.
', ], ], 'Resource' => [ 'base' => 'Information about a resource, such as an Amazon S3 bucket or AWS Lambda function, that contains a finding.
', 'refs' => [ 'Finding$resource' => 'The resource where Amazon CodeGuru Security detected a finding.
', ], ], 'ResourceId' => [ 'base' => 'The identifier for a resource object that contains resources where a finding was detected.
', 'refs' => [ 'CreateScanRequest$resourceId' => 'The identifier for an input resource used to create a scan.
', 'CreateScanResponse$resourceId' => 'The identifier for the resource object that contains resources that were scanned.
', ], ], 'ResourceNotFoundException' => [ 'base' => 'The resource specified in the request was not found.
', 'refs' => [], ], 'S3Url' => [ 'base' => NULL, 'refs' => [ 'CreateUploadUrlResponse$s3Url' => 'A pre-signed S3 URL. You can upload the code file you want to scan and add the required requestHeaders using any HTTP client.
The name of the scan that generated the finding.
', 'CreateScanRequest$scanName' => '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 name of the scan.
', 'CreateUploadUrlRequest$scanName' => 'The name of the scan that will use the uploaded resource. CodeGuru Security uses the unique scan name to track revisions across multiple scans of the same resource. Use this scanName when you call CreateScan on the code resource you upload to this URL.
The name of the scan you want to retrieve findings from.
', 'GetScanRequest$scanName' => 'The name of the scan you want to view details about.
', 'GetScanResponse$scanName' => 'The name of the scan.
', 'ScanSummary$scanName' => 'The name of the scan.
', ], ], 'ScanNameArn' => [ 'base' => NULL, 'refs' => [ 'CreateScanResponse$scanNameArn' => 'The ARN for the scan name.
', 'GetScanResponse$scanNameArn' => 'The ARN for the scan name.
', 'ListTagsForResourceRequest$resourceArn' => 'The ARN of the ScanName object. You can retrieve this ARN by calling ListScans or GetScan.
The ARN for the scan name.
', 'TagResourceRequest$resourceArn' => '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 ListScans or GetScan.
Information about a scan with open findings.
', 'refs' => [ 'ScansWithMostOpenCriticalFindings$member' => NULL, 'ScansWithMostOpenFindings$member' => NULL, ], ], 'ScanState' => [ 'base' => NULL, 'refs' => [ 'CreateScanResponse$scanState' => 'The current state of the scan. Returns either InProgress, Successful, or Failed.
The current state of the scan. Pass either InProgress, Successful, or Failed.
The state of the scan. A scan can be In Progress, Complete, or Failed.
A list of ScanSummary objects with information about all scans in an account.
Information about a scan.
', 'refs' => [ 'ScanSummaries$member' => NULL, ], ], 'ScanType' => [ 'base' => NULL, 'refs' => [ 'CreateScanRequest$scanType' => 'The type of scan, either Standard or Express. Defaults to Standard type if missing.
Express scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. Standard scans have standard resource limits and use the full set of detectors to analyze your code.
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 in an account.
The severity of the finding.
', ], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'Finding$status' => 'The status of the finding. A finding status can be open or closed.
', 'GetFindingsRequest$status' => 'The status of the findings you want to get. Pass either Open, Closed, or All.
The identifier for the error.
', 'AccessDeniedException$message' => 'Description of the error.
', 'AccessDeniedException$resourceId' => 'The identifier for the resource you don\'t have access to.
', 'AccessDeniedException$resourceType' => 'The type of resource you don\'t have access to.
', 'BatchGetFindingsError$findingId' => 'The finding ID of the finding that was not fetched.
', 'BatchGetFindingsError$message' => 'Describes the error.
', 'CategoryWithFindingNum$categoryName' => 'The name of the finding category. A finding category is determined by the detector that detected the finding.
', 'CodeLine$content' => 'The code that contains a vulnerability.
', 'ConflictException$errorCode' => 'The identifier for the error.
', 'ConflictException$message' => 'Description of the error.
', 'ConflictException$resourceId' => 'The identifier for the service resource associated with the request.
', 'ConflictException$resourceType' => 'The type of resource associated with the request.
', 'DetectorTags$member' => NULL, 'FilePath$name' => 'The name of the file.
', 'FilePath$path' => 'The path to the resource with the security vulnerability.
', 'Finding$description' => 'A description of the finding.
', 'Finding$detectorId' => 'The identifier for the detector that detected the finding in your code. A detector is a defined rule based on industry standards and AWS best practices.
', 'Finding$detectorName' => 'The name of the detector that identified the security vulnerability in your code.
', 'Finding$generatorId' => 'The identifier for the component that generated a finding such as AWSCodeGuruSecurity or AWSInspector.
', 'Finding$id' => 'The identifier for a finding.
', 'Finding$ruleId' => 'The identifier for the rule that generated the finding.
', 'Finding$title' => 'The title of the finding.
', 'Finding$type' => 'The type of finding.
', 'FindingIdentifier$findingId' => 'The identifier for a finding.
', 'FindingIdentifier$scanName' => 'The name of the scan that generated the finding.
', 'InternalServerException$error' => 'The internal error encountered by the server.
', 'InternalServerException$message' => 'Description of the error.
', 'Recommendation$text' => 'The recommended course of action to remediate the finding.
', 'Recommendation$url' => 'The URL address to the recommendation for remediating the finding.
', 'ReferenceUrls$member' => NULL, 'RelatedVulnerabilities$member' => NULL, 'Resource$id' => 'The identifier for the resource.
', 'Resource$subResourceId' => 'The identifier for a section of the resource, such as an AWS Lambda layer.
', 'ResourceNotFoundException$errorCode' => 'The identifier for the error.
', 'ResourceNotFoundException$message' => 'Description of the error.
', 'ResourceNotFoundException$resourceId' => 'The identifier for the resource that was not found.
', 'ResourceNotFoundException$resourceType' => 'The type of resource that was not found.
', 'ScanNameWithFindingNum$scanName' => 'The name of the scan.
', 'SuggestedFix$code' => 'The suggested code to add to your file.
', 'SuggestedFix$description' => 'A description of the suggested code fix and why it is being suggested.
', 'ThrottlingException$errorCode' => 'The identifier for the error.
', 'ThrottlingException$message' => 'Description of the error.
', 'ThrottlingException$quotaCode' => 'The identifier for the originating quota.
', 'ThrottlingException$serviceCode' => 'The identifier for the originating service.
', 'ValidationException$errorCode' => 'The identifier for the error.
', 'ValidationException$message' => 'Description of the error.
', 'ValidationExceptionField$message' => 'Describes the exception.
', 'ValidationExceptionField$name' => 'The name of the exception.
', 'Vulnerability$id' => 'The identifier for the vulnerability.
', ], ], 'SuggestedFix' => [ 'base' => 'Information about the suggested code fix to remediate a finding.
', 'refs' => [ 'SuggestedFixes$member' => NULL, ], ], 'SuggestedFixes' => [ 'base' => NULL, 'refs' => [ 'Remediation$suggestedFixes' => 'A list of SuggestedFix objects. Each object contains information about a suggested code fix to remediate the finding.
A list of keys for each tag you want to remove from a scan.
', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'CreateScanRequest$tags' => 'An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:
A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.
An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:
A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.
An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:
A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.
An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
The request was denied due to request throttling.
', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'AccountFindingsMetric$date' => 'The date from which the finding metrics were retrieved.
', 'Finding$createdAt' => 'The time when the finding was created.
', 'Finding$updatedAt' => 'The time when the finding was last updated. Findings are updated when you remediate them or when the finding code location changes.
', 'GetMetricsSummaryRequest$date' => '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.
', 'GetScanResponse$createdAt' => 'The time the scan was created.
', 'GetScanResponse$updatedAt' => 'The time when the scan was last updated. Only available for STANDARD scan types.
The end date of the interval which you want to retrieve metrics from.
', 'ListFindingsMetricsRequest$startDate' => 'The start date of the interval which you want to retrieve metrics from.
', 'MetricsSummary$date' => 'The date from which the metrics summary information was retrieved.
', 'ScanSummary$createdAt' => 'The time when the scan was created.
', 'ScanSummary$updatedAt' => 'The time the scan was last updated. A scan is updated when it is re-run.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAccountConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAccountConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'Uuid' => [ 'base' => NULL, 'refs' => [ 'CreateScanResponse$runId' => 'UUID that identifies the individual scan run.
', 'CreateUploadUrlResponse$codeArtifactId' => 'The identifier for the uploaded code resource.
', 'GetScanRequest$runId' => 'UUID that identifies the individual scan run you want to view details about. You retrieve this when you call the CreateScan operation. Defaults to the latest scan run if missing.
UUID that identifies the individual scan run.
', 'ResourceId$codeArtifactId' => 'The identifier for the code file uploaded to the resource where a finding was detected.
', 'ScanSummary$runId' => 'The identifier for the scan run.
', ], ], 'ValidationException' => [ 'base' => 'The input fails to satisfy the specified constraints.
', 'refs' => [], ], 'ValidationExceptionField' => [ 'base' => 'Information about a validation exception.
', 'refs' => [ 'ValidationExceptionFieldList$member' => NULL, ], ], 'ValidationExceptionFieldList' => [ 'base' => NULL, 'refs' => [ 'ValidationException$fieldList' => 'The field that caused the error, if applicable.
', ], ], 'ValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ValidationException$reason' => 'The reason the request failed validation.
', ], ], 'Vulnerability' => [ 'base' => 'Information about a security vulnerability that Amazon CodeGuru Security detected.
', 'refs' => [ 'Finding$vulnerability' => 'An object that describes the detected security vulnerability.
', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon CodeGuru Security is in preview release and is subject to change.
This section provides documentation for the Amazon CodeGuru Security API operations. CodeGuru Security is a service that uses program analysis and machine learning to detect security policy violations and vulnerabilities, and recommends ways to address these security risks.
By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the Amazon CodeGuru Security User Guide.
', 'operations' => [ 'BatchGetFindings' => 'Returns a list of requested findings from standard scans.
', 'CreateScan' => 'Use to create a scan using code uploaded to an Amazon S3 bucket.
', 'CreateUploadUrl' => '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' => 'Use to get the encryption configuration for an account.
', 'GetFindings' => 'Returns a list of all findings generated by a particular scan.
', 'GetMetricsSummary' => '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' => 'Returns details about a scan, including whether or not a scan has completed.
', 'ListFindingsMetrics' => 'Returns metrics about all findings in an account within a specified time range.
', 'ListScans' => 'Returns a list of all scans in an account. Does not return EXPRESS scans.
Returns a list of all tags associated with a scan.
', 'TagResource' => 'Use to add one or more tags to an existing scan.
', 'UntagResource' => 'Use to remove one or more tags from an existing scan.
', 'UpdateAccountConfiguration' => 'Use to update the encryption configuration for an account.
', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => 'You do not have sufficient access to perform this action.
', 'refs' => [], ], 'AccountFindingsMetric' => [ 'base' => 'A summary of findings metrics for an account on a specified date.
', 'refs' => [ 'FindingsMetricList$member' => NULL, ], ], 'AnalysisType' => [ 'base' => NULL, 'refs' => [ 'CreateScanRequest$analysisType' => 'The type of analysis you want CodeGuru Security to perform in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings. Defaults to Security type if missing.
The type of analysis CodeGuru Security performed in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings.
Contains information about the error that caused a finding to fail to be retrieved.
', 'refs' => [ 'BatchGetFindingsErrors$member' => NULL, ], ], 'BatchGetFindingsErrors' => [ 'base' => NULL, 'refs' => [ 'BatchGetFindingsResponse$failedFindings' => 'A list of errors for individual findings which were not fetched. Each BatchGetFindingsError contains the scanName, findingId, errorCode and error message.
A list of CategoryWithFindingNum objects for the top 5 finding categories with the most findings.
Information about a finding category with open findings.
', 'refs' => [ 'CategoriesWithMostFindings$member' => NULL, ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateScanRequest$clientToken' => 'The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.
', ], ], 'CodeLine' => [ 'base' => 'The line of code where a finding was detected.
', 'refs' => [ 'CodeSnippet$member' => NULL, ], ], 'CodeSnippet' => [ 'base' => NULL, 'refs' => [ 'FilePath$codeSnippet' => 'A list of CodeLine objects that describe where the security vulnerability appears in your code.
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.
', 'refs' => [], ], 'CreateScanRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateScanResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUploadUrlRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUploadUrlResponse' => [ 'base' => NULL, 'refs' => [], ], 'DetectorTags' => [ 'base' => NULL, 'refs' => [ 'Finding$detectorTags' => 'One or more tags or categorizations that are associated with a detector. These tags are defined by type, programming language, or other classification such as maintainability or consistency.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'FindingMetricsValuePerSeverity$critical' => 'A numeric value corresponding to a critical finding.
', 'FindingMetricsValuePerSeverity$high' => 'A numeric value corresponding to a high severity finding.
', 'FindingMetricsValuePerSeverity$info' => 'A numeric value corresponding to an informational finding.
', 'FindingMetricsValuePerSeverity$low' => 'A numeric value corresponding to a low severity finding.
', 'FindingMetricsValuePerSeverity$medium' => 'A numeric value corresponding to a medium severity finding.
', ], ], 'EncryptionConfig' => [ 'base' => 'Information about the encryption configuration for an account. Required to 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 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.
', 'UpdateAccountConfigurationResponse$encryptionConfig' => '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.
A code associated with the type of error.
', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'GetScanResponse$errorMessage' => 'Details about the error that causes a scan to fail to be retrieved.
', ], ], 'FilePath' => [ 'base' => 'Information about the location of security vulnerabilities that Amazon CodeGuru Security detected in your code.
', 'refs' => [ 'Vulnerability$filePath' => 'An object that describes the location of the detected security vulnerability in your code.
', ], ], 'Finding' => [ 'base' => 'Information about a finding that was detected in your code.
', 'refs' => [ 'Findings$member' => NULL, ], ], 'FindingIdentifier' => [ 'base' => 'An object that contains information about a finding and the scan that generated it.
', 'refs' => [ 'FindingIdentifiers$member' => NULL, ], ], 'FindingIdentifiers' => [ 'base' => NULL, 'refs' => [ 'BatchGetFindingsRequest$findingIdentifiers' => 'A list of finding identifiers. Each identifier consists of a scanName and a findingId. You retrieve the findingId when you call GetFindings.
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.
', 'refs' => [ 'AccountFindingsMetric$closedFindings' => 'The number of closed findings of each severity on the specified date.
', 'AccountFindingsMetric$meanTimeToClose' => 'The average time in days it takes to close findings of each severity as of a specified date.
', 'AccountFindingsMetric$newFindings' => 'The number of new findings of each severity on the specified date.
', 'AccountFindingsMetric$openFindings' => 'The number of open findings of each severity as of the specified date.
', 'MetricsSummary$openFindings' => 'The number of open findings of each severity.
', ], ], 'Findings' => [ 'base' => NULL, 'refs' => [ 'BatchGetFindingsResponse$findings' => 'A list of all findings which were successfully fetched.
', 'GetFindingsResponse$findings' => 'A list of findings generated by the specified scan.
', ], ], 'FindingsMetricList' => [ 'base' => NULL, 'refs' => [ 'ListFindingsMetricsResponse$findingsMetrics' => 'A list of AccountFindingsMetric objects retrieved from the specified time interval.
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 number of open findings in the category.
', 'CodeLine$number' => 'The code line number.
', 'FilePath$endLine' => 'The last line number of the code snippet where the security vulnerability appears in your code.
', 'FilePath$startLine' => 'The first line number of the code snippet where the security vulnerability appears in your code.
', 'ScanNameWithFindingNum$findingNumber' => 'The number of findings generated by a scan.
', 'Vulnerability$itemCount' => 'The number of times the vulnerability appears in your code.
', ], ], 'InternalServerException' => [ 'base' => 'The server encountered an internal error and is unable to complete the request.
', 'refs' => [], ], 'KmsKeyArn' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfig$kmsKeyArn' => 'The KMS key ARN that is used for encryption. If an AWS-managed key is used for encryption, returns empty.
', ], ], 'ListFindingsMetricsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListFindingsMetricsRequestMaxResultsInteger' => [ 'base' => NULL, 'refs' => [ 'ListFindingsMetricsRequest$maxResults' => '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 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 number of times a scan has been re-run on a revised resource.
', ], ], 'MetricsSummary' => [ 'base' => 'A summary of metrics for an account as of a specified date.
', 'refs' => [ 'GetMetricsSummaryResponse$metricsSummary' => 'The summary metrics from the specified date.
', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'GetFindingsRequest$nextToken' => 'A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
A pagination token. You can use this in future calls to GetFindings to continue listing results after the current page.
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
A pagination token. You can use this in future calls to ListFindingMetrics to continue listing results after the current page.
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
A pagination token. You can use this in future calls to ListScans to continue listing results after the current page.
Information about the recommended course of action to remediate a finding.
', 'refs' => [ 'Remediation$recommendation' => 'An object that contains information about the recommended course of action to remediate a finding.
', ], ], 'ReferenceUrls' => [ 'base' => NULL, 'refs' => [ 'Vulnerability$referenceUrls' => 'One or more URL addresses that contain details about a vulnerability.
', ], ], 'RelatedVulnerabilities' => [ 'base' => NULL, 'refs' => [ 'Vulnerability$relatedVulnerabilities' => 'One or more vulnerabilities that are related to the vulnerability being described.
', ], ], 'Remediation' => [ 'base' => 'Information about how to remediate a finding.
', 'refs' => [ 'Finding$remediation' => 'An object that contains the details about how to remediate a finding.
', ], ], 'RequestHeaderMap' => [ 'base' => NULL, 'refs' => [ 'CreateUploadUrlResponse$requestHeaders' => 'A set of key-value pairs that contain the required headers when uploading your resource.
', ], ], 'Resource' => [ 'base' => 'Information about a resource that contains a finding.
', 'refs' => [ 'Finding$resource' => 'The resource where Amazon CodeGuru Security detected a finding.
', ], ], 'ResourceId' => [ 'base' => 'The identifier for a resource object that contains resources to scan. Specifying a codeArtifactId is required to create a scan.
', 'refs' => [ 'CreateScanRequest$resourceId' => 'The identifier for the resource object to be scanned.
', 'CreateScanResponse$resourceId' => 'The identifier for the resource object that contains resources that were scanned.
', ], ], 'ResourceNotFoundException' => [ 'base' => 'The resource specified in the request was not found.
', 'refs' => [], ], 'S3Url' => [ 'base' => NULL, 'refs' => [ 'CreateUploadUrlResponse$s3Url' => 'A pre-signed S3 URL. You can upload the code file you want to scan with the required requestHeaders using any HTTP client.
The name of the scan that generated the finding.
', 'CreateScanRequest$scanName' => '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 name of the scan.
', 'CreateUploadUrlRequest$scanName' => 'The name of the scan that will use the uploaded resource. CodeGuru Security uses the unique scan name to track revisions across multiple scans of the same resource. Use this scanName when you call CreateScan on the code resource you upload to this URL.
The name of the scan you want to retrieve findings from.
', 'GetScanRequest$scanName' => 'The name of the scan you want to view details about.
', 'GetScanResponse$scanName' => 'The name of the scan.
', 'ScanSummary$scanName' => 'The name of the scan.
', ], ], 'ScanNameArn' => [ 'base' => NULL, 'refs' => [ 'CreateScanResponse$scanNameArn' => 'The ARN for the scan name.
', 'GetScanResponse$scanNameArn' => 'The ARN for the scan name.
', 'ListTagsForResourceRequest$resourceArn' => 'The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.
The ARN for the scan name.
', 'TagResourceRequest$resourceArn' => '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 CreateScan, ListScans, or GetScan.
Information about the number of findings generated by a scan.
', 'refs' => [ 'ScansWithMostOpenCriticalFindings$member' => NULL, 'ScansWithMostOpenFindings$member' => NULL, ], ], 'ScanState' => [ 'base' => NULL, 'refs' => [ 'CreateScanResponse$scanState' => 'The current state of the scan. Returns either InProgress, Successful, or Failed.
The current state of the scan. Returns either InProgress, Successful, or Failed.
The state of the scan. A scan can be In Progress, Complete, or Failed.
A list of ScanSummary objects with information about all scans in an account.
Information about a scan.
', 'refs' => [ 'ScanSummaries$member' => NULL, ], ], 'ScanType' => [ 'base' => NULL, 'refs' => [ 'CreateScanRequest$scanType' => 'The type of scan, either Standard or Express. Defaults to Standard type if missing.
Express scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. Standard scans have standard resource limits and use the full set of detectors to analyze your code.
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 findings.
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' => [ 'base' => NULL, 'refs' => [ 'Finding$status' => 'The status of the finding. A finding status can be open or closed.
', 'GetFindingsRequest$status' => 'The status of the findings you want to get. Pass either Open, Closed, or All.
The identifier for the error.
', 'AccessDeniedException$message' => 'Description of the error.
', 'AccessDeniedException$resourceId' => 'The identifier for the resource you don\'t have access to.
', 'AccessDeniedException$resourceType' => 'The type of resource you don\'t have access to.
', 'BatchGetFindingsError$findingId' => 'The finding ID of the finding that was not fetched.
', 'BatchGetFindingsError$message' => 'Describes the error.
', 'CategoryWithFindingNum$categoryName' => 'The name of the finding category. A finding category is determined by the detector that detected the finding.
', 'CodeLine$content' => 'The code that contains a vulnerability.
', 'ConflictException$errorCode' => 'The identifier for the error.
', 'ConflictException$message' => 'Description of the error.
', 'ConflictException$resourceId' => 'The identifier for the service resource associated with the request.
', 'ConflictException$resourceType' => 'The type of resource associated with the request.
', 'DetectorTags$member' => NULL, 'FilePath$name' => 'The name of the file.
', 'FilePath$path' => 'The path to the resource with the security vulnerability.
', 'Finding$description' => 'A description of the finding.
', 'Finding$detectorId' => 'The identifier for the detector that detected the finding in your code. A detector is a defined rule based on industry standards and AWS best practices.
', 'Finding$detectorName' => 'The name of the detector that identified the security vulnerability in your code.
', 'Finding$generatorId' => 'The identifier for the component that generated a finding such as AmazonCodeGuruSecurity.
', 'Finding$id' => 'The identifier for a finding.
', 'Finding$ruleId' => 'The identifier for the rule that generated the finding.
', 'Finding$title' => 'The title of the finding.
', 'Finding$type' => 'The type of finding.
', 'FindingIdentifier$findingId' => 'The identifier for a finding.
', 'FindingIdentifier$scanName' => 'The name of the scan that generated the finding.
', 'InternalServerException$error' => 'The internal error encountered by the server.
', 'InternalServerException$message' => 'Description of the error.
', 'Recommendation$text' => 'The recommended course of action to remediate the finding.
', 'Recommendation$url' => 'The URL address to the recommendation for remediating the finding.
', 'ReferenceUrls$member' => NULL, 'RelatedVulnerabilities$member' => NULL, 'Resource$id' => 'The scanName of the scan that was run on the resource.
The identifier for a section of the resource.
', 'ResourceNotFoundException$errorCode' => 'The identifier for the error.
', 'ResourceNotFoundException$message' => 'Description of the error.
', 'ResourceNotFoundException$resourceId' => 'The identifier for the resource that was not found.
', 'ResourceNotFoundException$resourceType' => 'The type of resource that was not found.
', 'ScanNameWithFindingNum$scanName' => 'The name of the scan.
', 'SuggestedFix$code' => 'The suggested code fix. If applicable, includes code patch to replace your source code.
', 'SuggestedFix$description' => 'A description of the suggested code fix and why it is being suggested.
', 'ThrottlingException$errorCode' => 'The identifier for the error.
', 'ThrottlingException$message' => 'Description of the error.
', 'ThrottlingException$quotaCode' => 'The identifier for the originating quota.
', 'ThrottlingException$serviceCode' => 'The identifier for the originating service.
', 'ValidationException$errorCode' => 'The identifier for the error.
', 'ValidationException$message' => 'Description of the error.
', 'ValidationExceptionField$message' => 'Describes the exception.
', 'ValidationExceptionField$name' => 'The name of the exception.
', 'Vulnerability$id' => 'The identifier for the vulnerability.
', ], ], 'SuggestedFix' => [ 'base' => 'Information about the suggested code fix to remediate a finding.
', 'refs' => [ 'SuggestedFixes$member' => NULL, ], ], 'SuggestedFixes' => [ 'base' => NULL, 'refs' => [ 'Remediation$suggestedFixes' => 'A list of SuggestedFix objects. Each object contains information about a suggested code fix to remediate the finding.
A list of keys for each tag you want to remove from a scan.
', ], ], 'TagMap' => [ 'base' => NULL, 'refs' => [ 'CreateScanRequest$tags' => 'An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:
A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.
An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:
A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.
An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:
A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.
An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
The request was denied due to request throttling.
', 'refs' => [], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'AccountFindingsMetric$date' => 'The date from which the findings metrics were retrieved.
', 'Finding$createdAt' => 'The time when the finding was created.
', 'Finding$updatedAt' => 'The time when the finding was last updated. Findings are updated when you remediate them or when the finding code location changes.
', 'GetMetricsSummaryRequest$date' => 'The date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years.
', 'GetScanResponse$createdAt' => 'The time the scan was created.
', 'GetScanResponse$updatedAt' => 'The time when the scan was last updated. Only available for STANDARD scan types.
The end date of the interval which you want to retrieve metrics from. Round to the nearest day.
', 'ListFindingsMetricsRequest$startDate' => 'The start date of the interval which you want to retrieve metrics from. Rounds to the nearest day.
', 'MetricsSummary$date' => 'The date from which the metrics summary information was retrieved.
', 'ScanSummary$createdAt' => 'The time when the scan was created.
', 'ScanSummary$updatedAt' => 'The time the scan was last updated. A scan is updated when it is re-run.
', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAccountConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateAccountConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'Uuid' => [ 'base' => NULL, 'refs' => [ 'CreateScanResponse$runId' => 'UUID that identifies the individual scan run.
', 'CreateUploadUrlResponse$codeArtifactId' => 'The identifier for the uploaded code resource. Pass this to CreateScan to use the uploaded resources.
UUID that identifies the individual scan run you want to view details about. You retrieve this when you call the CreateScan operation. Defaults to the latest scan run if missing.
UUID that identifies the individual scan run.
', 'ResourceId$codeArtifactId' => 'The identifier for the code file uploaded to the resource object. Returned by CreateUploadUrl when you upload resources to be scanned.
The identifier for the scan run.
', ], ], 'ValidationException' => [ 'base' => 'The input fails to satisfy the specified constraints.
', 'refs' => [], ], 'ValidationExceptionField' => [ 'base' => 'Information about a validation exception.
', 'refs' => [ 'ValidationExceptionFieldList$member' => NULL, ], ], 'ValidationExceptionFieldList' => [ 'base' => NULL, 'refs' => [ 'ValidationException$fieldList' => 'The field that caused the error, if applicable.
', ], ], 'ValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ValidationException$reason' => 'The reason the request failed validation.
', ], ], 'Vulnerability' => [ 'base' => 'Information about a security vulnerability that Amazon CodeGuru Security detected.
', 'refs' => [ 'Finding$vulnerability' => 'An object that describes the detected security vulnerability.
', ], ], ],]; diff --git a/src/data/codeguru-security/2018-05-10/endpoint-rule-set-1.json b/src/data/codeguru-security/2018-05-10/endpoint-rule-set-1.json index 9c6f96dac9..bea431e421 100644 --- a/src/data/codeguru-security/2018-05-10/endpoint-rule-set-1.json +++ b/src/data/codeguru-security/2018-05-10/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -59,7 +58,6 @@ }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -87,13 +85,14 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [ @@ -106,7 +105,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -120,7 +118,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -143,7 +140,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -178,11 +174,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -193,16 +187,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -216,14 +213,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -232,15 +227,14 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -251,16 +245,19 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -274,7 +271,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -294,11 +290,9 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -309,20 +303,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], - "type": "tree", "rules": [ { "conditions": [], @@ -333,18 +329,22 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } - ] + ], + "type": "tree" } ] } \ No newline at end of file diff --git a/src/data/codeguru-security/2018-05-10/endpoint-rule-set-1.json.php b/src/data/codeguru-security/2018-05-10/endpoint-rule-set-1.json.php index 335a31ab94..8e31599d6c 100644 --- a/src/data/codeguru-security/2018-05-10/endpoint-rule-set-1.json.php +++ b/src/data/codeguru-security/2018-05-10/endpoint-rule-set-1.json.php @@ -1,3 +1,3 @@ '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Region', ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://codeguru-security-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://codeguru-security-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://codeguru-security.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], ], [ 'conditions' => [], 'type' => 'tree', 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://codeguru-security.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], ], ], ], ], ], [ 'conditions' => [], 'error' => 'Invalid Configuration: Missing Region', 'type' => 'error', ], ], ], ],]; +return [ 'version' => '1.0', 'parameters' => [ 'Region' => [ 'builtIn' => 'AWS::Region', 'required' => false, 'documentation' => 'The AWS region used to dispatch the request.', 'type' => 'String', ], 'UseDualStack' => [ 'builtIn' => 'AWS::UseDualStack', 'required' => true, 'default' => false, 'documentation' => 'When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.', 'type' => 'Boolean', ], 'UseFIPS' => [ 'builtIn' => 'AWS::UseFIPS', 'required' => true, 'default' => false, 'documentation' => 'When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.', 'type' => 'Boolean', ], 'Endpoint' => [ 'builtIn' => 'SDK::Endpoint', 'required' => false, 'documentation' => 'Override the endpoint used to send this request', 'type' => 'String', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Endpoint', ], ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', 'type' => 'error', ], [ 'conditions' => [], 'endpoint' => [ 'url' => [ 'ref' => 'Endpoint', ], 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'isSet', 'argv' => [ [ 'ref' => 'Region', ], ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'aws.partition', 'argv' => [ [ 'ref' => 'Region', ], ], 'assign' => 'PartitionResult', ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], ], ], [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'rules' => [ [ 'conditions' => [], 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://codeguru-security-fips.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', 'type' => 'error', ], ], 'type' => 'tree', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseFIPS', ], true, ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsFIPS', ], ], true, ], ], ], 'rules' => [ [ 'conditions' => [], 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://codeguru-security-fips.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'error' => 'FIPS is enabled but this partition does not support FIPS', 'type' => 'error', ], ], 'type' => 'tree', ], [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ [ 'ref' => 'UseDualStack', ], true, ], ], ], 'rules' => [ [ 'conditions' => [ [ 'fn' => 'booleanEquals', 'argv' => [ true, [ 'fn' => 'getAttr', 'argv' => [ [ 'ref' => 'PartitionResult', ], 'supportsDualStack', ], ], ], ], ], 'rules' => [ [ 'conditions' => [], 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://codeguru-security.{Region}.{PartitionResult#dualStackDnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'error' => 'DualStack is enabled but this partition does not support DualStack', 'type' => 'error', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'rules' => [ [ 'conditions' => [], 'endpoint' => [ 'url' => 'https://codeguru-security.{Region}.{PartitionResult#dnsSuffix}', 'properties' => [], 'headers' => [], ], 'type' => 'endpoint', ], ], 'type' => 'tree', ], ], 'type' => 'tree', ], ], 'type' => 'tree', ], [ 'conditions' => [], 'error' => 'Invalid Configuration: Missing Region', 'type' => 'error', ], ], 'type' => 'tree', ], ],]; diff --git a/src/data/elasticache/2015-02-02/api-2.json b/src/data/elasticache/2015-02-02/api-2.json index e01d82c54d..e4609ea90e 100644 --- a/src/data/elasticache/2015-02-02/api-2.json +++ b/src/data/elasticache/2015-02-02/api-2.json @@ -4,6 +4,7 @@ "apiVersion":"2015-02-02", "endpointPrefix":"elasticache", "protocol":"query", + "protocols":["query"], "serviceFullName":"Amazon ElastiCache", "serviceId":"ElastiCache", "signatureVersion":"v4", diff --git a/src/data/elasticache/2015-02-02/api-2.json.php b/src/data/elasticache/2015-02-02/api-2.json.php index 4d29853fb4..370316e185 100644 --- a/src/data/elasticache/2015-02-02/api-2.json.php +++ b/src/data/elasticache/2015-02-02/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2015-02-02', 'endpointPrefix' => 'elasticache', 'protocol' => 'query', 'serviceFullName' => 'Amazon ElastiCache', 'serviceId' => 'ElastiCache', 'signatureVersion' => 'v4', 'uid' => 'elasticache-2015-02-02', 'xmlNamespace' => 'http://elasticache.amazonaws.com/doc/2015-02-02/', ], 'operations' => [ 'AddTagsToResource' => [ 'name' => 'AddTagsToResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddTagsToResourceMessage', ], 'output' => [ 'shape' => 'TagListMessage', 'resultWrapper' => 'AddTagsToResourceResult', ], 'errors' => [ [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'CacheSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'ReservedCacheNodeNotFoundFault', ], [ 'shape' => 'SnapshotNotFoundFault', ], [ 'shape' => 'UserNotFoundFault', ], [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheStateFault', ], [ 'shape' => 'ServerlessCacheSnapshotNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheSnapshotStateFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidARNFault', ], ], ], 'AuthorizeCacheSecurityGroupIngress' => [ 'name' => 'AuthorizeCacheSecurityGroupIngress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AuthorizeCacheSecurityGroupIngressMessage', ], 'output' => [ 'shape' => 'AuthorizeCacheSecurityGroupIngressResult', 'resultWrapper' => 'AuthorizeCacheSecurityGroupIngressResult', ], 'errors' => [ [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'InvalidCacheSecurityGroupStateFault', ], [ 'shape' => 'AuthorizationAlreadyExistsFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'BatchApplyUpdateAction' => [ 'name' => 'BatchApplyUpdateAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchApplyUpdateActionMessage', ], 'output' => [ 'shape' => 'UpdateActionResultsMessage', 'resultWrapper' => 'BatchApplyUpdateActionResult', ], 'errors' => [ [ 'shape' => 'ServiceUpdateNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'BatchStopUpdateAction' => [ 'name' => 'BatchStopUpdateAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchStopUpdateActionMessage', ], 'output' => [ 'shape' => 'UpdateActionResultsMessage', 'resultWrapper' => 'BatchStopUpdateActionResult', ], 'errors' => [ [ 'shape' => 'ServiceUpdateNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'CompleteMigration' => [ 'name' => 'CompleteMigration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CompleteMigrationMessage', ], 'output' => [ 'shape' => 'CompleteMigrationResponse', 'resultWrapper' => 'CompleteMigrationResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'ReplicationGroupNotUnderMigrationFault', ], ], ], 'CopyServerlessCacheSnapshot' => [ 'name' => 'CopyServerlessCacheSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyServerlessCacheSnapshotRequest', ], 'output' => [ 'shape' => 'CopyServerlessCacheSnapshotResponse', 'resultWrapper' => 'CopyServerlessCacheSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServerlessCacheSnapshotAlreadyExistsFault', ], [ 'shape' => 'ServerlessCacheSnapshotNotFoundFault', ], [ 'shape' => 'ServerlessCacheSnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidServerlessCacheSnapshotStateFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'CopySnapshot' => [ 'name' => 'CopySnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopySnapshotMessage', ], 'output' => [ 'shape' => 'CopySnapshotResult', 'resultWrapper' => 'CopySnapshotResult', ], 'errors' => [ [ 'shape' => 'SnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotNotFoundFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidSnapshotStateFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'CreateCacheCluster' => [ 'name' => 'CreateCacheCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCacheClusterMessage', ], 'output' => [ 'shape' => 'CreateCacheClusterResult', 'resultWrapper' => 'CreateCacheClusterResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'CacheClusterAlreadyExistsFault', ], [ 'shape' => 'InsufficientCacheClusterCapacityFault', ], [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'CacheSubnetGroupNotFoundFault', ], [ 'shape' => 'ClusterQuotaForCustomerExceededFault', ], [ 'shape' => 'NodeQuotaForClusterExceededFault', ], [ 'shape' => 'NodeQuotaForCustomerExceededFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'CreateCacheParameterGroup' => [ 'name' => 'CreateCacheParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCacheParameterGroupMessage', ], 'output' => [ 'shape' => 'CreateCacheParameterGroupResult', 'resultWrapper' => 'CreateCacheParameterGroupResult', ], 'errors' => [ [ 'shape' => 'CacheParameterGroupQuotaExceededFault', ], [ 'shape' => 'CacheParameterGroupAlreadyExistsFault', ], [ 'shape' => 'InvalidCacheParameterGroupStateFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'CreateCacheSecurityGroup' => [ 'name' => 'CreateCacheSecurityGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCacheSecurityGroupMessage', ], 'output' => [ 'shape' => 'CreateCacheSecurityGroupResult', 'resultWrapper' => 'CreateCacheSecurityGroupResult', ], 'errors' => [ [ 'shape' => 'CacheSecurityGroupAlreadyExistsFault', ], [ 'shape' => 'CacheSecurityGroupQuotaExceededFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'CreateCacheSubnetGroup' => [ 'name' => 'CreateCacheSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCacheSubnetGroupMessage', ], 'output' => [ 'shape' => 'CreateCacheSubnetGroupResult', 'resultWrapper' => 'CreateCacheSubnetGroupResult', ], 'errors' => [ [ 'shape' => 'CacheSubnetGroupAlreadyExistsFault', ], [ 'shape' => 'CacheSubnetGroupQuotaExceededFault', ], [ 'shape' => 'CacheSubnetQuotaExceededFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'SubnetNotAllowedFault', ], ], ], 'CreateGlobalReplicationGroup' => [ 'name' => 'CreateGlobalReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGlobalReplicationGroupMessage', ], 'output' => [ 'shape' => 'CreateGlobalReplicationGroupResult', 'resultWrapper' => 'CreateGlobalReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'GlobalReplicationGroupAlreadyExistsFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'CreateReplicationGroup' => [ 'name' => 'CreateReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateReplicationGroupMessage', ], 'output' => [ 'shape' => 'CreateReplicationGroupResult', 'resultWrapper' => 'CreateReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'ReplicationGroupAlreadyExistsFault', ], [ 'shape' => 'InvalidUserGroupStateFault', ], [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'InsufficientCacheClusterCapacityFault', ], [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'CacheSubnetGroupNotFoundFault', ], [ 'shape' => 'ClusterQuotaForCustomerExceededFault', ], [ 'shape' => 'NodeQuotaForClusterExceededFault', ], [ 'shape' => 'NodeQuotaForCustomerExceededFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'NodeGroupsPerReplicationGroupQuotaExceededFault', ], [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'CreateServerlessCache' => [ 'name' => 'CreateServerlessCache', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateServerlessCacheRequest', ], 'output' => [ 'shape' => 'CreateServerlessCacheResponse', 'resultWrapper' => 'CreateServerlessCacheResult', ], 'errors' => [ [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheStateFault', ], [ 'shape' => 'ServerlessCacheAlreadyExistsFault', ], [ 'shape' => 'ServerlessCacheQuotaForCustomerExceededFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], [ 'shape' => 'InvalidCredentialsException', ], [ 'shape' => 'InvalidUserGroupStateFault', ], [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], ], ], 'CreateServerlessCacheSnapshot' => [ 'name' => 'CreateServerlessCacheSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateServerlessCacheSnapshotRequest', ], 'output' => [ 'shape' => 'CreateServerlessCacheSnapshotResponse', 'resultWrapper' => 'CreateServerlessCacheSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServerlessCacheSnapshotAlreadyExistsFault', ], [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheStateFault', ], [ 'shape' => 'ServerlessCacheSnapshotQuotaExceededFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'CreateSnapshot' => [ 'name' => 'CreateSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateSnapshotMessage', ], 'output' => [ 'shape' => 'CreateSnapshotResult', 'resultWrapper' => 'CreateSnapshotResult', ], 'errors' => [ [ 'shape' => 'SnapshotAlreadyExistsFault', ], [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'SnapshotFeatureNotSupportedFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidParameterCombinationException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'CreateUser' => [ 'name' => 'CreateUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserMessage', ], 'output' => [ 'shape' => 'User', 'resultWrapper' => 'CreateUserResult', ], 'errors' => [ [ 'shape' => 'UserAlreadyExistsFault', ], [ 'shape' => 'UserQuotaExceededFault', ], [ 'shape' => 'DuplicateUserNameFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], ], ], 'CreateUserGroup' => [ 'name' => 'CreateUserGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserGroupMessage', ], 'output' => [ 'shape' => 'UserGroup', 'resultWrapper' => 'CreateUserGroupResult', ], 'errors' => [ [ 'shape' => 'UserNotFoundFault', ], [ 'shape' => 'DuplicateUserNameFault', ], [ 'shape' => 'UserGroupAlreadyExistsFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'DefaultUserRequired', ], [ 'shape' => 'UserGroupQuotaExceededFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], ], ], 'DecreaseNodeGroupsInGlobalReplicationGroup' => [ 'name' => 'DecreaseNodeGroupsInGlobalReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DecreaseNodeGroupsInGlobalReplicationGroupMessage', ], 'output' => [ 'shape' => 'DecreaseNodeGroupsInGlobalReplicationGroupResult', 'resultWrapper' => 'DecreaseNodeGroupsInGlobalReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DecreaseReplicaCount' => [ 'name' => 'DecreaseReplicaCount', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DecreaseReplicaCountMessage', ], 'output' => [ 'shape' => 'DecreaseReplicaCountResult', 'resultWrapper' => 'DecreaseReplicaCountResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InsufficientCacheClusterCapacityFault', ], [ 'shape' => 'ClusterQuotaForCustomerExceededFault', ], [ 'shape' => 'NodeGroupsPerReplicationGroupQuotaExceededFault', ], [ 'shape' => 'NodeQuotaForCustomerExceededFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'NoOperationFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DeleteCacheCluster' => [ 'name' => 'DeleteCacheCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCacheClusterMessage', ], 'output' => [ 'shape' => 'DeleteCacheClusterResult', 'resultWrapper' => 'DeleteCacheClusterResult', ], 'errors' => [ [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'SnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotFeatureNotSupportedFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DeleteCacheParameterGroup' => [ 'name' => 'DeleteCacheParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCacheParameterGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidCacheParameterGroupStateFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DeleteCacheSecurityGroup' => [ 'name' => 'DeleteCacheSecurityGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCacheSecurityGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidCacheSecurityGroupStateFault', ], [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DeleteCacheSubnetGroup' => [ 'name' => 'DeleteCacheSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCacheSubnetGroupMessage', ], 'errors' => [ [ 'shape' => 'CacheSubnetGroupInUse', ], [ 'shape' => 'CacheSubnetGroupNotFoundFault', ], ], ], 'DeleteGlobalReplicationGroup' => [ 'name' => 'DeleteGlobalReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteGlobalReplicationGroupMessage', ], 'output' => [ 'shape' => 'DeleteGlobalReplicationGroupResult', 'resultWrapper' => 'DeleteGlobalReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DeleteReplicationGroup' => [ 'name' => 'DeleteReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteReplicationGroupMessage', ], 'output' => [ 'shape' => 'DeleteReplicationGroupResult', 'resultWrapper' => 'DeleteReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'SnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotFeatureNotSupportedFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DeleteServerlessCache' => [ 'name' => 'DeleteServerlessCache', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteServerlessCacheRequest', ], 'output' => [ 'shape' => 'DeleteServerlessCacheResponse', 'resultWrapper' => 'DeleteServerlessCacheResult', ], 'errors' => [ [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheStateFault', ], [ 'shape' => 'ServerlessCacheSnapshotAlreadyExistsFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], [ 'shape' => 'InvalidCredentialsException', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], ], ], 'DeleteServerlessCacheSnapshot' => [ 'name' => 'DeleteServerlessCacheSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteServerlessCacheSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteServerlessCacheSnapshotResponse', 'resultWrapper' => 'DeleteServerlessCacheSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'ServerlessCacheSnapshotNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheSnapshotStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DeleteSnapshot' => [ 'name' => 'DeleteSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteSnapshotMessage', ], 'output' => [ 'shape' => 'DeleteSnapshotResult', 'resultWrapper' => 'DeleteSnapshotResult', ], 'errors' => [ [ 'shape' => 'SnapshotNotFoundFault', ], [ 'shape' => 'InvalidSnapshotStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DeleteUser' => [ 'name' => 'DeleteUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserMessage', ], 'output' => [ 'shape' => 'User', 'resultWrapper' => 'DeleteUserResult', ], 'errors' => [ [ 'shape' => 'InvalidUserStateFault', ], [ 'shape' => 'UserNotFoundFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'DefaultUserAssociatedToUserGroupFault', ], ], ], 'DeleteUserGroup' => [ 'name' => 'DeleteUserGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserGroupMessage', ], 'output' => [ 'shape' => 'UserGroup', 'resultWrapper' => 'DeleteUserGroupResult', ], 'errors' => [ [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'InvalidUserGroupStateFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DescribeCacheClusters' => [ 'name' => 'DescribeCacheClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCacheClustersMessage', ], 'output' => [ 'shape' => 'CacheClusterMessage', 'resultWrapper' => 'DescribeCacheClustersResult', ], 'errors' => [ [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeCacheEngineVersions' => [ 'name' => 'DescribeCacheEngineVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCacheEngineVersionsMessage', ], 'output' => [ 'shape' => 'CacheEngineVersionMessage', 'resultWrapper' => 'DescribeCacheEngineVersionsResult', ], ], 'DescribeCacheParameterGroups' => [ 'name' => 'DescribeCacheParameterGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCacheParameterGroupsMessage', ], 'output' => [ 'shape' => 'CacheParameterGroupsMessage', 'resultWrapper' => 'DescribeCacheParameterGroupsResult', ], 'errors' => [ [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeCacheParameters' => [ 'name' => 'DescribeCacheParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCacheParametersMessage', ], 'output' => [ 'shape' => 'CacheParameterGroupDetails', 'resultWrapper' => 'DescribeCacheParametersResult', ], 'errors' => [ [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeCacheSecurityGroups' => [ 'name' => 'DescribeCacheSecurityGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCacheSecurityGroupsMessage', ], 'output' => [ 'shape' => 'CacheSecurityGroupMessage', 'resultWrapper' => 'DescribeCacheSecurityGroupsResult', ], 'errors' => [ [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeCacheSubnetGroups' => [ 'name' => 'DescribeCacheSubnetGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCacheSubnetGroupsMessage', ], 'output' => [ 'shape' => 'CacheSubnetGroupMessage', 'resultWrapper' => 'DescribeCacheSubnetGroupsResult', ], 'errors' => [ [ 'shape' => 'CacheSubnetGroupNotFoundFault', ], ], ], 'DescribeEngineDefaultParameters' => [ 'name' => 'DescribeEngineDefaultParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEngineDefaultParametersMessage', ], 'output' => [ 'shape' => 'DescribeEngineDefaultParametersResult', 'resultWrapper' => 'DescribeEngineDefaultParametersResult', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeEvents' => [ 'name' => 'DescribeEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventsMessage', ], 'output' => [ 'shape' => 'EventsMessage', 'resultWrapper' => 'DescribeEventsResult', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeGlobalReplicationGroups' => [ 'name' => 'DescribeGlobalReplicationGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGlobalReplicationGroupsMessage', ], 'output' => [ 'shape' => 'DescribeGlobalReplicationGroupsResult', 'resultWrapper' => 'DescribeGlobalReplicationGroupsResult', ], 'errors' => [ [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeReplicationGroups' => [ 'name' => 'DescribeReplicationGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeReplicationGroupsMessage', ], 'output' => [ 'shape' => 'ReplicationGroupMessage', 'resultWrapper' => 'DescribeReplicationGroupsResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeReservedCacheNodes' => [ 'name' => 'DescribeReservedCacheNodes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeReservedCacheNodesMessage', ], 'output' => [ 'shape' => 'ReservedCacheNodeMessage', 'resultWrapper' => 'DescribeReservedCacheNodesResult', ], 'errors' => [ [ 'shape' => 'ReservedCacheNodeNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeReservedCacheNodesOfferings' => [ 'name' => 'DescribeReservedCacheNodesOfferings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeReservedCacheNodesOfferingsMessage', ], 'output' => [ 'shape' => 'ReservedCacheNodesOfferingMessage', 'resultWrapper' => 'DescribeReservedCacheNodesOfferingsResult', ], 'errors' => [ [ 'shape' => 'ReservedCacheNodesOfferingNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeServerlessCacheSnapshots' => [ 'name' => 'DescribeServerlessCacheSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeServerlessCacheSnapshotsRequest', ], 'output' => [ 'shape' => 'DescribeServerlessCacheSnapshotsResponse', 'resultWrapper' => 'DescribeServerlessCacheSnapshotsResult', ], 'errors' => [ [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'ServerlessCacheSnapshotNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeServerlessCaches' => [ 'name' => 'DescribeServerlessCaches', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeServerlessCachesRequest', ], 'output' => [ 'shape' => 'DescribeServerlessCachesResponse', 'resultWrapper' => 'DescribeServerlessCachesResult', ], 'errors' => [ [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeServiceUpdates' => [ 'name' => 'DescribeServiceUpdates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeServiceUpdatesMessage', ], 'output' => [ 'shape' => 'ServiceUpdatesMessage', 'resultWrapper' => 'DescribeServiceUpdatesResult', ], 'errors' => [ [ 'shape' => 'ServiceUpdateNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeSnapshots' => [ 'name' => 'DescribeSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSnapshotsMessage', ], 'output' => [ 'shape' => 'DescribeSnapshotsListMessage', 'resultWrapper' => 'DescribeSnapshotsResult', ], 'errors' => [ [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'SnapshotNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeUpdateActions' => [ 'name' => 'DescribeUpdateActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUpdateActionsMessage', ], 'output' => [ 'shape' => 'UpdateActionsMessage', 'resultWrapper' => 'DescribeUpdateActionsResult', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeUserGroups' => [ 'name' => 'DescribeUserGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserGroupsMessage', ], 'output' => [ 'shape' => 'DescribeUserGroupsResult', 'resultWrapper' => 'DescribeUserGroupsResult', ], 'errors' => [ [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeUsers' => [ 'name' => 'DescribeUsers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUsersMessage', ], 'output' => [ 'shape' => 'DescribeUsersResult', 'resultWrapper' => 'DescribeUsersResult', ], 'errors' => [ [ 'shape' => 'UserNotFoundFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DisassociateGlobalReplicationGroup' => [ 'name' => 'DisassociateGlobalReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateGlobalReplicationGroupMessage', ], 'output' => [ 'shape' => 'DisassociateGlobalReplicationGroupResult', 'resultWrapper' => 'DisassociateGlobalReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'ExportServerlessCacheSnapshot' => [ 'name' => 'ExportServerlessCacheSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ExportServerlessCacheSnapshotRequest', ], 'output' => [ 'shape' => 'ExportServerlessCacheSnapshotResponse', 'resultWrapper' => 'ExportServerlessCacheSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServerlessCacheSnapshotNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheSnapshotStateFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'FailoverGlobalReplicationGroup' => [ 'name' => 'FailoverGlobalReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'FailoverGlobalReplicationGroupMessage', ], 'output' => [ 'shape' => 'FailoverGlobalReplicationGroupResult', 'resultWrapper' => 'FailoverGlobalReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'IncreaseNodeGroupsInGlobalReplicationGroup' => [ 'name' => 'IncreaseNodeGroupsInGlobalReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'IncreaseNodeGroupsInGlobalReplicationGroupMessage', ], 'output' => [ 'shape' => 'IncreaseNodeGroupsInGlobalReplicationGroupResult', 'resultWrapper' => 'IncreaseNodeGroupsInGlobalReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'IncreaseReplicaCount' => [ 'name' => 'IncreaseReplicaCount', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'IncreaseReplicaCountMessage', ], 'output' => [ 'shape' => 'IncreaseReplicaCountResult', 'resultWrapper' => 'IncreaseReplicaCountResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InsufficientCacheClusterCapacityFault', ], [ 'shape' => 'ClusterQuotaForCustomerExceededFault', ], [ 'shape' => 'NodeGroupsPerReplicationGroupQuotaExceededFault', ], [ 'shape' => 'NodeQuotaForCustomerExceededFault', ], [ 'shape' => 'NoOperationFault', ], [ 'shape' => 'InvalidKMSKeyFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'ListAllowedNodeTypeModifications' => [ 'name' => 'ListAllowedNodeTypeModifications', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAllowedNodeTypeModificationsMessage', ], 'output' => [ 'shape' => 'AllowedNodeTypeModificationsMessage', 'resultWrapper' => 'ListAllowedNodeTypeModificationsResult', ], 'errors' => [ [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterCombinationException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceMessage', ], 'output' => [ 'shape' => 'TagListMessage', 'resultWrapper' => 'ListTagsForResourceResult', ], 'errors' => [ [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'CacheSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'ReservedCacheNodeNotFoundFault', ], [ 'shape' => 'SnapshotNotFoundFault', ], [ 'shape' => 'UserNotFoundFault', ], [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheStateFault', ], [ 'shape' => 'ServerlessCacheSnapshotNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheSnapshotStateFault', ], [ 'shape' => 'InvalidARNFault', ], ], ], 'ModifyCacheCluster' => [ 'name' => 'ModifyCacheCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyCacheClusterMessage', ], 'output' => [ 'shape' => 'ModifyCacheClusterResult', 'resultWrapper' => 'ModifyCacheClusterResult', ], 'errors' => [ [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'InvalidCacheSecurityGroupStateFault', ], [ 'shape' => 'InsufficientCacheClusterCapacityFault', ], [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'NodeQuotaForClusterExceededFault', ], [ 'shape' => 'NodeQuotaForCustomerExceededFault', ], [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'ModifyCacheParameterGroup' => [ 'name' => 'ModifyCacheParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyCacheParameterGroupMessage', ], 'output' => [ 'shape' => 'CacheParameterGroupNameMessage', 'resultWrapper' => 'ModifyCacheParameterGroupResult', ], 'errors' => [ [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidCacheParameterGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], ], ], 'ModifyCacheSubnetGroup' => [ 'name' => 'ModifyCacheSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyCacheSubnetGroupMessage', ], 'output' => [ 'shape' => 'ModifyCacheSubnetGroupResult', 'resultWrapper' => 'ModifyCacheSubnetGroupResult', ], 'errors' => [ [ 'shape' => 'CacheSubnetGroupNotFoundFault', ], [ 'shape' => 'CacheSubnetQuotaExceededFault', ], [ 'shape' => 'SubnetInUse', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'SubnetNotAllowedFault', ], ], ], 'ModifyGlobalReplicationGroup' => [ 'name' => 'ModifyGlobalReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyGlobalReplicationGroupMessage', ], 'output' => [ 'shape' => 'ModifyGlobalReplicationGroupResult', 'resultWrapper' => 'ModifyGlobalReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'ModifyReplicationGroup' => [ 'name' => 'ModifyReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyReplicationGroupMessage', ], 'output' => [ 'shape' => 'ModifyReplicationGroupResult', 'resultWrapper' => 'ModifyReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'InvalidUserGroupStateFault', ], [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'InvalidCacheSecurityGroupStateFault', ], [ 'shape' => 'InsufficientCacheClusterCapacityFault', ], [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'NodeQuotaForClusterExceededFault', ], [ 'shape' => 'NodeQuotaForCustomerExceededFault', ], [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidKMSKeyFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'ModifyReplicationGroupShardConfiguration' => [ 'name' => 'ModifyReplicationGroupShardConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyReplicationGroupShardConfigurationMessage', ], 'output' => [ 'shape' => 'ModifyReplicationGroupShardConfigurationResult', 'resultWrapper' => 'ModifyReplicationGroupShardConfigurationResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InsufficientCacheClusterCapacityFault', ], [ 'shape' => 'NodeGroupsPerReplicationGroupQuotaExceededFault', ], [ 'shape' => 'NodeQuotaForCustomerExceededFault', ], [ 'shape' => 'InvalidKMSKeyFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'ModifyServerlessCache' => [ 'name' => 'ModifyServerlessCache', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyServerlessCacheRequest', ], 'output' => [ 'shape' => 'ModifyServerlessCacheResponse', 'resultWrapper' => 'ModifyServerlessCacheResult', ], 'errors' => [ [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], [ 'shape' => 'InvalidCredentialsException', ], [ 'shape' => 'InvalidUserGroupStateFault', ], [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], ], ], 'ModifyUser' => [ 'name' => 'ModifyUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyUserMessage', ], 'output' => [ 'shape' => 'User', 'resultWrapper' => 'ModifyUserResult', ], 'errors' => [ [ 'shape' => 'UserNotFoundFault', ], [ 'shape' => 'InvalidUserStateFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'ModifyUserGroup' => [ 'name' => 'ModifyUserGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyUserGroupMessage', ], 'output' => [ 'shape' => 'UserGroup', 'resultWrapper' => 'ModifyUserGroupResult', ], 'errors' => [ [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'UserNotFoundFault', ], [ 'shape' => 'DuplicateUserNameFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'DefaultUserRequired', ], [ 'shape' => 'InvalidUserGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'PurchaseReservedCacheNodesOffering' => [ 'name' => 'PurchaseReservedCacheNodesOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PurchaseReservedCacheNodesOfferingMessage', ], 'output' => [ 'shape' => 'PurchaseReservedCacheNodesOfferingResult', 'resultWrapper' => 'PurchaseReservedCacheNodesOfferingResult', ], 'errors' => [ [ 'shape' => 'ReservedCacheNodesOfferingNotFoundFault', ], [ 'shape' => 'ReservedCacheNodeAlreadyExistsFault', ], [ 'shape' => 'ReservedCacheNodeQuotaExceededFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'RebalanceSlotsInGlobalReplicationGroup' => [ 'name' => 'RebalanceSlotsInGlobalReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebalanceSlotsInGlobalReplicationGroupMessage', ], 'output' => [ 'shape' => 'RebalanceSlotsInGlobalReplicationGroupResult', 'resultWrapper' => 'RebalanceSlotsInGlobalReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'RebootCacheCluster' => [ 'name' => 'RebootCacheCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootCacheClusterMessage', ], 'output' => [ 'shape' => 'RebootCacheClusterResult', 'resultWrapper' => 'RebootCacheClusterResult', ], 'errors' => [ [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'CacheClusterNotFoundFault', ], ], ], 'RemoveTagsFromResource' => [ 'name' => 'RemoveTagsFromResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveTagsFromResourceMessage', ], 'output' => [ 'shape' => 'TagListMessage', 'resultWrapper' => 'RemoveTagsFromResourceResult', ], 'errors' => [ [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'CacheSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'ReservedCacheNodeNotFoundFault', ], [ 'shape' => 'SnapshotNotFoundFault', ], [ 'shape' => 'UserNotFoundFault', ], [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheStateFault', ], [ 'shape' => 'ServerlessCacheSnapshotNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheSnapshotStateFault', ], [ 'shape' => 'InvalidARNFault', ], [ 'shape' => 'TagNotFoundFault', ], ], ], 'ResetCacheParameterGroup' => [ 'name' => 'ResetCacheParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResetCacheParameterGroupMessage', ], 'output' => [ 'shape' => 'CacheParameterGroupNameMessage', 'resultWrapper' => 'ResetCacheParameterGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidCacheParameterGroupStateFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], ], ], 'RevokeCacheSecurityGroupIngress' => [ 'name' => 'RevokeCacheSecurityGroupIngress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RevokeCacheSecurityGroupIngressMessage', ], 'output' => [ 'shape' => 'RevokeCacheSecurityGroupIngressResult', 'resultWrapper' => 'RevokeCacheSecurityGroupIngressResult', ], 'errors' => [ [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'InvalidCacheSecurityGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'StartMigration' => [ 'name' => 'StartMigration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartMigrationMessage', ], 'output' => [ 'shape' => 'StartMigrationResponse', 'resultWrapper' => 'StartMigrationResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'ReplicationGroupAlreadyUnderMigrationFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'TestFailover' => [ 'name' => 'TestFailover', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TestFailoverMessage', ], 'output' => [ 'shape' => 'TestFailoverResult', 'resultWrapper' => 'TestFailoverResult', ], 'errors' => [ [ 'shape' => 'APICallRateForCustomerExceededFault', ], [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'NodeGroupNotFoundFault', ], [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'TestFailoverNotAvailableFault', ], [ 'shape' => 'InvalidKMSKeyFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'TestMigration' => [ 'name' => 'TestMigration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TestMigrationMessage', ], 'output' => [ 'shape' => 'TestMigrationResponse', 'resultWrapper' => 'TestMigrationResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'ReplicationGroupAlreadyUnderMigrationFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], ], 'shapes' => [ 'APICallRateForCustomerExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'APICallRateForCustomerExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'AZMode' => [ 'type' => 'string', 'enum' => [ 'single-az', 'cross-az', ], ], 'AccessString' => [ 'type' => 'string', 'pattern' => '.*\\S.*', ], 'AddTagsToResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', 'Tags', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AllowedNodeGroupId' => [ 'type' => 'string', 'max' => 4, 'min' => 1, 'pattern' => '\\d+', ], 'AllowedNodeTypeModificationsMessage' => [ 'type' => 'structure', 'members' => [ 'ScaleUpModifications' => [ 'shape' => 'NodeTypeList', ], 'ScaleDownModifications' => [ 'shape' => 'NodeTypeList', ], ], ], 'AuthTokenUpdateStatus' => [ 'type' => 'string', 'enum' => [ 'SETTING', 'ROTATING', ], ], 'AuthTokenUpdateStrategyType' => [ 'type' => 'string', 'enum' => [ 'SET', 'ROTATE', 'DELETE', ], ], 'Authentication' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'AuthenticationType', ], 'PasswordCount' => [ 'shape' => 'IntegerOptional', ], ], ], 'AuthenticationMode' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'InputAuthenticationType', ], 'Passwords' => [ 'shape' => 'PasswordListInput', ], ], ], 'AuthenticationType' => [ 'type' => 'string', 'enum' => [ 'password', 'no-password', 'iam', ], ], 'AuthorizationAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'AuthorizationNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'AuthorizeCacheSecurityGroupIngressMessage' => [ 'type' => 'structure', 'required' => [ 'CacheSecurityGroupName', 'EC2SecurityGroupName', 'EC2SecurityGroupOwnerId', ], 'members' => [ 'CacheSecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'AuthorizeCacheSecurityGroupIngressResult' => [ 'type' => 'structure', 'members' => [ 'CacheSecurityGroup' => [ 'shape' => 'CacheSecurityGroup', ], ], ], 'AutomaticFailoverStatus' => [ 'type' => 'string', 'enum' => [ 'enabled', 'disabled', 'enabling', 'disabling', ], ], 'AvailabilityZone' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'AvailabilityZonesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'AvailabilityZone', ], ], 'AwsQueryErrorMessage' => [ 'type' => 'string', ], 'BatchApplyUpdateActionMessage' => [ 'type' => 'structure', 'required' => [ 'ServiceUpdateName', ], 'members' => [ 'ReplicationGroupIds' => [ 'shape' => 'ReplicationGroupIdList', ], 'CacheClusterIds' => [ 'shape' => 'CacheClusterIdList', ], 'ServiceUpdateName' => [ 'shape' => 'String', ], ], ], 'BatchStopUpdateActionMessage' => [ 'type' => 'structure', 'required' => [ 'ServiceUpdateName', ], 'members' => [ 'ReplicationGroupIds' => [ 'shape' => 'ReplicationGroupIdList', ], 'CacheClusterIds' => [ 'shape' => 'CacheClusterIdList', ], 'ServiceUpdateName' => [ 'shape' => 'String', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanOptional' => [ 'type' => 'boolean', ], 'CacheCluster' => [ 'type' => 'structure', 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'ConfigurationEndpoint' => [ 'shape' => 'Endpoint', ], 'ClientDownloadLandingPage' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'CacheClusterStatus' => [ 'shape' => 'String', ], 'NumCacheNodes' => [ 'shape' => 'IntegerOptional', ], 'PreferredAvailabilityZone' => [ 'shape' => 'String', ], 'PreferredOutpostArn' => [ 'shape' => 'String', ], 'CacheClusterCreateTime' => [ 'shape' => 'TStamp', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'PendingModifiedValues' => [ 'shape' => 'PendingModifiedValues', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], 'CacheSecurityGroups' => [ 'shape' => 'CacheSecurityGroupMembershipList', ], 'CacheParameterGroup' => [ 'shape' => 'CacheParameterGroupStatus', ], 'CacheSubnetGroupName' => [ 'shape' => 'String', ], 'CacheNodes' => [ 'shape' => 'CacheNodeList', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupMembershipList', ], 'ReplicationGroupId' => [ 'shape' => 'String', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'SnapshotWindow' => [ 'shape' => 'String', ], 'AuthTokenEnabled' => [ 'shape' => 'BooleanOptional', ], 'AuthTokenLastModifiedDate' => [ 'shape' => 'TStamp', ], 'TransitEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'AtRestEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'ARN' => [ 'shape' => 'String', ], 'ReplicationGroupLogDeliveryEnabled' => [ 'shape' => 'Boolean', ], 'LogDeliveryConfigurations' => [ 'shape' => 'LogDeliveryConfigurationList', ], 'NetworkType' => [ 'shape' => 'NetworkType', ], 'IpDiscovery' => [ 'shape' => 'IpDiscovery', ], 'TransitEncryptionMode' => [ 'shape' => 'TransitEncryptionMode', ], ], 'wrapper' => true, ], 'CacheClusterAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheClusterAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheClusterIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 20, ], 'CacheClusterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheCluster', 'locationName' => 'CacheCluster', ], ], 'CacheClusterMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'CacheClusters' => [ 'shape' => 'CacheClusterList', ], ], ], 'CacheClusterNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheClusterNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'CacheEngineVersion' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'CacheParameterGroupFamily' => [ 'shape' => 'String', ], 'CacheEngineDescription' => [ 'shape' => 'String', ], 'CacheEngineVersionDescription' => [ 'shape' => 'String', ], ], ], 'CacheEngineVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheEngineVersion', 'locationName' => 'CacheEngineVersion', ], ], 'CacheEngineVersionMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'CacheEngineVersions' => [ 'shape' => 'CacheEngineVersionList', ], ], ], 'CacheNode' => [ 'type' => 'structure', 'members' => [ 'CacheNodeId' => [ 'shape' => 'String', ], 'CacheNodeStatus' => [ 'shape' => 'String', ], 'CacheNodeCreateTime' => [ 'shape' => 'TStamp', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], 'ParameterGroupStatus' => [ 'shape' => 'String', ], 'SourceCacheNodeId' => [ 'shape' => 'String', ], 'CustomerAvailabilityZone' => [ 'shape' => 'String', ], 'CustomerOutpostArn' => [ 'shape' => 'String', ], ], ], 'CacheNodeIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'CacheNodeId', ], ], 'CacheNodeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheNode', 'locationName' => 'CacheNode', ], ], 'CacheNodeTypeSpecificParameter' => [ 'type' => 'structure', 'members' => [ 'ParameterName' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'DataType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], 'CacheNodeTypeSpecificValues' => [ 'shape' => 'CacheNodeTypeSpecificValueList', ], 'ChangeType' => [ 'shape' => 'ChangeType', ], ], ], 'CacheNodeTypeSpecificParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheNodeTypeSpecificParameter', 'locationName' => 'CacheNodeTypeSpecificParameter', ], ], 'CacheNodeTypeSpecificValue' => [ 'type' => 'structure', 'members' => [ 'CacheNodeType' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'CacheNodeTypeSpecificValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheNodeTypeSpecificValue', 'locationName' => 'CacheNodeTypeSpecificValue', ], ], 'CacheNodeUpdateStatus' => [ 'type' => 'structure', 'members' => [ 'CacheNodeId' => [ 'shape' => 'String', ], 'NodeUpdateStatus' => [ 'shape' => 'NodeUpdateStatus', ], 'NodeDeletionDate' => [ 'shape' => 'TStamp', ], 'NodeUpdateStartDate' => [ 'shape' => 'TStamp', ], 'NodeUpdateEndDate' => [ 'shape' => 'TStamp', ], 'NodeUpdateInitiatedBy' => [ 'shape' => 'NodeUpdateInitiatedBy', ], 'NodeUpdateInitiatedDate' => [ 'shape' => 'TStamp', ], 'NodeUpdateStatusModifiedDate' => [ 'shape' => 'TStamp', ], ], ], 'CacheNodeUpdateStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheNodeUpdateStatus', 'locationName' => 'CacheNodeUpdateStatus', ], ], 'CacheParameterGroup' => [ 'type' => 'structure', 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'CacheParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'IsGlobal' => [ 'shape' => 'Boolean', ], 'ARN' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'CacheParameterGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheParameterGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheParameterGroupDetails' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], 'CacheNodeTypeSpecificParameters' => [ 'shape' => 'CacheNodeTypeSpecificParametersList', ], ], ], 'CacheParameterGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheParameterGroup', 'locationName' => 'CacheParameterGroup', ], ], 'CacheParameterGroupNameMessage' => [ 'type' => 'structure', 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], ], ], 'CacheParameterGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheParameterGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'CacheParameterGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheParameterGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheParameterGroupStatus' => [ 'type' => 'structure', 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'ParameterApplyStatus' => [ 'shape' => 'String', ], 'CacheNodeIdsToReboot' => [ 'shape' => 'CacheNodeIdsList', ], ], ], 'CacheParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'CacheParameterGroups' => [ 'shape' => 'CacheParameterGroupList', ], ], ], 'CacheSecurityGroup' => [ 'type' => 'structure', 'members' => [ 'OwnerId' => [ 'shape' => 'String', ], 'CacheSecurityGroupName' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'EC2SecurityGroups' => [ 'shape' => 'EC2SecurityGroupList', ], 'ARN' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'CacheSecurityGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheSecurityGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheSecurityGroupMembership' => [ 'type' => 'structure', 'members' => [ 'CacheSecurityGroupName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'CacheSecurityGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheSecurityGroupMembership', 'locationName' => 'CacheSecurityGroup', ], ], 'CacheSecurityGroupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'CacheSecurityGroups' => [ 'shape' => 'CacheSecurityGroups', ], ], ], 'CacheSecurityGroupNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'CacheSecurityGroupName', ], ], 'CacheSecurityGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheSecurityGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'CacheSecurityGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'QuotaExceeded.CacheSecurityGroup', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheSecurityGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheSecurityGroup', 'locationName' => 'CacheSecurityGroup', ], ], 'CacheSubnetGroup' => [ 'type' => 'structure', 'members' => [ 'CacheSubnetGroupName' => [ 'shape' => 'String', ], 'CacheSubnetGroupDescription' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'Subnets' => [ 'shape' => 'SubnetList', ], 'ARN' => [ 'shape' => 'String', ], 'SupportedNetworkTypes' => [ 'shape' => 'NetworkTypeList', ], ], 'wrapper' => true, ], 'CacheSubnetGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheSubnetGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheSubnetGroupInUse' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheSubnetGroupInUse', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheSubnetGroupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'CacheSubnetGroups' => [ 'shape' => 'CacheSubnetGroups', ], ], ], 'CacheSubnetGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheSubnetGroupNotFoundFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheSubnetGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheSubnetGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheSubnetGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheSubnetGroup', 'locationName' => 'CacheSubnetGroup', ], ], 'CacheSubnetQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheSubnetQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheUsageLimits' => [ 'type' => 'structure', 'members' => [ 'DataStorage' => [ 'shape' => 'DataStorage', ], 'ECPUPerSecond' => [ 'shape' => 'ECPUPerSecond', ], ], ], 'ChangeType' => [ 'type' => 'string', 'enum' => [ 'immediate', 'requires-reboot', ], ], 'CloudWatchLogsDestinationDetails' => [ 'type' => 'structure', 'members' => [ 'LogGroup' => [ 'shape' => 'String', ], ], ], 'ClusterIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ClusterId', ], ], 'ClusterMode' => [ 'type' => 'string', 'enum' => [ 'enabled', 'disabled', 'compatible', ], ], 'ClusterQuotaForCustomerExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ClusterQuotaForCustomerExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CompleteMigrationMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'Force' => [ 'shape' => 'Boolean', ], ], ], 'CompleteMigrationResponse' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'ConfigureShard' => [ 'type' => 'structure', 'required' => [ 'NodeGroupId', 'NewReplicaCount', ], 'members' => [ 'NodeGroupId' => [ 'shape' => 'AllowedNodeGroupId', ], 'NewReplicaCount' => [ 'shape' => 'Integer', ], 'PreferredAvailabilityZones' => [ 'shape' => 'PreferredAvailabilityZoneList', ], 'PreferredOutpostArns' => [ 'shape' => 'PreferredOutpostArnList', ], ], ], 'CopyServerlessCacheSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'SourceServerlessCacheSnapshotName', 'TargetServerlessCacheSnapshotName', ], 'members' => [ 'SourceServerlessCacheSnapshotName' => [ 'shape' => 'String', ], 'TargetServerlessCacheSnapshotName' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyServerlessCacheSnapshotResponse' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheSnapshot' => [ 'shape' => 'ServerlessCacheSnapshot', ], ], ], 'CopySnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'SourceSnapshotName', 'TargetSnapshotName', ], 'members' => [ 'SourceSnapshotName' => [ 'shape' => 'String', ], 'TargetSnapshotName' => [ 'shape' => 'String', ], 'TargetBucket' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopySnapshotResult' => [ 'type' => 'structure', 'members' => [ 'Snapshot' => [ 'shape' => 'Snapshot', ], ], ], 'CreateCacheClusterMessage' => [ 'type' => 'structure', 'required' => [ 'CacheClusterId', ], 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'ReplicationGroupId' => [ 'shape' => 'String', ], 'AZMode' => [ 'shape' => 'AZMode', ], 'PreferredAvailabilityZone' => [ 'shape' => 'String', ], 'PreferredAvailabilityZones' => [ 'shape' => 'PreferredAvailabilityZoneList', ], 'NumCacheNodes' => [ 'shape' => 'IntegerOptional', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'CacheSubnetGroupName' => [ 'shape' => 'String', ], 'CacheSecurityGroupNames' => [ 'shape' => 'CacheSecurityGroupNameList', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdsList', ], 'Tags' => [ 'shape' => 'TagList', ], 'SnapshotArns' => [ 'shape' => 'SnapshotArnsList', ], 'SnapshotName' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'NotificationTopicArn' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'SnapshotWindow' => [ 'shape' => 'String', ], 'AuthToken' => [ 'shape' => 'String', ], 'OutpostMode' => [ 'shape' => 'OutpostMode', ], 'PreferredOutpostArn' => [ 'shape' => 'String', ], 'PreferredOutpostArns' => [ 'shape' => 'PreferredOutpostArnList', ], 'LogDeliveryConfigurations' => [ 'shape' => 'LogDeliveryConfigurationRequestList', ], 'TransitEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'NetworkType' => [ 'shape' => 'NetworkType', ], 'IpDiscovery' => [ 'shape' => 'IpDiscovery', ], ], ], 'CreateCacheClusterResult' => [ 'type' => 'structure', 'members' => [ 'CacheCluster' => [ 'shape' => 'CacheCluster', ], ], ], 'CreateCacheParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheParameterGroupName', 'CacheParameterGroupFamily', 'Description', ], 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'CacheParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCacheParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'CacheParameterGroup' => [ 'shape' => 'CacheParameterGroup', ], ], ], 'CreateCacheSecurityGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheSecurityGroupName', 'Description', ], 'members' => [ 'CacheSecurityGroupName' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCacheSecurityGroupResult' => [ 'type' => 'structure', 'members' => [ 'CacheSecurityGroup' => [ 'shape' => 'CacheSecurityGroup', ], ], ], 'CreateCacheSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheSubnetGroupName', 'CacheSubnetGroupDescription', 'SubnetIds', ], 'members' => [ 'CacheSubnetGroupName' => [ 'shape' => 'String', ], 'CacheSubnetGroupDescription' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdentifierList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCacheSubnetGroupResult' => [ 'type' => 'structure', 'members' => [ 'CacheSubnetGroup' => [ 'shape' => 'CacheSubnetGroup', ], ], ], 'CreateGlobalReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalReplicationGroupIdSuffix', 'PrimaryReplicationGroupId', ], 'members' => [ 'GlobalReplicationGroupIdSuffix' => [ 'shape' => 'String', ], 'GlobalReplicationGroupDescription' => [ 'shape' => 'String', ], 'PrimaryReplicationGroupId' => [ 'shape' => 'String', ], ], ], 'CreateGlobalReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroup' => [ 'shape' => 'GlobalReplicationGroup', ], ], ], 'CreateReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', 'ReplicationGroupDescription', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'ReplicationGroupDescription' => [ 'shape' => 'String', ], 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'PrimaryClusterId' => [ 'shape' => 'String', ], 'AutomaticFailoverEnabled' => [ 'shape' => 'BooleanOptional', ], 'MultiAZEnabled' => [ 'shape' => 'BooleanOptional', ], 'NumCacheClusters' => [ 'shape' => 'IntegerOptional', ], 'PreferredCacheClusterAZs' => [ 'shape' => 'AvailabilityZonesList', ], 'NumNodeGroups' => [ 'shape' => 'IntegerOptional', ], 'ReplicasPerNodeGroup' => [ 'shape' => 'IntegerOptional', ], 'NodeGroupConfiguration' => [ 'shape' => 'NodeGroupConfigurationList', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'CacheSubnetGroupName' => [ 'shape' => 'String', ], 'CacheSecurityGroupNames' => [ 'shape' => 'CacheSecurityGroupNameList', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdsList', ], 'Tags' => [ 'shape' => 'TagList', ], 'SnapshotArns' => [ 'shape' => 'SnapshotArnsList', ], 'SnapshotName' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'NotificationTopicArn' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'SnapshotWindow' => [ 'shape' => 'String', ], 'AuthToken' => [ 'shape' => 'String', ], 'TransitEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'AtRestEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'UserGroupIds' => [ 'shape' => 'UserGroupIdListInput', ], 'LogDeliveryConfigurations' => [ 'shape' => 'LogDeliveryConfigurationRequestList', ], 'DataTieringEnabled' => [ 'shape' => 'BooleanOptional', ], 'NetworkType' => [ 'shape' => 'NetworkType', ], 'IpDiscovery' => [ 'shape' => 'IpDiscovery', ], 'TransitEncryptionMode' => [ 'shape' => 'TransitEncryptionMode', ], 'ClusterMode' => [ 'shape' => 'ClusterMode', ], 'ServerlessCacheSnapshotName' => [ 'shape' => 'String', ], ], ], 'CreateReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'CreateServerlessCacheRequest' => [ 'type' => 'structure', 'required' => [ 'ServerlessCacheName', 'Engine', ], 'members' => [ 'ServerlessCacheName' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'CacheUsageLimits' => [ 'shape' => 'CacheUsageLimits', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdsList', ], 'SnapshotArnsToRestore' => [ 'shape' => 'SnapshotArnsList', ], 'Tags' => [ 'shape' => 'TagList', ], 'UserGroupId' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdsList', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'DailySnapshotTime' => [ 'shape' => 'String', ], ], ], 'CreateServerlessCacheResponse' => [ 'type' => 'structure', 'members' => [ 'ServerlessCache' => [ 'shape' => 'ServerlessCache', ], ], ], 'CreateServerlessCacheSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'ServerlessCacheSnapshotName', 'ServerlessCacheName', ], 'members' => [ 'ServerlessCacheSnapshotName' => [ 'shape' => 'String', ], 'ServerlessCacheName' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateServerlessCacheSnapshotResponse' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheSnapshot' => [ 'shape' => 'ServerlessCacheSnapshot', ], ], ], 'CreateSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'SnapshotName', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'CacheClusterId' => [ 'shape' => 'String', ], 'SnapshotName' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'Snapshot' => [ 'shape' => 'Snapshot', ], ], ], 'CreateUserGroupMessage' => [ 'type' => 'structure', 'required' => [ 'UserGroupId', 'Engine', ], 'members' => [ 'UserGroupId' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'EngineType', ], 'UserIds' => [ 'shape' => 'UserIdListInput', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateUserMessage' => [ 'type' => 'structure', 'required' => [ 'UserId', 'UserName', 'Engine', 'AccessString', ], 'members' => [ 'UserId' => [ 'shape' => 'UserId', ], 'UserName' => [ 'shape' => 'UserName', ], 'Engine' => [ 'shape' => 'EngineType', ], 'Passwords' => [ 'shape' => 'PasswordListInput', ], 'AccessString' => [ 'shape' => 'AccessString', ], 'NoPasswordRequired' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'AuthenticationMode' => [ 'shape' => 'AuthenticationMode', ], ], ], 'CustomerNodeEndpoint' => [ 'type' => 'structure', 'members' => [ 'Address' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], ], ], 'CustomerNodeEndpointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomerNodeEndpoint', ], ], 'DataStorage' => [ 'type' => 'structure', 'required' => [ 'Unit', ], 'members' => [ 'Maximum' => [ 'shape' => 'IntegerOptional', ], 'Minimum' => [ 'shape' => 'IntegerOptional', ], 'Unit' => [ 'shape' => 'DataStorageUnit', ], ], ], 'DataStorageUnit' => [ 'type' => 'string', 'enum' => [ 'GB', ], ], 'DataTieringStatus' => [ 'type' => 'string', 'enum' => [ 'enabled', 'disabled', ], ], 'DecreaseNodeGroupsInGlobalReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalReplicationGroupId', 'NodeGroupCount', 'ApplyImmediately', ], 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'NodeGroupCount' => [ 'shape' => 'Integer', ], 'GlobalNodeGroupsToRemove' => [ 'shape' => 'GlobalNodeGroupIdList', ], 'GlobalNodeGroupsToRetain' => [ 'shape' => 'GlobalNodeGroupIdList', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], ], ], 'DecreaseNodeGroupsInGlobalReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroup' => [ 'shape' => 'GlobalReplicationGroup', ], ], ], 'DecreaseReplicaCountMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', 'ApplyImmediately', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'NewReplicaCount' => [ 'shape' => 'IntegerOptional', ], 'ReplicaConfiguration' => [ 'shape' => 'ReplicaConfigurationList', ], 'ReplicasToRemove' => [ 'shape' => 'RemoveReplicasList', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], ], ], 'DecreaseReplicaCountResult' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'DefaultUserAssociatedToUserGroupFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DefaultUserAssociatedToUserGroup', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DefaultUserRequired' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DefaultUserRequired', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DeleteCacheClusterMessage' => [ 'type' => 'structure', 'required' => [ 'CacheClusterId', ], 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'FinalSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteCacheClusterResult' => [ 'type' => 'structure', 'members' => [ 'CacheCluster' => [ 'shape' => 'CacheCluster', ], ], ], 'DeleteCacheParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheParameterGroupName', ], 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteCacheSecurityGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheSecurityGroupName', ], 'members' => [ 'CacheSecurityGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteCacheSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheSubnetGroupName', ], 'members' => [ 'CacheSubnetGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteGlobalReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalReplicationGroupId', 'RetainPrimaryReplicationGroup', ], 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'RetainPrimaryReplicationGroup' => [ 'shape' => 'Boolean', ], ], ], 'DeleteGlobalReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroup' => [ 'shape' => 'GlobalReplicationGroup', ], ], ], 'DeleteReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'RetainPrimaryCluster' => [ 'shape' => 'BooleanOptional', ], 'FinalSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'DeleteServerlessCacheRequest' => [ 'type' => 'structure', 'required' => [ 'ServerlessCacheName', ], 'members' => [ 'ServerlessCacheName' => [ 'shape' => 'String', ], 'FinalSnapshotName' => [ 'shape' => 'String', ], ], ], 'DeleteServerlessCacheResponse' => [ 'type' => 'structure', 'members' => [ 'ServerlessCache' => [ 'shape' => 'ServerlessCache', ], ], ], 'DeleteServerlessCacheSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'ServerlessCacheSnapshotName', ], 'members' => [ 'ServerlessCacheSnapshotName' => [ 'shape' => 'String', ], ], ], 'DeleteServerlessCacheSnapshotResponse' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheSnapshot' => [ 'shape' => 'ServerlessCacheSnapshot', ], ], ], 'DeleteSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'SnapshotName', ], 'members' => [ 'SnapshotName' => [ 'shape' => 'String', ], ], ], 'DeleteSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'Snapshot' => [ 'shape' => 'Snapshot', ], ], ], 'DeleteUserGroupMessage' => [ 'type' => 'structure', 'required' => [ 'UserGroupId', ], 'members' => [ 'UserGroupId' => [ 'shape' => 'String', ], ], ], 'DeleteUserMessage' => [ 'type' => 'structure', 'required' => [ 'UserId', ], 'members' => [ 'UserId' => [ 'shape' => 'UserId', ], ], ], 'DescribeCacheClustersMessage' => [ 'type' => 'structure', 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'ShowCacheNodeInfo' => [ 'shape' => 'BooleanOptional', ], 'ShowCacheClustersNotInReplicationGroups' => [ 'shape' => 'BooleanOptional', ], ], ], 'DescribeCacheEngineVersionsMessage' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'CacheParameterGroupFamily' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'DefaultOnly' => [ 'shape' => 'Boolean', ], ], ], 'DescribeCacheParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeCacheParametersMessage' => [ 'type' => 'structure', 'required' => [ 'CacheParameterGroupName', ], 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeCacheSecurityGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'CacheSecurityGroupName' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeCacheSubnetGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'CacheSubnetGroupName' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultParametersMessage' => [ 'type' => 'structure', 'required' => [ 'CacheParameterGroupFamily', ], 'members' => [ 'CacheParameterGroupFamily' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultParametersResult' => [ 'type' => 'structure', 'members' => [ 'EngineDefaults' => [ 'shape' => 'EngineDefaults', ], ], ], 'DescribeEventsMessage' => [ 'type' => 'structure', 'members' => [ 'SourceIdentifier' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'StartTime' => [ 'shape' => 'TStamp', ], 'EndTime' => [ 'shape' => 'TStamp', ], 'Duration' => [ 'shape' => 'IntegerOptional', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeGlobalReplicationGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'ShowMemberInfo' => [ 'shape' => 'BooleanOptional', ], ], ], 'DescribeGlobalReplicationGroupsResult' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'GlobalReplicationGroups' => [ 'shape' => 'GlobalReplicationGroupList', ], ], ], 'DescribeReplicationGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeReservedCacheNodesMessage' => [ 'type' => 'structure', 'members' => [ 'ReservedCacheNodeId' => [ 'shape' => 'String', ], 'ReservedCacheNodesOfferingId' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'String', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeReservedCacheNodesOfferingsMessage' => [ 'type' => 'structure', 'members' => [ 'ReservedCacheNodesOfferingId' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'String', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeServerlessCacheSnapshotsRequest' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheName' => [ 'shape' => 'String', ], 'ServerlessCacheSnapshotName' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'NextToken' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'IntegerOptional', ], ], ], 'DescribeServerlessCacheSnapshotsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', ], 'ServerlessCacheSnapshots' => [ 'shape' => 'ServerlessCacheSnapshotList', ], ], ], 'DescribeServerlessCachesRequest' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheName' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'IntegerOptional', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeServerlessCachesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', ], 'ServerlessCaches' => [ 'shape' => 'ServerlessCacheList', ], ], ], 'DescribeServiceUpdatesMessage' => [ 'type' => 'structure', 'members' => [ 'ServiceUpdateName' => [ 'shape' => 'String', ], 'ServiceUpdateStatus' => [ 'shape' => 'ServiceUpdateStatusList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeSnapshotsListMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'Snapshots' => [ 'shape' => 'SnapshotList', ], ], ], 'DescribeSnapshotsMessage' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'CacheClusterId' => [ 'shape' => 'String', ], 'SnapshotName' => [ 'shape' => 'String', ], 'SnapshotSource' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'ShowNodeGroupConfig' => [ 'shape' => 'BooleanOptional', ], ], ], 'DescribeUpdateActionsMessage' => [ 'type' => 'structure', 'members' => [ 'ServiceUpdateName' => [ 'shape' => 'String', ], 'ReplicationGroupIds' => [ 'shape' => 'ReplicationGroupIdList', ], 'CacheClusterIds' => [ 'shape' => 'CacheClusterIdList', ], 'Engine' => [ 'shape' => 'String', ], 'ServiceUpdateStatus' => [ 'shape' => 'ServiceUpdateStatusList', ], 'ServiceUpdateTimeRange' => [ 'shape' => 'TimeRangeFilter', ], 'UpdateActionStatus' => [ 'shape' => 'UpdateActionStatusList', ], 'ShowNodeLevelUpdateStatus' => [ 'shape' => 'BooleanOptional', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeUserGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'UserGroupId' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeUserGroupsResult' => [ 'type' => 'structure', 'members' => [ 'UserGroups' => [ 'shape' => 'UserGroupList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeUsersMessage' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'EngineType', ], 'UserId' => [ 'shape' => 'UserId', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeUsersResult' => [ 'type' => 'structure', 'members' => [ 'Users' => [ 'shape' => 'UserList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DestinationDetails' => [ 'type' => 'structure', 'members' => [ 'CloudWatchLogsDetails' => [ 'shape' => 'CloudWatchLogsDestinationDetails', ], 'KinesisFirehoseDetails' => [ 'shape' => 'KinesisFirehoseDestinationDetails', ], ], ], 'DestinationType' => [ 'type' => 'string', 'enum' => [ 'cloudwatch-logs', 'kinesis-firehose', ], ], 'DisassociateGlobalReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalReplicationGroupId', 'ReplicationGroupId', 'ReplicationGroupRegion', ], 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'ReplicationGroupId' => [ 'shape' => 'String', ], 'ReplicationGroupRegion' => [ 'shape' => 'String', ], ], ], 'DisassociateGlobalReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroup' => [ 'shape' => 'GlobalReplicationGroup', ], ], ], 'Double' => [ 'type' => 'double', ], 'DuplicateUserNameFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DuplicateUserName', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'EC2SecurityGroup' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'EC2SecurityGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EC2SecurityGroup', 'locationName' => 'EC2SecurityGroup', ], ], 'ECPUPerSecond' => [ 'type' => 'structure', 'members' => [ 'Maximum' => [ 'shape' => 'IntegerOptional', ], 'Minimum' => [ 'shape' => 'IntegerOptional', ], ], ], 'Endpoint' => [ 'type' => 'structure', 'members' => [ 'Address' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], ], ], 'EngineDefaults' => [ 'type' => 'structure', 'members' => [ 'CacheParameterGroupFamily' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], 'CacheNodeTypeSpecificParameters' => [ 'shape' => 'CacheNodeTypeSpecificParametersList', ], ], 'wrapper' => true, ], 'EngineType' => [ 'type' => 'string', 'pattern' => '[a-zA-Z]*', ], 'Event' => [ 'type' => 'structure', 'members' => [ 'SourceIdentifier' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'Message' => [ 'shape' => 'String', ], 'Date' => [ 'shape' => 'TStamp', ], ], ], 'EventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Event', 'locationName' => 'Event', ], ], 'EventsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'Events' => [ 'shape' => 'EventList', ], ], ], 'ExportServerlessCacheSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'ServerlessCacheSnapshotName', 'S3BucketName', ], 'members' => [ 'ServerlessCacheSnapshotName' => [ 'shape' => 'String', ], 'S3BucketName' => [ 'shape' => 'String', ], ], ], 'ExportServerlessCacheSnapshotResponse' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheSnapshot' => [ 'shape' => 'ServerlessCacheSnapshot', ], ], ], 'FailoverGlobalReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalReplicationGroupId', 'PrimaryRegion', 'PrimaryReplicationGroupId', ], 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'PrimaryRegion' => [ 'shape' => 'String', ], 'PrimaryReplicationGroupId' => [ 'shape' => 'String', ], ], ], 'FailoverGlobalReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroup' => [ 'shape' => 'GlobalReplicationGroup', ], ], ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'FilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], ], 'FilterName' => [ 'type' => 'string', 'pattern' => '.*\\S.*', ], 'FilterValue' => [ 'type' => 'string', 'pattern' => '.*\\S.*', ], 'FilterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterValue', ], 'min' => 1, ], 'GlobalNodeGroup' => [ 'type' => 'structure', 'members' => [ 'GlobalNodeGroupId' => [ 'shape' => 'String', ], 'Slots' => [ 'shape' => 'String', ], ], ], 'GlobalNodeGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'GlobalNodeGroupId', ], ], 'GlobalNodeGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalNodeGroup', 'locationName' => 'GlobalNodeGroup', ], ], 'GlobalReplicationGroup' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'GlobalReplicationGroupDescription' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Members' => [ 'shape' => 'GlobalReplicationGroupMemberList', ], 'ClusterEnabled' => [ 'shape' => 'BooleanOptional', ], 'GlobalNodeGroups' => [ 'shape' => 'GlobalNodeGroupList', ], 'AuthTokenEnabled' => [ 'shape' => 'BooleanOptional', ], 'TransitEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'AtRestEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'ARN' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'GlobalReplicationGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalReplicationGroupAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'GlobalReplicationGroupInfo' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'GlobalReplicationGroupMemberRole' => [ 'shape' => 'String', ], ], ], 'GlobalReplicationGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalReplicationGroup', 'locationName' => 'GlobalReplicationGroup', ], ], 'GlobalReplicationGroupMember' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'ReplicationGroupRegion' => [ 'shape' => 'String', ], 'Role' => [ 'shape' => 'String', ], 'AutomaticFailover' => [ 'shape' => 'AutomaticFailoverStatus', ], 'Status' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'GlobalReplicationGroupMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalReplicationGroupMember', 'locationName' => 'GlobalReplicationGroupMember', ], ], 'GlobalReplicationGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalReplicationGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'IncreaseNodeGroupsInGlobalReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalReplicationGroupId', 'NodeGroupCount', 'ApplyImmediately', ], 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'NodeGroupCount' => [ 'shape' => 'Integer', ], 'RegionalConfigurations' => [ 'shape' => 'RegionalConfigurationList', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], ], ], 'IncreaseNodeGroupsInGlobalReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroup' => [ 'shape' => 'GlobalReplicationGroup', ], ], ], 'IncreaseReplicaCountMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', 'ApplyImmediately', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'NewReplicaCount' => [ 'shape' => 'IntegerOptional', ], 'ReplicaConfiguration' => [ 'shape' => 'ReplicaConfigurationList', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], ], ], 'IncreaseReplicaCountResult' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'InputAuthenticationType' => [ 'type' => 'string', 'enum' => [ 'password', 'no-password-required', 'iam', ], ], 'InsufficientCacheClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientCacheClusterCapacity', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'Integer' => [ 'type' => 'integer', ], 'IntegerOptional' => [ 'type' => 'integer', ], 'InvalidARNFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidARN', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidCacheClusterStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidCacheClusterState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidCacheParameterGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidCacheParameterGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidCacheSecurityGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidCacheSecurityGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidCredentialsException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidCredentialsException', 'httpStatusCode' => 408, 'senderFault' => true, ], 'exception' => true, ], 'InvalidGlobalReplicationGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidGlobalReplicationGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidKMSKeyFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidKMSKeyFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidParameterCombinationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'AwsQueryErrorMessage', ], ], 'error' => [ 'code' => 'InvalidParameterCombination', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, 'synthetic' => true, ], 'InvalidParameterValueException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'AwsQueryErrorMessage', ], ], 'error' => [ 'code' => 'InvalidParameterValue', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, 'synthetic' => true, ], 'InvalidReplicationGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidReplicationGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidServerlessCacheSnapshotStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidServerlessCacheSnapshotStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidServerlessCacheStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidServerlessCacheStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidSnapshotStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidSnapshotState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidSubnet' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidSubnet', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidUserGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidUserGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidUserStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidUserState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidVPCNetworkStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidVPCNetworkStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'IpDiscovery' => [ 'type' => 'string', 'enum' => [ 'ipv4', 'ipv6', ], ], 'KeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'KinesisFirehoseDestinationDetails' => [ 'type' => 'structure', 'members' => [ 'DeliveryStream' => [ 'shape' => 'String', ], ], ], 'ListAllowedNodeTypeModificationsMessage' => [ 'type' => 'structure', 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'ReplicationGroupId' => [ 'shape' => 'String', ], ], ], 'ListTagsForResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], ], ], 'LogDeliveryConfiguration' => [ 'type' => 'structure', 'members' => [ 'LogType' => [ 'shape' => 'LogType', ], 'DestinationType' => [ 'shape' => 'DestinationType', ], 'DestinationDetails' => [ 'shape' => 'DestinationDetails', ], 'LogFormat' => [ 'shape' => 'LogFormat', ], 'Status' => [ 'shape' => 'LogDeliveryConfigurationStatus', ], 'Message' => [ 'shape' => 'String', ], ], ], 'LogDeliveryConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LogDeliveryConfiguration', 'locationName' => 'LogDeliveryConfiguration', ], ], 'LogDeliveryConfigurationRequest' => [ 'type' => 'structure', 'members' => [ 'LogType' => [ 'shape' => 'LogType', ], 'DestinationType' => [ 'shape' => 'DestinationType', ], 'DestinationDetails' => [ 'shape' => 'DestinationDetails', ], 'LogFormat' => [ 'shape' => 'LogFormat', ], 'Enabled' => [ 'shape' => 'BooleanOptional', ], ], ], 'LogDeliveryConfigurationRequestList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LogDeliveryConfigurationRequest', 'locationName' => 'LogDeliveryConfigurationRequest', ], ], 'LogDeliveryConfigurationStatus' => [ 'type' => 'string', 'enum' => [ 'active', 'enabling', 'modifying', 'disabling', 'error', ], ], 'LogFormat' => [ 'type' => 'string', 'enum' => [ 'text', 'json', ], ], 'LogType' => [ 'type' => 'string', 'enum' => [ 'slow-log', 'engine-log', ], ], 'ModifyCacheClusterMessage' => [ 'type' => 'structure', 'required' => [ 'CacheClusterId', ], 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'NumCacheNodes' => [ 'shape' => 'IntegerOptional', ], 'CacheNodeIdsToRemove' => [ 'shape' => 'CacheNodeIdsList', ], 'AZMode' => [ 'shape' => 'AZMode', ], 'NewAvailabilityZones' => [ 'shape' => 'PreferredAvailabilityZoneList', ], 'CacheSecurityGroupNames' => [ 'shape' => 'CacheSecurityGroupNameList', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdsList', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'NotificationTopicArn' => [ 'shape' => 'String', ], 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'NotificationTopicStatus' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'SnapshotWindow' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'AuthToken' => [ 'shape' => 'String', ], 'AuthTokenUpdateStrategy' => [ 'shape' => 'AuthTokenUpdateStrategyType', ], 'LogDeliveryConfigurations' => [ 'shape' => 'LogDeliveryConfigurationRequestList', ], 'IpDiscovery' => [ 'shape' => 'IpDiscovery', ], ], ], 'ModifyCacheClusterResult' => [ 'type' => 'structure', 'members' => [ 'CacheCluster' => [ 'shape' => 'CacheCluster', ], ], ], 'ModifyCacheParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheParameterGroupName', 'ParameterNameValues', ], 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'ParameterNameValues' => [ 'shape' => 'ParameterNameValueList', ], ], ], 'ModifyCacheSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheSubnetGroupName', ], 'members' => [ 'CacheSubnetGroupName' => [ 'shape' => 'String', ], 'CacheSubnetGroupDescription' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdentifierList', ], ], ], 'ModifyCacheSubnetGroupResult' => [ 'type' => 'structure', 'members' => [ 'CacheSubnetGroup' => [ 'shape' => 'CacheSubnetGroup', ], ], ], 'ModifyGlobalReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalReplicationGroupId', 'ApplyImmediately', ], 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'GlobalReplicationGroupDescription' => [ 'shape' => 'String', ], 'AutomaticFailoverEnabled' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyGlobalReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroup' => [ 'shape' => 'GlobalReplicationGroup', ], ], ], 'ModifyReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'ReplicationGroupDescription' => [ 'shape' => 'String', ], 'PrimaryClusterId' => [ 'shape' => 'String', ], 'SnapshottingClusterId' => [ 'shape' => 'String', ], 'AutomaticFailoverEnabled' => [ 'shape' => 'BooleanOptional', ], 'MultiAZEnabled' => [ 'shape' => 'BooleanOptional', ], 'NodeGroupId' => [ 'shape' => 'String', 'deprecated' => true, ], 'CacheSecurityGroupNames' => [ 'shape' => 'CacheSecurityGroupNameList', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdsList', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'NotificationTopicArn' => [ 'shape' => 'String', ], 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'NotificationTopicStatus' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'SnapshotWindow' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'AuthToken' => [ 'shape' => 'String', ], 'AuthTokenUpdateStrategy' => [ 'shape' => 'AuthTokenUpdateStrategyType', ], 'UserGroupIdsToAdd' => [ 'shape' => 'UserGroupIdList', ], 'UserGroupIdsToRemove' => [ 'shape' => 'UserGroupIdList', ], 'RemoveUserGroups' => [ 'shape' => 'BooleanOptional', ], 'LogDeliveryConfigurations' => [ 'shape' => 'LogDeliveryConfigurationRequestList', ], 'IpDiscovery' => [ 'shape' => 'IpDiscovery', ], 'TransitEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'TransitEncryptionMode' => [ 'shape' => 'TransitEncryptionMode', ], 'ClusterMode' => [ 'shape' => 'ClusterMode', ], ], ], 'ModifyReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'ModifyReplicationGroupShardConfigurationMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', 'NodeGroupCount', 'ApplyImmediately', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'NodeGroupCount' => [ 'shape' => 'Integer', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'ReshardingConfiguration' => [ 'shape' => 'ReshardingConfigurationList', ], 'NodeGroupsToRemove' => [ 'shape' => 'NodeGroupsToRemoveList', ], 'NodeGroupsToRetain' => [ 'shape' => 'NodeGroupsToRetainList', ], ], ], 'ModifyReplicationGroupShardConfigurationResult' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'ModifyServerlessCacheRequest' => [ 'type' => 'structure', 'required' => [ 'ServerlessCacheName', ], 'members' => [ 'ServerlessCacheName' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'CacheUsageLimits' => [ 'shape' => 'CacheUsageLimits', ], 'RemoveUserGroup' => [ 'shape' => 'BooleanOptional', ], 'UserGroupId' => [ 'shape' => 'String', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdsList', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'DailySnapshotTime' => [ 'shape' => 'String', ], ], ], 'ModifyServerlessCacheResponse' => [ 'type' => 'structure', 'members' => [ 'ServerlessCache' => [ 'shape' => 'ServerlessCache', ], ], ], 'ModifyUserGroupMessage' => [ 'type' => 'structure', 'required' => [ 'UserGroupId', ], 'members' => [ 'UserGroupId' => [ 'shape' => 'String', ], 'UserIdsToAdd' => [ 'shape' => 'UserIdListInput', ], 'UserIdsToRemove' => [ 'shape' => 'UserIdListInput', ], ], ], 'ModifyUserMessage' => [ 'type' => 'structure', 'required' => [ 'UserId', ], 'members' => [ 'UserId' => [ 'shape' => 'UserId', ], 'AccessString' => [ 'shape' => 'AccessString', ], 'AppendAccessString' => [ 'shape' => 'AccessString', ], 'Passwords' => [ 'shape' => 'PasswordListInput', ], 'NoPasswordRequired' => [ 'shape' => 'BooleanOptional', ], 'AuthenticationMode' => [ 'shape' => 'AuthenticationMode', ], ], ], 'MultiAZStatus' => [ 'type' => 'string', 'enum' => [ 'enabled', 'disabled', ], ], 'NetworkType' => [ 'type' => 'string', 'enum' => [ 'ipv4', 'ipv6', 'dual_stack', ], ], 'NetworkTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkType', ], ], 'NoOperationFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'NoOperationFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'NodeGroup' => [ 'type' => 'structure', 'members' => [ 'NodeGroupId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'PrimaryEndpoint' => [ 'shape' => 'Endpoint', ], 'ReaderEndpoint' => [ 'shape' => 'Endpoint', ], 'Slots' => [ 'shape' => 'String', ], 'NodeGroupMembers' => [ 'shape' => 'NodeGroupMemberList', ], ], ], 'NodeGroupConfiguration' => [ 'type' => 'structure', 'members' => [ 'NodeGroupId' => [ 'shape' => 'AllowedNodeGroupId', ], 'Slots' => [ 'shape' => 'String', ], 'ReplicaCount' => [ 'shape' => 'IntegerOptional', ], 'PrimaryAvailabilityZone' => [ 'shape' => 'String', ], 'ReplicaAvailabilityZones' => [ 'shape' => 'AvailabilityZonesList', ], 'PrimaryOutpostArn' => [ 'shape' => 'String', ], 'ReplicaOutpostArns' => [ 'shape' => 'OutpostArnsList', ], ], ], 'NodeGroupConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NodeGroupConfiguration', 'locationName' => 'NodeGroupConfiguration', ], ], 'NodeGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NodeGroup', 'locationName' => 'NodeGroup', ], ], 'NodeGroupMember' => [ 'type' => 'structure', 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'CacheNodeId' => [ 'shape' => 'String', ], 'ReadEndpoint' => [ 'shape' => 'Endpoint', ], 'PreferredAvailabilityZone' => [ 'shape' => 'String', ], 'PreferredOutpostArn' => [ 'shape' => 'String', ], 'CurrentRole' => [ 'shape' => 'String', ], ], ], 'NodeGroupMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NodeGroupMember', 'locationName' => 'NodeGroupMember', ], ], 'NodeGroupMemberUpdateStatus' => [ 'type' => 'structure', 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'CacheNodeId' => [ 'shape' => 'String', ], 'NodeUpdateStatus' => [ 'shape' => 'NodeUpdateStatus', ], 'NodeDeletionDate' => [ 'shape' => 'TStamp', ], 'NodeUpdateStartDate' => [ 'shape' => 'TStamp', ], 'NodeUpdateEndDate' => [ 'shape' => 'TStamp', ], 'NodeUpdateInitiatedBy' => [ 'shape' => 'NodeUpdateInitiatedBy', ], 'NodeUpdateInitiatedDate' => [ 'shape' => 'TStamp', ], 'NodeUpdateStatusModifiedDate' => [ 'shape' => 'TStamp', ], ], ], 'NodeGroupMemberUpdateStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NodeGroupMemberUpdateStatus', 'locationName' => 'NodeGroupMemberUpdateStatus', ], ], 'NodeGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'NodeGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'NodeGroupUpdateStatus' => [ 'type' => 'structure', 'members' => [ 'NodeGroupId' => [ 'shape' => 'String', ], 'NodeGroupMemberUpdateStatus' => [ 'shape' => 'NodeGroupMemberUpdateStatusList', ], ], ], 'NodeGroupUpdateStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NodeGroupUpdateStatus', 'locationName' => 'NodeGroupUpdateStatus', ], ], 'NodeGroupsPerReplicationGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'NodeGroupsPerReplicationGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'NodeGroupsToRemoveList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AllowedNodeGroupId', 'locationName' => 'NodeGroupToRemove', ], ], 'NodeGroupsToRetainList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AllowedNodeGroupId', 'locationName' => 'NodeGroupToRetain', ], ], 'NodeQuotaForClusterExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'NodeQuotaForClusterExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'NodeQuotaForCustomerExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'NodeQuotaForCustomerExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'NodeSnapshot' => [ 'type' => 'structure', 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'NodeGroupId' => [ 'shape' => 'String', ], 'CacheNodeId' => [ 'shape' => 'String', ], 'NodeGroupConfiguration' => [ 'shape' => 'NodeGroupConfiguration', ], 'CacheSize' => [ 'shape' => 'String', ], 'CacheNodeCreateTime' => [ 'shape' => 'TStamp', ], 'SnapshotCreateTime' => [ 'shape' => 'TStamp', ], ], 'wrapper' => true, ], 'NodeSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NodeSnapshot', 'locationName' => 'NodeSnapshot', ], ], 'NodeTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'NodeUpdateInitiatedBy' => [ 'type' => 'string', 'enum' => [ 'system', 'customer', ], ], 'NodeUpdateStatus' => [ 'type' => 'string', 'enum' => [ 'not-applied', 'waiting-to-start', 'in-progress', 'stopping', 'stopped', 'complete', ], ], 'NotificationConfiguration' => [ 'type' => 'structure', 'members' => [ 'TopicArn' => [ 'shape' => 'String', ], 'TopicStatus' => [ 'shape' => 'String', ], ], ], 'OutpostArnsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'OutpostArn', ], ], 'OutpostMode' => [ 'type' => 'string', 'enum' => [ 'single-outpost', 'cross-outpost', ], ], 'Parameter' => [ 'type' => 'structure', 'members' => [ 'ParameterName' => [ 'shape' => 'String', ], 'ParameterValue' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'DataType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], 'ChangeType' => [ 'shape' => 'ChangeType', ], ], ], 'ParameterNameValue' => [ 'type' => 'structure', 'members' => [ 'ParameterName' => [ 'shape' => 'String', ], 'ParameterValue' => [ 'shape' => 'String', ], ], ], 'ParameterNameValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParameterNameValue', 'locationName' => 'ParameterNameValue', ], ], 'ParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', 'locationName' => 'Parameter', ], ], 'PasswordListInput' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'min' => 1, ], 'PendingAutomaticFailoverStatus' => [ 'type' => 'string', 'enum' => [ 'enabled', 'disabled', ], ], 'PendingLogDeliveryConfiguration' => [ 'type' => 'structure', 'members' => [ 'LogType' => [ 'shape' => 'LogType', ], 'DestinationType' => [ 'shape' => 'DestinationType', ], 'DestinationDetails' => [ 'shape' => 'DestinationDetails', ], 'LogFormat' => [ 'shape' => 'LogFormat', ], ], ], 'PendingLogDeliveryConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingLogDeliveryConfiguration', ], 'locationName' => 'PendingLogDeliveryConfiguration', ], 'PendingModifiedValues' => [ 'type' => 'structure', 'members' => [ 'NumCacheNodes' => [ 'shape' => 'IntegerOptional', ], 'CacheNodeIdsToRemove' => [ 'shape' => 'CacheNodeIdsList', ], 'EngineVersion' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'AuthTokenStatus' => [ 'shape' => 'AuthTokenUpdateStatus', ], 'LogDeliveryConfigurations' => [ 'shape' => 'PendingLogDeliveryConfigurationList', ], 'TransitEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'TransitEncryptionMode' => [ 'shape' => 'TransitEncryptionMode', ], ], ], 'PreferredAvailabilityZoneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'PreferredAvailabilityZone', ], ], 'PreferredOutpostArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'PreferredOutpostArn', ], ], 'ProcessedUpdateAction' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'CacheClusterId' => [ 'shape' => 'String', ], 'ServiceUpdateName' => [ 'shape' => 'String', ], 'UpdateActionStatus' => [ 'shape' => 'UpdateActionStatus', ], ], ], 'ProcessedUpdateActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessedUpdateAction', 'locationName' => 'ProcessedUpdateAction', ], ], 'PurchaseReservedCacheNodesOfferingMessage' => [ 'type' => 'structure', 'required' => [ 'ReservedCacheNodesOfferingId', ], 'members' => [ 'ReservedCacheNodesOfferingId' => [ 'shape' => 'String', ], 'ReservedCacheNodeId' => [ 'shape' => 'String', ], 'CacheNodeCount' => [ 'shape' => 'IntegerOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'PurchaseReservedCacheNodesOfferingResult' => [ 'type' => 'structure', 'members' => [ 'ReservedCacheNode' => [ 'shape' => 'ReservedCacheNode', ], ], ], 'RebalanceSlotsInGlobalReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalReplicationGroupId', 'ApplyImmediately', ], 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], ], ], 'RebalanceSlotsInGlobalReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroup' => [ 'shape' => 'GlobalReplicationGroup', ], ], ], 'RebootCacheClusterMessage' => [ 'type' => 'structure', 'required' => [ 'CacheClusterId', 'CacheNodeIdsToReboot', ], 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'CacheNodeIdsToReboot' => [ 'shape' => 'CacheNodeIdsList', ], ], ], 'RebootCacheClusterResult' => [ 'type' => 'structure', 'members' => [ 'CacheCluster' => [ 'shape' => 'CacheCluster', ], ], ], 'RecurringCharge' => [ 'type' => 'structure', 'members' => [ 'RecurringChargeAmount' => [ 'shape' => 'Double', ], 'RecurringChargeFrequency' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'RecurringChargeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecurringCharge', 'locationName' => 'RecurringCharge', ], ], 'RegionalConfiguration' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', 'ReplicationGroupRegion', 'ReshardingConfiguration', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'ReplicationGroupRegion' => [ 'shape' => 'String', ], 'ReshardingConfiguration' => [ 'shape' => 'ReshardingConfigurationList', ], ], ], 'RegionalConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegionalConfiguration', 'locationName' => 'RegionalConfiguration', ], ], 'RemoveReplicasList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RemoveTagsFromResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', 'TagKeys', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'TagKeys' => [ 'shape' => 'KeyList', ], ], ], 'ReplicaConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigureShard', 'locationName' => 'ConfigureShard', ], ], 'ReplicationGroup' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'GlobalReplicationGroupInfo' => [ 'shape' => 'GlobalReplicationGroupInfo', ], 'Status' => [ 'shape' => 'String', ], 'PendingModifiedValues' => [ 'shape' => 'ReplicationGroupPendingModifiedValues', ], 'MemberClusters' => [ 'shape' => 'ClusterIdList', ], 'NodeGroups' => [ 'shape' => 'NodeGroupList', ], 'SnapshottingClusterId' => [ 'shape' => 'String', ], 'AutomaticFailover' => [ 'shape' => 'AutomaticFailoverStatus', ], 'MultiAZ' => [ 'shape' => 'MultiAZStatus', ], 'ConfigurationEndpoint' => [ 'shape' => 'Endpoint', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'SnapshotWindow' => [ 'shape' => 'String', ], 'ClusterEnabled' => [ 'shape' => 'BooleanOptional', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'AuthTokenEnabled' => [ 'shape' => 'BooleanOptional', ], 'AuthTokenLastModifiedDate' => [ 'shape' => 'TStamp', ], 'TransitEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'AtRestEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'MemberClustersOutpostArns' => [ 'shape' => 'ReplicationGroupOutpostArnList', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'ARN' => [ 'shape' => 'String', ], 'UserGroupIds' => [ 'shape' => 'UserGroupIdList', ], 'LogDeliveryConfigurations' => [ 'shape' => 'LogDeliveryConfigurationList', ], 'ReplicationGroupCreateTime' => [ 'shape' => 'TStamp', ], 'DataTiering' => [ 'shape' => 'DataTieringStatus', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'NetworkType' => [ 'shape' => 'NetworkType', ], 'IpDiscovery' => [ 'shape' => 'IpDiscovery', ], 'TransitEncryptionMode' => [ 'shape' => 'TransitEncryptionMode', ], 'ClusterMode' => [ 'shape' => 'ClusterMode', ], ], 'wrapper' => true, ], 'ReplicationGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReplicationGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ReplicationGroupAlreadyUnderMigrationFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReplicationGroupAlreadyUnderMigrationFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ReplicationGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 20, ], 'ReplicationGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReplicationGroup', 'locationName' => 'ReplicationGroup', ], ], 'ReplicationGroupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ReplicationGroups' => [ 'shape' => 'ReplicationGroupList', ], ], ], 'ReplicationGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReplicationGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ReplicationGroupNotUnderMigrationFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReplicationGroupNotUnderMigrationFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ReplicationGroupOutpostArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ReplicationGroupOutpostArn', ], ], 'ReplicationGroupPendingModifiedValues' => [ 'type' => 'structure', 'members' => [ 'PrimaryClusterId' => [ 'shape' => 'String', ], 'AutomaticFailoverStatus' => [ 'shape' => 'PendingAutomaticFailoverStatus', ], 'Resharding' => [ 'shape' => 'ReshardingStatus', ], 'AuthTokenStatus' => [ 'shape' => 'AuthTokenUpdateStatus', ], 'UserGroups' => [ 'shape' => 'UserGroupsUpdateStatus', ], 'LogDeliveryConfigurations' => [ 'shape' => 'PendingLogDeliveryConfigurationList', ], 'TransitEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'TransitEncryptionMode' => [ 'shape' => 'TransitEncryptionMode', ], 'ClusterMode' => [ 'shape' => 'ClusterMode', ], ], ], 'ReservedCacheNode' => [ 'type' => 'structure', 'members' => [ 'ReservedCacheNodeId' => [ 'shape' => 'String', ], 'ReservedCacheNodesOfferingId' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'StartTime' => [ 'shape' => 'TStamp', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CacheNodeCount' => [ 'shape' => 'Integer', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'State' => [ 'shape' => 'String', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], 'ReservationARN' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'ReservedCacheNodeAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedCacheNodeAlreadyExists', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ReservedCacheNodeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedCacheNode', 'locationName' => 'ReservedCacheNode', ], ], 'ReservedCacheNodeMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ReservedCacheNodes' => [ 'shape' => 'ReservedCacheNodeList', ], ], ], 'ReservedCacheNodeNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedCacheNodeNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ReservedCacheNodeQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedCacheNodeQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ReservedCacheNodesOffering' => [ 'type' => 'structure', 'members' => [ 'ReservedCacheNodesOfferingId' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], 'wrapper' => true, ], 'ReservedCacheNodesOfferingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedCacheNodesOffering', 'locationName' => 'ReservedCacheNodesOffering', ], ], 'ReservedCacheNodesOfferingMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ReservedCacheNodesOfferings' => [ 'shape' => 'ReservedCacheNodesOfferingList', ], ], ], 'ReservedCacheNodesOfferingNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedCacheNodesOfferingNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResetCacheParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheParameterGroupName', ], 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'ResetAllParameters' => [ 'shape' => 'Boolean', ], 'ParameterNameValues' => [ 'shape' => 'ParameterNameValueList', ], ], ], 'ReshardingConfiguration' => [ 'type' => 'structure', 'members' => [ 'NodeGroupId' => [ 'shape' => 'AllowedNodeGroupId', ], 'PreferredAvailabilityZones' => [ 'shape' => 'AvailabilityZonesList', ], ], ], 'ReshardingConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReshardingConfiguration', 'locationName' => 'ReshardingConfiguration', ], ], 'ReshardingStatus' => [ 'type' => 'structure', 'members' => [ 'SlotMigration' => [ 'shape' => 'SlotMigration', ], ], ], 'RevokeCacheSecurityGroupIngressMessage' => [ 'type' => 'structure', 'required' => [ 'CacheSecurityGroupName', 'EC2SecurityGroupName', 'EC2SecurityGroupOwnerId', ], 'members' => [ 'CacheSecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'RevokeCacheSecurityGroupIngressResult' => [ 'type' => 'structure', 'members' => [ 'CacheSecurityGroup' => [ 'shape' => 'CacheSecurityGroup', ], ], ], 'SecurityGroupIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SecurityGroupId', ], ], 'SecurityGroupMembership' => [ 'type' => 'structure', 'members' => [ 'SecurityGroupId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'SecurityGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupMembership', ], ], 'ServerlessCache' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheName' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'CreateTime' => [ 'shape' => 'TStamp', ], 'Status' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'FullEngineVersion' => [ 'shape' => 'String', ], 'CacheUsageLimits' => [ 'shape' => 'CacheUsageLimits', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdsList', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], 'ReaderEndpoint' => [ 'shape' => 'Endpoint', ], 'ARN' => [ 'shape' => 'String', ], 'UserGroupId' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdsList', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'DailySnapshotTime' => [ 'shape' => 'String', ], ], ], 'ServerlessCacheAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ServerlessCacheAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ServerlessCacheConfiguration' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], ], ], 'ServerlessCacheList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServerlessCache', ], ], 'ServerlessCacheNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ServerlessCacheNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ServerlessCacheQuotaForCustomerExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ServerlessCacheQuotaForCustomerExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ServerlessCacheSnapshot' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheSnapshotName' => [ 'shape' => 'String', ], 'ARN' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'CreateTime' => [ 'shape' => 'TStamp', ], 'ExpiryTime' => [ 'shape' => 'TStamp', ], 'BytesUsedForCache' => [ 'shape' => 'String', ], 'ServerlessCacheConfiguration' => [ 'shape' => 'ServerlessCacheConfiguration', ], ], ], 'ServerlessCacheSnapshotAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ServerlessCacheSnapshotAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ServerlessCacheSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServerlessCacheSnapshot', 'locationName' => 'ServerlessCacheSnapshot', ], ], 'ServerlessCacheSnapshotNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ServerlessCacheSnapshotNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ServerlessCacheSnapshotQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ServerlessCacheSnapshotQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ServiceLinkedRoleNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ServiceLinkedRoleNotFoundFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ServiceUpdate' => [ 'type' => 'structure', 'members' => [ 'ServiceUpdateName' => [ 'shape' => 'String', ], 'ServiceUpdateReleaseDate' => [ 'shape' => 'TStamp', ], 'ServiceUpdateEndDate' => [ 'shape' => 'TStamp', ], 'ServiceUpdateSeverity' => [ 'shape' => 'ServiceUpdateSeverity', ], 'ServiceUpdateRecommendedApplyByDate' => [ 'shape' => 'TStamp', ], 'ServiceUpdateStatus' => [ 'shape' => 'ServiceUpdateStatus', ], 'ServiceUpdateDescription' => [ 'shape' => 'String', ], 'ServiceUpdateType' => [ 'shape' => 'ServiceUpdateType', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoUpdateAfterRecommendedApplyByDate' => [ 'shape' => 'BooleanOptional', ], 'EstimatedUpdateTime' => [ 'shape' => 'String', ], ], ], 'ServiceUpdateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceUpdate', 'locationName' => 'ServiceUpdate', ], ], 'ServiceUpdateNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ServiceUpdateNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ServiceUpdateSeverity' => [ 'type' => 'string', 'enum' => [ 'critical', 'important', 'medium', 'low', ], ], 'ServiceUpdateStatus' => [ 'type' => 'string', 'enum' => [ 'available', 'cancelled', 'expired', ], ], 'ServiceUpdateStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceUpdateStatus', ], 'max' => 3, ], 'ServiceUpdateType' => [ 'type' => 'string', 'enum' => [ 'security-update', ], ], 'ServiceUpdatesMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ServiceUpdates' => [ 'shape' => 'ServiceUpdateList', ], ], ], 'SlaMet' => [ 'type' => 'string', 'enum' => [ 'yes', 'no', 'n/a', ], ], 'SlotMigration' => [ 'type' => 'structure', 'members' => [ 'ProgressPercentage' => [ 'shape' => 'Double', ], ], ], 'Snapshot' => [ 'type' => 'structure', 'members' => [ 'SnapshotName' => [ 'shape' => 'String', ], 'ReplicationGroupId' => [ 'shape' => 'String', ], 'ReplicationGroupDescription' => [ 'shape' => 'String', ], 'CacheClusterId' => [ 'shape' => 'String', ], 'SnapshotStatus' => [ 'shape' => 'String', ], 'SnapshotSource' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'NumCacheNodes' => [ 'shape' => 'IntegerOptional', ], 'PreferredAvailabilityZone' => [ 'shape' => 'String', ], 'PreferredOutpostArn' => [ 'shape' => 'String', ], 'CacheClusterCreateTime' => [ 'shape' => 'TStamp', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'TopicArn' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'CacheSubnetGroupName' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'SnapshotWindow' => [ 'shape' => 'String', ], 'NumNodeGroups' => [ 'shape' => 'IntegerOptional', ], 'AutomaticFailover' => [ 'shape' => 'AutomaticFailoverStatus', ], 'NodeSnapshots' => [ 'shape' => 'NodeSnapshotList', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'ARN' => [ 'shape' => 'String', ], 'DataTiering' => [ 'shape' => 'DataTieringStatus', ], ], 'wrapper' => true, ], 'SnapshotAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SnapshotAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SnapshotArnsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SnapshotArn', ], ], 'SnapshotFeatureNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SnapshotFeatureNotSupportedFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Snapshot', 'locationName' => 'Snapshot', ], ], 'SnapshotNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SnapshotNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SnapshotQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SnapshotQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SourceType' => [ 'type' => 'string', 'enum' => [ 'cache-cluster', 'cache-parameter-group', 'cache-security-group', 'cache-subnet-group', 'replication-group', 'serverless-cache', 'serverless-cache-snapshot', 'user', 'user-group', ], ], 'StartMigrationMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', 'CustomerNodeEndpointList', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'CustomerNodeEndpointList' => [ 'shape' => 'CustomerNodeEndpointList', ], ], ], 'StartMigrationResponse' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'String' => [ 'type' => 'string', ], 'Subnet' => [ 'type' => 'structure', 'members' => [ 'SubnetIdentifier' => [ 'shape' => 'String', ], 'SubnetAvailabilityZone' => [ 'shape' => 'AvailabilityZone', ], 'SubnetOutpost' => [ 'shape' => 'SubnetOutpost', ], 'SupportedNetworkTypes' => [ 'shape' => 'NetworkTypeList', ], ], ], 'SubnetIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SubnetIdentifier', ], ], 'SubnetIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SubnetId', ], ], 'SubnetInUse' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubnetInUse', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SubnetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Subnet', 'locationName' => 'Subnet', ], ], 'SubnetNotAllowedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubnetNotAllowedFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SubnetOutpost' => [ 'type' => 'structure', 'members' => [ 'SubnetOutpostArn' => [ 'shape' => 'String', ], ], ], 'TStamp' => [ 'type' => 'timestamp', ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', 'locationName' => 'Tag', ], ], 'TagListMessage' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], 'TagNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'TagNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'TagQuotaPerResourceExceeded' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'TagQuotaPerResourceExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'TestFailoverMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', 'NodeGroupId', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'NodeGroupId' => [ 'shape' => 'AllowedNodeGroupId', ], ], ], 'TestFailoverNotAvailableFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'TestFailoverNotAvailableFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'TestFailoverResult' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'TestMigrationMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', 'CustomerNodeEndpointList', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'CustomerNodeEndpointList' => [ 'shape' => 'CustomerNodeEndpointList', ], ], ], 'TestMigrationResponse' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'TimeRangeFilter' => [ 'type' => 'structure', 'members' => [ 'StartTime' => [ 'shape' => 'TStamp', ], 'EndTime' => [ 'shape' => 'TStamp', ], ], ], 'TransitEncryptionMode' => [ 'type' => 'string', 'enum' => [ 'preferred', 'required', ], ], 'UGReplicationGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'UGServerlessCacheIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'UnprocessedUpdateAction' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'CacheClusterId' => [ 'shape' => 'String', ], 'ServiceUpdateName' => [ 'shape' => 'String', ], 'ErrorType' => [ 'shape' => 'String', ], 'ErrorMessage' => [ 'shape' => 'String', ], ], ], 'UnprocessedUpdateActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UnprocessedUpdateAction', 'locationName' => 'UnprocessedUpdateAction', ], ], 'UpdateAction' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'CacheClusterId' => [ 'shape' => 'String', ], 'ServiceUpdateName' => [ 'shape' => 'String', ], 'ServiceUpdateReleaseDate' => [ 'shape' => 'TStamp', ], 'ServiceUpdateSeverity' => [ 'shape' => 'ServiceUpdateSeverity', ], 'ServiceUpdateStatus' => [ 'shape' => 'ServiceUpdateStatus', ], 'ServiceUpdateRecommendedApplyByDate' => [ 'shape' => 'TStamp', ], 'ServiceUpdateType' => [ 'shape' => 'ServiceUpdateType', ], 'UpdateActionAvailableDate' => [ 'shape' => 'TStamp', ], 'UpdateActionStatus' => [ 'shape' => 'UpdateActionStatus', ], 'NodesUpdated' => [ 'shape' => 'String', ], 'UpdateActionStatusModifiedDate' => [ 'shape' => 'TStamp', ], 'SlaMet' => [ 'shape' => 'SlaMet', ], 'NodeGroupUpdateStatus' => [ 'shape' => 'NodeGroupUpdateStatusList', ], 'CacheNodeUpdateStatus' => [ 'shape' => 'CacheNodeUpdateStatusList', ], 'EstimatedUpdateTime' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], ], ], 'UpdateActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpdateAction', 'locationName' => 'UpdateAction', ], ], 'UpdateActionResultsMessage' => [ 'type' => 'structure', 'members' => [ 'ProcessedUpdateActions' => [ 'shape' => 'ProcessedUpdateActionList', ], 'UnprocessedUpdateActions' => [ 'shape' => 'UnprocessedUpdateActionList', ], ], ], 'UpdateActionStatus' => [ 'type' => 'string', 'enum' => [ 'not-applied', 'waiting-to-start', 'in-progress', 'stopping', 'stopped', 'complete', 'scheduling', 'scheduled', 'not-applicable', ], ], 'UpdateActionStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpdateActionStatus', ], 'max' => 9, ], 'UpdateActionsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'UpdateActions' => [ 'shape' => 'UpdateActionList', ], ], ], 'User' => [ 'type' => 'structure', 'members' => [ 'UserId' => [ 'shape' => 'String', ], 'UserName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'EngineType', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], 'AccessString' => [ 'shape' => 'String', ], 'UserGroupIds' => [ 'shape' => 'UserGroupIdList', ], 'Authentication' => [ 'shape' => 'Authentication', ], 'ARN' => [ 'shape' => 'String', ], ], ], 'UserAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'UserAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'UserGroup' => [ 'type' => 'structure', 'members' => [ 'UserGroupId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'EngineType', ], 'UserIds' => [ 'shape' => 'UserIdList', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], 'PendingChanges' => [ 'shape' => 'UserGroupPendingChanges', ], 'ReplicationGroups' => [ 'shape' => 'UGReplicationGroupIdList', ], 'ServerlessCaches' => [ 'shape' => 'UGServerlessCacheIdList', ], 'ARN' => [ 'shape' => 'String', ], ], ], 'UserGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'UserGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'UserGroupId' => [ 'type' => 'string', 'min' => 1, 'pattern' => '[a-zA-Z][a-zA-Z0-9\\-]*', ], 'UserGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserGroupId', ], ], 'UserGroupIdListInput' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserGroupId', ], 'min' => 1, ], 'UserGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserGroup', ], ], 'UserGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'UserGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'UserGroupPendingChanges' => [ 'type' => 'structure', 'members' => [ 'UserIdsToRemove' => [ 'shape' => 'UserIdList', ], 'UserIdsToAdd' => [ 'shape' => 'UserIdList', ], ], ], 'UserGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'UserGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'UserGroupsUpdateStatus' => [ 'type' => 'structure', 'members' => [ 'UserGroupIdsToAdd' => [ 'shape' => 'UserGroupIdList', ], 'UserGroupIdsToRemove' => [ 'shape' => 'UserGroupIdList', ], ], ], 'UserId' => [ 'type' => 'string', 'min' => 1, 'pattern' => '[a-zA-Z][a-zA-Z0-9\\-]*', ], 'UserIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserId', ], ], 'UserIdListInput' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserId', ], 'min' => 1, ], 'UserList' => [ 'type' => 'list', 'member' => [ 'shape' => 'User', ], ], 'UserName' => [ 'type' => 'string', 'min' => 1, ], 'UserNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'UserNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'UserQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'UserQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2015-02-02', 'endpointPrefix' => 'elasticache', 'protocol' => 'query', 'protocols' => [ 'query', ], 'serviceFullName' => 'Amazon ElastiCache', 'serviceId' => 'ElastiCache', 'signatureVersion' => 'v4', 'uid' => 'elasticache-2015-02-02', 'xmlNamespace' => 'http://elasticache.amazonaws.com/doc/2015-02-02/', ], 'operations' => [ 'AddTagsToResource' => [ 'name' => 'AddTagsToResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AddTagsToResourceMessage', ], 'output' => [ 'shape' => 'TagListMessage', 'resultWrapper' => 'AddTagsToResourceResult', ], 'errors' => [ [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'CacheSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'ReservedCacheNodeNotFoundFault', ], [ 'shape' => 'SnapshotNotFoundFault', ], [ 'shape' => 'UserNotFoundFault', ], [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheStateFault', ], [ 'shape' => 'ServerlessCacheSnapshotNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheSnapshotStateFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidARNFault', ], ], ], 'AuthorizeCacheSecurityGroupIngress' => [ 'name' => 'AuthorizeCacheSecurityGroupIngress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AuthorizeCacheSecurityGroupIngressMessage', ], 'output' => [ 'shape' => 'AuthorizeCacheSecurityGroupIngressResult', 'resultWrapper' => 'AuthorizeCacheSecurityGroupIngressResult', ], 'errors' => [ [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'InvalidCacheSecurityGroupStateFault', ], [ 'shape' => 'AuthorizationAlreadyExistsFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'BatchApplyUpdateAction' => [ 'name' => 'BatchApplyUpdateAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchApplyUpdateActionMessage', ], 'output' => [ 'shape' => 'UpdateActionResultsMessage', 'resultWrapper' => 'BatchApplyUpdateActionResult', ], 'errors' => [ [ 'shape' => 'ServiceUpdateNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'BatchStopUpdateAction' => [ 'name' => 'BatchStopUpdateAction', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'BatchStopUpdateActionMessage', ], 'output' => [ 'shape' => 'UpdateActionResultsMessage', 'resultWrapper' => 'BatchStopUpdateActionResult', ], 'errors' => [ [ 'shape' => 'ServiceUpdateNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'CompleteMigration' => [ 'name' => 'CompleteMigration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CompleteMigrationMessage', ], 'output' => [ 'shape' => 'CompleteMigrationResponse', 'resultWrapper' => 'CompleteMigrationResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'ReplicationGroupNotUnderMigrationFault', ], ], ], 'CopyServerlessCacheSnapshot' => [ 'name' => 'CopyServerlessCacheSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopyServerlessCacheSnapshotRequest', ], 'output' => [ 'shape' => 'CopyServerlessCacheSnapshotResponse', 'resultWrapper' => 'CopyServerlessCacheSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServerlessCacheSnapshotAlreadyExistsFault', ], [ 'shape' => 'ServerlessCacheSnapshotNotFoundFault', ], [ 'shape' => 'ServerlessCacheSnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidServerlessCacheSnapshotStateFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'CopySnapshot' => [ 'name' => 'CopySnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CopySnapshotMessage', ], 'output' => [ 'shape' => 'CopySnapshotResult', 'resultWrapper' => 'CopySnapshotResult', ], 'errors' => [ [ 'shape' => 'SnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotNotFoundFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidSnapshotStateFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'CreateCacheCluster' => [ 'name' => 'CreateCacheCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCacheClusterMessage', ], 'output' => [ 'shape' => 'CreateCacheClusterResult', 'resultWrapper' => 'CreateCacheClusterResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'CacheClusterAlreadyExistsFault', ], [ 'shape' => 'InsufficientCacheClusterCapacityFault', ], [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'CacheSubnetGroupNotFoundFault', ], [ 'shape' => 'ClusterQuotaForCustomerExceededFault', ], [ 'shape' => 'NodeQuotaForClusterExceededFault', ], [ 'shape' => 'NodeQuotaForCustomerExceededFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'CreateCacheParameterGroup' => [ 'name' => 'CreateCacheParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCacheParameterGroupMessage', ], 'output' => [ 'shape' => 'CreateCacheParameterGroupResult', 'resultWrapper' => 'CreateCacheParameterGroupResult', ], 'errors' => [ [ 'shape' => 'CacheParameterGroupQuotaExceededFault', ], [ 'shape' => 'CacheParameterGroupAlreadyExistsFault', ], [ 'shape' => 'InvalidCacheParameterGroupStateFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'CreateCacheSecurityGroup' => [ 'name' => 'CreateCacheSecurityGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCacheSecurityGroupMessage', ], 'output' => [ 'shape' => 'CreateCacheSecurityGroupResult', 'resultWrapper' => 'CreateCacheSecurityGroupResult', ], 'errors' => [ [ 'shape' => 'CacheSecurityGroupAlreadyExistsFault', ], [ 'shape' => 'CacheSecurityGroupQuotaExceededFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'CreateCacheSubnetGroup' => [ 'name' => 'CreateCacheSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateCacheSubnetGroupMessage', ], 'output' => [ 'shape' => 'CreateCacheSubnetGroupResult', 'resultWrapper' => 'CreateCacheSubnetGroupResult', ], 'errors' => [ [ 'shape' => 'CacheSubnetGroupAlreadyExistsFault', ], [ 'shape' => 'CacheSubnetGroupQuotaExceededFault', ], [ 'shape' => 'CacheSubnetQuotaExceededFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'SubnetNotAllowedFault', ], ], ], 'CreateGlobalReplicationGroup' => [ 'name' => 'CreateGlobalReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateGlobalReplicationGroupMessage', ], 'output' => [ 'shape' => 'CreateGlobalReplicationGroupResult', 'resultWrapper' => 'CreateGlobalReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'GlobalReplicationGroupAlreadyExistsFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'CreateReplicationGroup' => [ 'name' => 'CreateReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateReplicationGroupMessage', ], 'output' => [ 'shape' => 'CreateReplicationGroupResult', 'resultWrapper' => 'CreateReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'ReplicationGroupAlreadyExistsFault', ], [ 'shape' => 'InvalidUserGroupStateFault', ], [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'InsufficientCacheClusterCapacityFault', ], [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'CacheSubnetGroupNotFoundFault', ], [ 'shape' => 'ClusterQuotaForCustomerExceededFault', ], [ 'shape' => 'NodeQuotaForClusterExceededFault', ], [ 'shape' => 'NodeQuotaForCustomerExceededFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'NodeGroupsPerReplicationGroupQuotaExceededFault', ], [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'CreateServerlessCache' => [ 'name' => 'CreateServerlessCache', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateServerlessCacheRequest', ], 'output' => [ 'shape' => 'CreateServerlessCacheResponse', 'resultWrapper' => 'CreateServerlessCacheResult', ], 'errors' => [ [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheStateFault', ], [ 'shape' => 'ServerlessCacheAlreadyExistsFault', ], [ 'shape' => 'ServerlessCacheQuotaForCustomerExceededFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], [ 'shape' => 'InvalidCredentialsException', ], [ 'shape' => 'InvalidUserGroupStateFault', ], [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], ], ], 'CreateServerlessCacheSnapshot' => [ 'name' => 'CreateServerlessCacheSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateServerlessCacheSnapshotRequest', ], 'output' => [ 'shape' => 'CreateServerlessCacheSnapshotResponse', 'resultWrapper' => 'CreateServerlessCacheSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServerlessCacheSnapshotAlreadyExistsFault', ], [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheStateFault', ], [ 'shape' => 'ServerlessCacheSnapshotQuotaExceededFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'CreateSnapshot' => [ 'name' => 'CreateSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateSnapshotMessage', ], 'output' => [ 'shape' => 'CreateSnapshotResult', 'resultWrapper' => 'CreateSnapshotResult', ], 'errors' => [ [ 'shape' => 'SnapshotAlreadyExistsFault', ], [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'SnapshotFeatureNotSupportedFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidParameterCombinationException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'CreateUser' => [ 'name' => 'CreateUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserMessage', ], 'output' => [ 'shape' => 'User', 'resultWrapper' => 'CreateUserResult', ], 'errors' => [ [ 'shape' => 'UserAlreadyExistsFault', ], [ 'shape' => 'UserQuotaExceededFault', ], [ 'shape' => 'DuplicateUserNameFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], ], ], 'CreateUserGroup' => [ 'name' => 'CreateUserGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUserGroupMessage', ], 'output' => [ 'shape' => 'UserGroup', 'resultWrapper' => 'CreateUserGroupResult', ], 'errors' => [ [ 'shape' => 'UserNotFoundFault', ], [ 'shape' => 'DuplicateUserNameFault', ], [ 'shape' => 'UserGroupAlreadyExistsFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'DefaultUserRequired', ], [ 'shape' => 'UserGroupQuotaExceededFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], ], ], 'DecreaseNodeGroupsInGlobalReplicationGroup' => [ 'name' => 'DecreaseNodeGroupsInGlobalReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DecreaseNodeGroupsInGlobalReplicationGroupMessage', ], 'output' => [ 'shape' => 'DecreaseNodeGroupsInGlobalReplicationGroupResult', 'resultWrapper' => 'DecreaseNodeGroupsInGlobalReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DecreaseReplicaCount' => [ 'name' => 'DecreaseReplicaCount', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DecreaseReplicaCountMessage', ], 'output' => [ 'shape' => 'DecreaseReplicaCountResult', 'resultWrapper' => 'DecreaseReplicaCountResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InsufficientCacheClusterCapacityFault', ], [ 'shape' => 'ClusterQuotaForCustomerExceededFault', ], [ 'shape' => 'NodeGroupsPerReplicationGroupQuotaExceededFault', ], [ 'shape' => 'NodeQuotaForCustomerExceededFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'NoOperationFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DeleteCacheCluster' => [ 'name' => 'DeleteCacheCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCacheClusterMessage', ], 'output' => [ 'shape' => 'DeleteCacheClusterResult', 'resultWrapper' => 'DeleteCacheClusterResult', ], 'errors' => [ [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'SnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotFeatureNotSupportedFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DeleteCacheParameterGroup' => [ 'name' => 'DeleteCacheParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCacheParameterGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidCacheParameterGroupStateFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DeleteCacheSecurityGroup' => [ 'name' => 'DeleteCacheSecurityGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCacheSecurityGroupMessage', ], 'errors' => [ [ 'shape' => 'InvalidCacheSecurityGroupStateFault', ], [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DeleteCacheSubnetGroup' => [ 'name' => 'DeleteCacheSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteCacheSubnetGroupMessage', ], 'errors' => [ [ 'shape' => 'CacheSubnetGroupInUse', ], [ 'shape' => 'CacheSubnetGroupNotFoundFault', ], ], ], 'DeleteGlobalReplicationGroup' => [ 'name' => 'DeleteGlobalReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteGlobalReplicationGroupMessage', ], 'output' => [ 'shape' => 'DeleteGlobalReplicationGroupResult', 'resultWrapper' => 'DeleteGlobalReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DeleteReplicationGroup' => [ 'name' => 'DeleteReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteReplicationGroupMessage', ], 'output' => [ 'shape' => 'DeleteReplicationGroupResult', 'resultWrapper' => 'DeleteReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'SnapshotAlreadyExistsFault', ], [ 'shape' => 'SnapshotFeatureNotSupportedFault', ], [ 'shape' => 'SnapshotQuotaExceededFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DeleteServerlessCache' => [ 'name' => 'DeleteServerlessCache', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteServerlessCacheRequest', ], 'output' => [ 'shape' => 'DeleteServerlessCacheResponse', 'resultWrapper' => 'DeleteServerlessCacheResult', ], 'errors' => [ [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheStateFault', ], [ 'shape' => 'ServerlessCacheSnapshotAlreadyExistsFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], [ 'shape' => 'InvalidCredentialsException', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], ], ], 'DeleteServerlessCacheSnapshot' => [ 'name' => 'DeleteServerlessCacheSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteServerlessCacheSnapshotRequest', ], 'output' => [ 'shape' => 'DeleteServerlessCacheSnapshotResponse', 'resultWrapper' => 'DeleteServerlessCacheSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'ServerlessCacheSnapshotNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheSnapshotStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DeleteSnapshot' => [ 'name' => 'DeleteSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteSnapshotMessage', ], 'output' => [ 'shape' => 'DeleteSnapshotResult', 'resultWrapper' => 'DeleteSnapshotResult', ], 'errors' => [ [ 'shape' => 'SnapshotNotFoundFault', ], [ 'shape' => 'InvalidSnapshotStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DeleteUser' => [ 'name' => 'DeleteUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserMessage', ], 'output' => [ 'shape' => 'User', 'resultWrapper' => 'DeleteUserResult', ], 'errors' => [ [ 'shape' => 'InvalidUserStateFault', ], [ 'shape' => 'UserNotFoundFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'DefaultUserAssociatedToUserGroupFault', ], ], ], 'DeleteUserGroup' => [ 'name' => 'DeleteUserGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUserGroupMessage', ], 'output' => [ 'shape' => 'UserGroup', 'resultWrapper' => 'DeleteUserGroupResult', ], 'errors' => [ [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'InvalidUserGroupStateFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'DescribeCacheClusters' => [ 'name' => 'DescribeCacheClusters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCacheClustersMessage', ], 'output' => [ 'shape' => 'CacheClusterMessage', 'resultWrapper' => 'DescribeCacheClustersResult', ], 'errors' => [ [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeCacheEngineVersions' => [ 'name' => 'DescribeCacheEngineVersions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCacheEngineVersionsMessage', ], 'output' => [ 'shape' => 'CacheEngineVersionMessage', 'resultWrapper' => 'DescribeCacheEngineVersionsResult', ], ], 'DescribeCacheParameterGroups' => [ 'name' => 'DescribeCacheParameterGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCacheParameterGroupsMessage', ], 'output' => [ 'shape' => 'CacheParameterGroupsMessage', 'resultWrapper' => 'DescribeCacheParameterGroupsResult', ], 'errors' => [ [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeCacheParameters' => [ 'name' => 'DescribeCacheParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCacheParametersMessage', ], 'output' => [ 'shape' => 'CacheParameterGroupDetails', 'resultWrapper' => 'DescribeCacheParametersResult', ], 'errors' => [ [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeCacheSecurityGroups' => [ 'name' => 'DescribeCacheSecurityGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCacheSecurityGroupsMessage', ], 'output' => [ 'shape' => 'CacheSecurityGroupMessage', 'resultWrapper' => 'DescribeCacheSecurityGroupsResult', ], 'errors' => [ [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeCacheSubnetGroups' => [ 'name' => 'DescribeCacheSubnetGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeCacheSubnetGroupsMessage', ], 'output' => [ 'shape' => 'CacheSubnetGroupMessage', 'resultWrapper' => 'DescribeCacheSubnetGroupsResult', ], 'errors' => [ [ 'shape' => 'CacheSubnetGroupNotFoundFault', ], ], ], 'DescribeEngineDefaultParameters' => [ 'name' => 'DescribeEngineDefaultParameters', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEngineDefaultParametersMessage', ], 'output' => [ 'shape' => 'DescribeEngineDefaultParametersResult', 'resultWrapper' => 'DescribeEngineDefaultParametersResult', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeEvents' => [ 'name' => 'DescribeEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeEventsMessage', ], 'output' => [ 'shape' => 'EventsMessage', 'resultWrapper' => 'DescribeEventsResult', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeGlobalReplicationGroups' => [ 'name' => 'DescribeGlobalReplicationGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeGlobalReplicationGroupsMessage', ], 'output' => [ 'shape' => 'DescribeGlobalReplicationGroupsResult', 'resultWrapper' => 'DescribeGlobalReplicationGroupsResult', ], 'errors' => [ [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeReplicationGroups' => [ 'name' => 'DescribeReplicationGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeReplicationGroupsMessage', ], 'output' => [ 'shape' => 'ReplicationGroupMessage', 'resultWrapper' => 'DescribeReplicationGroupsResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeReservedCacheNodes' => [ 'name' => 'DescribeReservedCacheNodes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeReservedCacheNodesMessage', ], 'output' => [ 'shape' => 'ReservedCacheNodeMessage', 'resultWrapper' => 'DescribeReservedCacheNodesResult', ], 'errors' => [ [ 'shape' => 'ReservedCacheNodeNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeReservedCacheNodesOfferings' => [ 'name' => 'DescribeReservedCacheNodesOfferings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeReservedCacheNodesOfferingsMessage', ], 'output' => [ 'shape' => 'ReservedCacheNodesOfferingMessage', 'resultWrapper' => 'DescribeReservedCacheNodesOfferingsResult', ], 'errors' => [ [ 'shape' => 'ReservedCacheNodesOfferingNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeServerlessCacheSnapshots' => [ 'name' => 'DescribeServerlessCacheSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeServerlessCacheSnapshotsRequest', ], 'output' => [ 'shape' => 'DescribeServerlessCacheSnapshotsResponse', 'resultWrapper' => 'DescribeServerlessCacheSnapshotsResult', ], 'errors' => [ [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'ServerlessCacheSnapshotNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeServerlessCaches' => [ 'name' => 'DescribeServerlessCaches', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeServerlessCachesRequest', ], 'output' => [ 'shape' => 'DescribeServerlessCachesResponse', 'resultWrapper' => 'DescribeServerlessCachesResult', ], 'errors' => [ [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeServiceUpdates' => [ 'name' => 'DescribeServiceUpdates', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeServiceUpdatesMessage', ], 'output' => [ 'shape' => 'ServiceUpdatesMessage', 'resultWrapper' => 'DescribeServiceUpdatesResult', ], 'errors' => [ [ 'shape' => 'ServiceUpdateNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeSnapshots' => [ 'name' => 'DescribeSnapshots', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeSnapshotsMessage', ], 'output' => [ 'shape' => 'DescribeSnapshotsListMessage', 'resultWrapper' => 'DescribeSnapshotsResult', ], 'errors' => [ [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'SnapshotNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeUpdateActions' => [ 'name' => 'DescribeUpdateActions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUpdateActionsMessage', ], 'output' => [ 'shape' => 'UpdateActionsMessage', 'resultWrapper' => 'DescribeUpdateActionsResult', ], 'errors' => [ [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeUserGroups' => [ 'name' => 'DescribeUserGroups', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUserGroupsMessage', ], 'output' => [ 'shape' => 'DescribeUserGroupsResult', 'resultWrapper' => 'DescribeUserGroupsResult', ], 'errors' => [ [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DescribeUsers' => [ 'name' => 'DescribeUsers', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeUsersMessage', ], 'output' => [ 'shape' => 'DescribeUsersResult', 'resultWrapper' => 'DescribeUsersResult', ], 'errors' => [ [ 'shape' => 'UserNotFoundFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'DisassociateGlobalReplicationGroup' => [ 'name' => 'DisassociateGlobalReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateGlobalReplicationGroupMessage', ], 'output' => [ 'shape' => 'DisassociateGlobalReplicationGroupResult', 'resultWrapper' => 'DisassociateGlobalReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'ExportServerlessCacheSnapshot' => [ 'name' => 'ExportServerlessCacheSnapshot', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ExportServerlessCacheSnapshotRequest', ], 'output' => [ 'shape' => 'ExportServerlessCacheSnapshotResponse', 'resultWrapper' => 'ExportServerlessCacheSnapshotResult', ], 'errors' => [ [ 'shape' => 'ServerlessCacheSnapshotNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheSnapshotStateFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'FailoverGlobalReplicationGroup' => [ 'name' => 'FailoverGlobalReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'FailoverGlobalReplicationGroupMessage', ], 'output' => [ 'shape' => 'FailoverGlobalReplicationGroupResult', 'resultWrapper' => 'FailoverGlobalReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'IncreaseNodeGroupsInGlobalReplicationGroup' => [ 'name' => 'IncreaseNodeGroupsInGlobalReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'IncreaseNodeGroupsInGlobalReplicationGroupMessage', ], 'output' => [ 'shape' => 'IncreaseNodeGroupsInGlobalReplicationGroupResult', 'resultWrapper' => 'IncreaseNodeGroupsInGlobalReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'IncreaseReplicaCount' => [ 'name' => 'IncreaseReplicaCount', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'IncreaseReplicaCountMessage', ], 'output' => [ 'shape' => 'IncreaseReplicaCountResult', 'resultWrapper' => 'IncreaseReplicaCountResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InsufficientCacheClusterCapacityFault', ], [ 'shape' => 'ClusterQuotaForCustomerExceededFault', ], [ 'shape' => 'NodeGroupsPerReplicationGroupQuotaExceededFault', ], [ 'shape' => 'NodeQuotaForCustomerExceededFault', ], [ 'shape' => 'NoOperationFault', ], [ 'shape' => 'InvalidKMSKeyFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'ListAllowedNodeTypeModifications' => [ 'name' => 'ListAllowedNodeTypeModifications', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListAllowedNodeTypeModificationsMessage', ], 'output' => [ 'shape' => 'AllowedNodeTypeModificationsMessage', 'resultWrapper' => 'ListAllowedNodeTypeModificationsResult', ], 'errors' => [ [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterCombinationException', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTagsForResourceMessage', ], 'output' => [ 'shape' => 'TagListMessage', 'resultWrapper' => 'ListTagsForResourceResult', ], 'errors' => [ [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'CacheSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'ReservedCacheNodeNotFoundFault', ], [ 'shape' => 'SnapshotNotFoundFault', ], [ 'shape' => 'UserNotFoundFault', ], [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheStateFault', ], [ 'shape' => 'ServerlessCacheSnapshotNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheSnapshotStateFault', ], [ 'shape' => 'InvalidARNFault', ], ], ], 'ModifyCacheCluster' => [ 'name' => 'ModifyCacheCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyCacheClusterMessage', ], 'output' => [ 'shape' => 'ModifyCacheClusterResult', 'resultWrapper' => 'ModifyCacheClusterResult', ], 'errors' => [ [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'InvalidCacheSecurityGroupStateFault', ], [ 'shape' => 'InsufficientCacheClusterCapacityFault', ], [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'NodeQuotaForClusterExceededFault', ], [ 'shape' => 'NodeQuotaForCustomerExceededFault', ], [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'ModifyCacheParameterGroup' => [ 'name' => 'ModifyCacheParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyCacheParameterGroupMessage', ], 'output' => [ 'shape' => 'CacheParameterGroupNameMessage', 'resultWrapper' => 'ModifyCacheParameterGroupResult', ], 'errors' => [ [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidCacheParameterGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], ], ], 'ModifyCacheSubnetGroup' => [ 'name' => 'ModifyCacheSubnetGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyCacheSubnetGroupMessage', ], 'output' => [ 'shape' => 'ModifyCacheSubnetGroupResult', 'resultWrapper' => 'ModifyCacheSubnetGroupResult', ], 'errors' => [ [ 'shape' => 'CacheSubnetGroupNotFoundFault', ], [ 'shape' => 'CacheSubnetQuotaExceededFault', ], [ 'shape' => 'SubnetInUse', ], [ 'shape' => 'InvalidSubnet', ], [ 'shape' => 'SubnetNotAllowedFault', ], ], ], 'ModifyGlobalReplicationGroup' => [ 'name' => 'ModifyGlobalReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyGlobalReplicationGroupMessage', ], 'output' => [ 'shape' => 'ModifyGlobalReplicationGroupResult', 'resultWrapper' => 'ModifyGlobalReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'ModifyReplicationGroup' => [ 'name' => 'ModifyReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyReplicationGroupMessage', ], 'output' => [ 'shape' => 'ModifyReplicationGroupResult', 'resultWrapper' => 'ModifyReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'InvalidUserGroupStateFault', ], [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'InvalidCacheSecurityGroupStateFault', ], [ 'shape' => 'InsufficientCacheClusterCapacityFault', ], [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'NodeQuotaForClusterExceededFault', ], [ 'shape' => 'NodeQuotaForCustomerExceededFault', ], [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InvalidKMSKeyFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'ModifyReplicationGroupShardConfiguration' => [ 'name' => 'ModifyReplicationGroupShardConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyReplicationGroupShardConfigurationMessage', ], 'output' => [ 'shape' => 'ModifyReplicationGroupShardConfigurationResult', 'resultWrapper' => 'ModifyReplicationGroupShardConfigurationResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'InvalidVPCNetworkStateFault', ], [ 'shape' => 'InsufficientCacheClusterCapacityFault', ], [ 'shape' => 'NodeGroupsPerReplicationGroupQuotaExceededFault', ], [ 'shape' => 'NodeQuotaForCustomerExceededFault', ], [ 'shape' => 'InvalidKMSKeyFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'ModifyServerlessCache' => [ 'name' => 'ModifyServerlessCache', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyServerlessCacheRequest', ], 'output' => [ 'shape' => 'ModifyServerlessCacheResponse', 'resultWrapper' => 'ModifyServerlessCacheResult', ], 'errors' => [ [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], [ 'shape' => 'InvalidCredentialsException', ], [ 'shape' => 'InvalidUserGroupStateFault', ], [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], ], ], 'ModifyUser' => [ 'name' => 'ModifyUser', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyUserMessage', ], 'output' => [ 'shape' => 'User', 'resultWrapper' => 'ModifyUserResult', ], 'errors' => [ [ 'shape' => 'UserNotFoundFault', ], [ 'shape' => 'InvalidUserStateFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'ModifyUserGroup' => [ 'name' => 'ModifyUserGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ModifyUserGroupMessage', ], 'output' => [ 'shape' => 'UserGroup', 'resultWrapper' => 'ModifyUserGroupResult', ], 'errors' => [ [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'UserNotFoundFault', ], [ 'shape' => 'DuplicateUserNameFault', ], [ 'shape' => 'ServiceLinkedRoleNotFoundFault', ], [ 'shape' => 'DefaultUserRequired', ], [ 'shape' => 'InvalidUserGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'PurchaseReservedCacheNodesOffering' => [ 'name' => 'PurchaseReservedCacheNodesOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PurchaseReservedCacheNodesOfferingMessage', ], 'output' => [ 'shape' => 'PurchaseReservedCacheNodesOfferingResult', 'resultWrapper' => 'PurchaseReservedCacheNodesOfferingResult', ], 'errors' => [ [ 'shape' => 'ReservedCacheNodesOfferingNotFoundFault', ], [ 'shape' => 'ReservedCacheNodeAlreadyExistsFault', ], [ 'shape' => 'ReservedCacheNodeQuotaExceededFault', ], [ 'shape' => 'TagQuotaPerResourceExceeded', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'RebalanceSlotsInGlobalReplicationGroup' => [ 'name' => 'RebalanceSlotsInGlobalReplicationGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebalanceSlotsInGlobalReplicationGroupMessage', ], 'output' => [ 'shape' => 'RebalanceSlotsInGlobalReplicationGroupResult', 'resultWrapper' => 'RebalanceSlotsInGlobalReplicationGroupResult', ], 'errors' => [ [ 'shape' => 'GlobalReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'RebootCacheCluster' => [ 'name' => 'RebootCacheCluster', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RebootCacheClusterMessage', ], 'output' => [ 'shape' => 'RebootCacheClusterResult', 'resultWrapper' => 'RebootCacheClusterResult', ], 'errors' => [ [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'CacheClusterNotFoundFault', ], ], ], 'RemoveTagsFromResource' => [ 'name' => 'RemoveTagsFromResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RemoveTagsFromResourceMessage', ], 'output' => [ 'shape' => 'TagListMessage', 'resultWrapper' => 'RemoveTagsFromResourceResult', ], 'errors' => [ [ 'shape' => 'CacheClusterNotFoundFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'CacheSubnetGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'ReservedCacheNodeNotFoundFault', ], [ 'shape' => 'SnapshotNotFoundFault', ], [ 'shape' => 'UserNotFoundFault', ], [ 'shape' => 'UserGroupNotFoundFault', ], [ 'shape' => 'ServerlessCacheNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheStateFault', ], [ 'shape' => 'ServerlessCacheSnapshotNotFoundFault', ], [ 'shape' => 'InvalidServerlessCacheSnapshotStateFault', ], [ 'shape' => 'InvalidARNFault', ], [ 'shape' => 'TagNotFoundFault', ], ], ], 'ResetCacheParameterGroup' => [ 'name' => 'ResetCacheParameterGroup', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ResetCacheParameterGroupMessage', ], 'output' => [ 'shape' => 'CacheParameterGroupNameMessage', 'resultWrapper' => 'ResetCacheParameterGroupResult', ], 'errors' => [ [ 'shape' => 'InvalidCacheParameterGroupStateFault', ], [ 'shape' => 'CacheParameterGroupNotFoundFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], [ 'shape' => 'InvalidGlobalReplicationGroupStateFault', ], ], ], 'RevokeCacheSecurityGroupIngress' => [ 'name' => 'RevokeCacheSecurityGroupIngress', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RevokeCacheSecurityGroupIngressMessage', ], 'output' => [ 'shape' => 'RevokeCacheSecurityGroupIngressResult', 'resultWrapper' => 'RevokeCacheSecurityGroupIngressResult', ], 'errors' => [ [ 'shape' => 'CacheSecurityGroupNotFoundFault', ], [ 'shape' => 'AuthorizationNotFoundFault', ], [ 'shape' => 'InvalidCacheSecurityGroupStateFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'StartMigration' => [ 'name' => 'StartMigration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartMigrationMessage', ], 'output' => [ 'shape' => 'StartMigrationResponse', 'resultWrapper' => 'StartMigrationResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'ReplicationGroupAlreadyUnderMigrationFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], 'TestFailover' => [ 'name' => 'TestFailover', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TestFailoverMessage', ], 'output' => [ 'shape' => 'TestFailoverResult', 'resultWrapper' => 'TestFailoverResult', ], 'errors' => [ [ 'shape' => 'APICallRateForCustomerExceededFault', ], [ 'shape' => 'InvalidCacheClusterStateFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'NodeGroupNotFoundFault', ], [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'TestFailoverNotAvailableFault', ], [ 'shape' => 'InvalidKMSKeyFault', ], [ 'shape' => 'InvalidParameterValueException', ], [ 'shape' => 'InvalidParameterCombinationException', ], ], ], 'TestMigration' => [ 'name' => 'TestMigration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TestMigrationMessage', ], 'output' => [ 'shape' => 'TestMigrationResponse', 'resultWrapper' => 'TestMigrationResult', ], 'errors' => [ [ 'shape' => 'ReplicationGroupNotFoundFault', ], [ 'shape' => 'InvalidReplicationGroupStateFault', ], [ 'shape' => 'ReplicationGroupAlreadyUnderMigrationFault', ], [ 'shape' => 'InvalidParameterValueException', ], ], ], ], 'shapes' => [ 'APICallRateForCustomerExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'APICallRateForCustomerExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'AZMode' => [ 'type' => 'string', 'enum' => [ 'single-az', 'cross-az', ], ], 'AccessString' => [ 'type' => 'string', 'pattern' => '.*\\S.*', ], 'AddTagsToResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', 'Tags', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'AllowedNodeGroupId' => [ 'type' => 'string', 'max' => 4, 'min' => 1, 'pattern' => '\\d+', ], 'AllowedNodeTypeModificationsMessage' => [ 'type' => 'structure', 'members' => [ 'ScaleUpModifications' => [ 'shape' => 'NodeTypeList', ], 'ScaleDownModifications' => [ 'shape' => 'NodeTypeList', ], ], ], 'AuthTokenUpdateStatus' => [ 'type' => 'string', 'enum' => [ 'SETTING', 'ROTATING', ], ], 'AuthTokenUpdateStrategyType' => [ 'type' => 'string', 'enum' => [ 'SET', 'ROTATE', 'DELETE', ], ], 'Authentication' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'AuthenticationType', ], 'PasswordCount' => [ 'shape' => 'IntegerOptional', ], ], ], 'AuthenticationMode' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'InputAuthenticationType', ], 'Passwords' => [ 'shape' => 'PasswordListInput', ], ], ], 'AuthenticationType' => [ 'type' => 'string', 'enum' => [ 'password', 'no-password', 'iam', ], ], 'AuthorizationAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'AuthorizationNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'AuthorizationNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'AuthorizeCacheSecurityGroupIngressMessage' => [ 'type' => 'structure', 'required' => [ 'CacheSecurityGroupName', 'EC2SecurityGroupName', 'EC2SecurityGroupOwnerId', ], 'members' => [ 'CacheSecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'AuthorizeCacheSecurityGroupIngressResult' => [ 'type' => 'structure', 'members' => [ 'CacheSecurityGroup' => [ 'shape' => 'CacheSecurityGroup', ], ], ], 'AutomaticFailoverStatus' => [ 'type' => 'string', 'enum' => [ 'enabled', 'disabled', 'enabling', 'disabling', ], ], 'AvailabilityZone' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'AvailabilityZonesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'AvailabilityZone', ], ], 'AwsQueryErrorMessage' => [ 'type' => 'string', ], 'BatchApplyUpdateActionMessage' => [ 'type' => 'structure', 'required' => [ 'ServiceUpdateName', ], 'members' => [ 'ReplicationGroupIds' => [ 'shape' => 'ReplicationGroupIdList', ], 'CacheClusterIds' => [ 'shape' => 'CacheClusterIdList', ], 'ServiceUpdateName' => [ 'shape' => 'String', ], ], ], 'BatchStopUpdateActionMessage' => [ 'type' => 'structure', 'required' => [ 'ServiceUpdateName', ], 'members' => [ 'ReplicationGroupIds' => [ 'shape' => 'ReplicationGroupIdList', ], 'CacheClusterIds' => [ 'shape' => 'CacheClusterIdList', ], 'ServiceUpdateName' => [ 'shape' => 'String', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'BooleanOptional' => [ 'type' => 'boolean', ], 'CacheCluster' => [ 'type' => 'structure', 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'ConfigurationEndpoint' => [ 'shape' => 'Endpoint', ], 'ClientDownloadLandingPage' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'CacheClusterStatus' => [ 'shape' => 'String', ], 'NumCacheNodes' => [ 'shape' => 'IntegerOptional', ], 'PreferredAvailabilityZone' => [ 'shape' => 'String', ], 'PreferredOutpostArn' => [ 'shape' => 'String', ], 'CacheClusterCreateTime' => [ 'shape' => 'TStamp', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'PendingModifiedValues' => [ 'shape' => 'PendingModifiedValues', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', ], 'CacheSecurityGroups' => [ 'shape' => 'CacheSecurityGroupMembershipList', ], 'CacheParameterGroup' => [ 'shape' => 'CacheParameterGroupStatus', ], 'CacheSubnetGroupName' => [ 'shape' => 'String', ], 'CacheNodes' => [ 'shape' => 'CacheNodeList', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'SecurityGroups' => [ 'shape' => 'SecurityGroupMembershipList', ], 'ReplicationGroupId' => [ 'shape' => 'String', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'SnapshotWindow' => [ 'shape' => 'String', ], 'AuthTokenEnabled' => [ 'shape' => 'BooleanOptional', ], 'AuthTokenLastModifiedDate' => [ 'shape' => 'TStamp', ], 'TransitEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'AtRestEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'ARN' => [ 'shape' => 'String', ], 'ReplicationGroupLogDeliveryEnabled' => [ 'shape' => 'Boolean', ], 'LogDeliveryConfigurations' => [ 'shape' => 'LogDeliveryConfigurationList', ], 'NetworkType' => [ 'shape' => 'NetworkType', ], 'IpDiscovery' => [ 'shape' => 'IpDiscovery', ], 'TransitEncryptionMode' => [ 'shape' => 'TransitEncryptionMode', ], ], 'wrapper' => true, ], 'CacheClusterAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheClusterAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheClusterIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 20, ], 'CacheClusterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheCluster', 'locationName' => 'CacheCluster', ], ], 'CacheClusterMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'CacheClusters' => [ 'shape' => 'CacheClusterList', ], ], ], 'CacheClusterNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheClusterNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'CacheEngineVersion' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'CacheParameterGroupFamily' => [ 'shape' => 'String', ], 'CacheEngineDescription' => [ 'shape' => 'String', ], 'CacheEngineVersionDescription' => [ 'shape' => 'String', ], ], ], 'CacheEngineVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheEngineVersion', 'locationName' => 'CacheEngineVersion', ], ], 'CacheEngineVersionMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'CacheEngineVersions' => [ 'shape' => 'CacheEngineVersionList', ], ], ], 'CacheNode' => [ 'type' => 'structure', 'members' => [ 'CacheNodeId' => [ 'shape' => 'String', ], 'CacheNodeStatus' => [ 'shape' => 'String', ], 'CacheNodeCreateTime' => [ 'shape' => 'TStamp', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], 'ParameterGroupStatus' => [ 'shape' => 'String', ], 'SourceCacheNodeId' => [ 'shape' => 'String', ], 'CustomerAvailabilityZone' => [ 'shape' => 'String', ], 'CustomerOutpostArn' => [ 'shape' => 'String', ], ], ], 'CacheNodeIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'CacheNodeId', ], ], 'CacheNodeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheNode', 'locationName' => 'CacheNode', ], ], 'CacheNodeTypeSpecificParameter' => [ 'type' => 'structure', 'members' => [ 'ParameterName' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'DataType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], 'CacheNodeTypeSpecificValues' => [ 'shape' => 'CacheNodeTypeSpecificValueList', ], 'ChangeType' => [ 'shape' => 'ChangeType', ], ], ], 'CacheNodeTypeSpecificParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheNodeTypeSpecificParameter', 'locationName' => 'CacheNodeTypeSpecificParameter', ], ], 'CacheNodeTypeSpecificValue' => [ 'type' => 'structure', 'members' => [ 'CacheNodeType' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'CacheNodeTypeSpecificValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheNodeTypeSpecificValue', 'locationName' => 'CacheNodeTypeSpecificValue', ], ], 'CacheNodeUpdateStatus' => [ 'type' => 'structure', 'members' => [ 'CacheNodeId' => [ 'shape' => 'String', ], 'NodeUpdateStatus' => [ 'shape' => 'NodeUpdateStatus', ], 'NodeDeletionDate' => [ 'shape' => 'TStamp', ], 'NodeUpdateStartDate' => [ 'shape' => 'TStamp', ], 'NodeUpdateEndDate' => [ 'shape' => 'TStamp', ], 'NodeUpdateInitiatedBy' => [ 'shape' => 'NodeUpdateInitiatedBy', ], 'NodeUpdateInitiatedDate' => [ 'shape' => 'TStamp', ], 'NodeUpdateStatusModifiedDate' => [ 'shape' => 'TStamp', ], ], ], 'CacheNodeUpdateStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheNodeUpdateStatus', 'locationName' => 'CacheNodeUpdateStatus', ], ], 'CacheParameterGroup' => [ 'type' => 'structure', 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'CacheParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'IsGlobal' => [ 'shape' => 'Boolean', ], 'ARN' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'CacheParameterGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheParameterGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheParameterGroupDetails' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], 'CacheNodeTypeSpecificParameters' => [ 'shape' => 'CacheNodeTypeSpecificParametersList', ], ], ], 'CacheParameterGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheParameterGroup', 'locationName' => 'CacheParameterGroup', ], ], 'CacheParameterGroupNameMessage' => [ 'type' => 'structure', 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], ], ], 'CacheParameterGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheParameterGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'CacheParameterGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheParameterGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheParameterGroupStatus' => [ 'type' => 'structure', 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'ParameterApplyStatus' => [ 'shape' => 'String', ], 'CacheNodeIdsToReboot' => [ 'shape' => 'CacheNodeIdsList', ], ], ], 'CacheParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'CacheParameterGroups' => [ 'shape' => 'CacheParameterGroupList', ], ], ], 'CacheSecurityGroup' => [ 'type' => 'structure', 'members' => [ 'OwnerId' => [ 'shape' => 'String', ], 'CacheSecurityGroupName' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'EC2SecurityGroups' => [ 'shape' => 'EC2SecurityGroupList', ], 'ARN' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'CacheSecurityGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheSecurityGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheSecurityGroupMembership' => [ 'type' => 'structure', 'members' => [ 'CacheSecurityGroupName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'CacheSecurityGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheSecurityGroupMembership', 'locationName' => 'CacheSecurityGroup', ], ], 'CacheSecurityGroupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'CacheSecurityGroups' => [ 'shape' => 'CacheSecurityGroups', ], ], ], 'CacheSecurityGroupNameList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'CacheSecurityGroupName', ], ], 'CacheSecurityGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheSecurityGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'CacheSecurityGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'QuotaExceeded.CacheSecurityGroup', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheSecurityGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheSecurityGroup', 'locationName' => 'CacheSecurityGroup', ], ], 'CacheSubnetGroup' => [ 'type' => 'structure', 'members' => [ 'CacheSubnetGroupName' => [ 'shape' => 'String', ], 'CacheSubnetGroupDescription' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'Subnets' => [ 'shape' => 'SubnetList', ], 'ARN' => [ 'shape' => 'String', ], 'SupportedNetworkTypes' => [ 'shape' => 'NetworkTypeList', ], ], 'wrapper' => true, ], 'CacheSubnetGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheSubnetGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheSubnetGroupInUse' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheSubnetGroupInUse', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheSubnetGroupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'CacheSubnetGroups' => [ 'shape' => 'CacheSubnetGroups', ], ], ], 'CacheSubnetGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheSubnetGroupNotFoundFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheSubnetGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheSubnetGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheSubnetGroups' => [ 'type' => 'list', 'member' => [ 'shape' => 'CacheSubnetGroup', 'locationName' => 'CacheSubnetGroup', ], ], 'CacheSubnetQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'CacheSubnetQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CacheUsageLimits' => [ 'type' => 'structure', 'members' => [ 'DataStorage' => [ 'shape' => 'DataStorage', ], 'ECPUPerSecond' => [ 'shape' => 'ECPUPerSecond', ], ], ], 'ChangeType' => [ 'type' => 'string', 'enum' => [ 'immediate', 'requires-reboot', ], ], 'CloudWatchLogsDestinationDetails' => [ 'type' => 'structure', 'members' => [ 'LogGroup' => [ 'shape' => 'String', ], ], ], 'ClusterIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ClusterId', ], ], 'ClusterMode' => [ 'type' => 'string', 'enum' => [ 'enabled', 'disabled', 'compatible', ], ], 'ClusterQuotaForCustomerExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ClusterQuotaForCustomerExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'CompleteMigrationMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'Force' => [ 'shape' => 'Boolean', ], ], ], 'CompleteMigrationResponse' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'ConfigureShard' => [ 'type' => 'structure', 'required' => [ 'NodeGroupId', 'NewReplicaCount', ], 'members' => [ 'NodeGroupId' => [ 'shape' => 'AllowedNodeGroupId', ], 'NewReplicaCount' => [ 'shape' => 'Integer', ], 'PreferredAvailabilityZones' => [ 'shape' => 'PreferredAvailabilityZoneList', ], 'PreferredOutpostArns' => [ 'shape' => 'PreferredOutpostArnList', ], ], ], 'CopyServerlessCacheSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'SourceServerlessCacheSnapshotName', 'TargetServerlessCacheSnapshotName', ], 'members' => [ 'SourceServerlessCacheSnapshotName' => [ 'shape' => 'String', ], 'TargetServerlessCacheSnapshotName' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopyServerlessCacheSnapshotResponse' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheSnapshot' => [ 'shape' => 'ServerlessCacheSnapshot', ], ], ], 'CopySnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'SourceSnapshotName', 'TargetSnapshotName', ], 'members' => [ 'SourceSnapshotName' => [ 'shape' => 'String', ], 'TargetSnapshotName' => [ 'shape' => 'String', ], 'TargetBucket' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CopySnapshotResult' => [ 'type' => 'structure', 'members' => [ 'Snapshot' => [ 'shape' => 'Snapshot', ], ], ], 'CreateCacheClusterMessage' => [ 'type' => 'structure', 'required' => [ 'CacheClusterId', ], 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'ReplicationGroupId' => [ 'shape' => 'String', ], 'AZMode' => [ 'shape' => 'AZMode', ], 'PreferredAvailabilityZone' => [ 'shape' => 'String', ], 'PreferredAvailabilityZones' => [ 'shape' => 'PreferredAvailabilityZoneList', ], 'NumCacheNodes' => [ 'shape' => 'IntegerOptional', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'CacheSubnetGroupName' => [ 'shape' => 'String', ], 'CacheSecurityGroupNames' => [ 'shape' => 'CacheSecurityGroupNameList', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdsList', ], 'Tags' => [ 'shape' => 'TagList', ], 'SnapshotArns' => [ 'shape' => 'SnapshotArnsList', ], 'SnapshotName' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'NotificationTopicArn' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'SnapshotWindow' => [ 'shape' => 'String', ], 'AuthToken' => [ 'shape' => 'String', ], 'OutpostMode' => [ 'shape' => 'OutpostMode', ], 'PreferredOutpostArn' => [ 'shape' => 'String', ], 'PreferredOutpostArns' => [ 'shape' => 'PreferredOutpostArnList', ], 'LogDeliveryConfigurations' => [ 'shape' => 'LogDeliveryConfigurationRequestList', ], 'TransitEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'NetworkType' => [ 'shape' => 'NetworkType', ], 'IpDiscovery' => [ 'shape' => 'IpDiscovery', ], ], ], 'CreateCacheClusterResult' => [ 'type' => 'structure', 'members' => [ 'CacheCluster' => [ 'shape' => 'CacheCluster', ], ], ], 'CreateCacheParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheParameterGroupName', 'CacheParameterGroupFamily', 'Description', ], 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'CacheParameterGroupFamily' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCacheParameterGroupResult' => [ 'type' => 'structure', 'members' => [ 'CacheParameterGroup' => [ 'shape' => 'CacheParameterGroup', ], ], ], 'CreateCacheSecurityGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheSecurityGroupName', 'Description', ], 'members' => [ 'CacheSecurityGroupName' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCacheSecurityGroupResult' => [ 'type' => 'structure', 'members' => [ 'CacheSecurityGroup' => [ 'shape' => 'CacheSecurityGroup', ], ], ], 'CreateCacheSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheSubnetGroupName', 'CacheSubnetGroupDescription', 'SubnetIds', ], 'members' => [ 'CacheSubnetGroupName' => [ 'shape' => 'String', ], 'CacheSubnetGroupDescription' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdentifierList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateCacheSubnetGroupResult' => [ 'type' => 'structure', 'members' => [ 'CacheSubnetGroup' => [ 'shape' => 'CacheSubnetGroup', ], ], ], 'CreateGlobalReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalReplicationGroupIdSuffix', 'PrimaryReplicationGroupId', ], 'members' => [ 'GlobalReplicationGroupIdSuffix' => [ 'shape' => 'String', ], 'GlobalReplicationGroupDescription' => [ 'shape' => 'String', ], 'PrimaryReplicationGroupId' => [ 'shape' => 'String', ], ], ], 'CreateGlobalReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroup' => [ 'shape' => 'GlobalReplicationGroup', ], ], ], 'CreateReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', 'ReplicationGroupDescription', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'ReplicationGroupDescription' => [ 'shape' => 'String', ], 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'PrimaryClusterId' => [ 'shape' => 'String', ], 'AutomaticFailoverEnabled' => [ 'shape' => 'BooleanOptional', ], 'MultiAZEnabled' => [ 'shape' => 'BooleanOptional', ], 'NumCacheClusters' => [ 'shape' => 'IntegerOptional', ], 'PreferredCacheClusterAZs' => [ 'shape' => 'AvailabilityZonesList', ], 'NumNodeGroups' => [ 'shape' => 'IntegerOptional', ], 'ReplicasPerNodeGroup' => [ 'shape' => 'IntegerOptional', ], 'NodeGroupConfiguration' => [ 'shape' => 'NodeGroupConfigurationList', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'CacheSubnetGroupName' => [ 'shape' => 'String', ], 'CacheSecurityGroupNames' => [ 'shape' => 'CacheSecurityGroupNameList', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdsList', ], 'Tags' => [ 'shape' => 'TagList', ], 'SnapshotArns' => [ 'shape' => 'SnapshotArnsList', ], 'SnapshotName' => [ 'shape' => 'String', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'NotificationTopicArn' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'SnapshotWindow' => [ 'shape' => 'String', ], 'AuthToken' => [ 'shape' => 'String', ], 'TransitEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'AtRestEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'UserGroupIds' => [ 'shape' => 'UserGroupIdListInput', ], 'LogDeliveryConfigurations' => [ 'shape' => 'LogDeliveryConfigurationRequestList', ], 'DataTieringEnabled' => [ 'shape' => 'BooleanOptional', ], 'NetworkType' => [ 'shape' => 'NetworkType', ], 'IpDiscovery' => [ 'shape' => 'IpDiscovery', ], 'TransitEncryptionMode' => [ 'shape' => 'TransitEncryptionMode', ], 'ClusterMode' => [ 'shape' => 'ClusterMode', ], 'ServerlessCacheSnapshotName' => [ 'shape' => 'String', ], ], ], 'CreateReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'CreateServerlessCacheRequest' => [ 'type' => 'structure', 'required' => [ 'ServerlessCacheName', 'Engine', ], 'members' => [ 'ServerlessCacheName' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'CacheUsageLimits' => [ 'shape' => 'CacheUsageLimits', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdsList', ], 'SnapshotArnsToRestore' => [ 'shape' => 'SnapshotArnsList', ], 'Tags' => [ 'shape' => 'TagList', ], 'UserGroupId' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdsList', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'DailySnapshotTime' => [ 'shape' => 'String', ], ], ], 'CreateServerlessCacheResponse' => [ 'type' => 'structure', 'members' => [ 'ServerlessCache' => [ 'shape' => 'ServerlessCache', ], ], ], 'CreateServerlessCacheSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'ServerlessCacheSnapshotName', 'ServerlessCacheName', ], 'members' => [ 'ServerlessCacheSnapshotName' => [ 'shape' => 'String', ], 'ServerlessCacheName' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateServerlessCacheSnapshotResponse' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheSnapshot' => [ 'shape' => 'ServerlessCacheSnapshot', ], ], ], 'CreateSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'SnapshotName', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'CacheClusterId' => [ 'shape' => 'String', ], 'SnapshotName' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'Snapshot' => [ 'shape' => 'Snapshot', ], ], ], 'CreateUserGroupMessage' => [ 'type' => 'structure', 'required' => [ 'UserGroupId', 'Engine', ], 'members' => [ 'UserGroupId' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'EngineType', ], 'UserIds' => [ 'shape' => 'UserIdListInput', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateUserMessage' => [ 'type' => 'structure', 'required' => [ 'UserId', 'UserName', 'Engine', 'AccessString', ], 'members' => [ 'UserId' => [ 'shape' => 'UserId', ], 'UserName' => [ 'shape' => 'UserName', ], 'Engine' => [ 'shape' => 'EngineType', ], 'Passwords' => [ 'shape' => 'PasswordListInput', ], 'AccessString' => [ 'shape' => 'AccessString', ], 'NoPasswordRequired' => [ 'shape' => 'BooleanOptional', ], 'Tags' => [ 'shape' => 'TagList', ], 'AuthenticationMode' => [ 'shape' => 'AuthenticationMode', ], ], ], 'CustomerNodeEndpoint' => [ 'type' => 'structure', 'members' => [ 'Address' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], ], ], 'CustomerNodeEndpointList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomerNodeEndpoint', ], ], 'DataStorage' => [ 'type' => 'structure', 'required' => [ 'Unit', ], 'members' => [ 'Maximum' => [ 'shape' => 'IntegerOptional', ], 'Minimum' => [ 'shape' => 'IntegerOptional', ], 'Unit' => [ 'shape' => 'DataStorageUnit', ], ], ], 'DataStorageUnit' => [ 'type' => 'string', 'enum' => [ 'GB', ], ], 'DataTieringStatus' => [ 'type' => 'string', 'enum' => [ 'enabled', 'disabled', ], ], 'DecreaseNodeGroupsInGlobalReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalReplicationGroupId', 'NodeGroupCount', 'ApplyImmediately', ], 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'NodeGroupCount' => [ 'shape' => 'Integer', ], 'GlobalNodeGroupsToRemove' => [ 'shape' => 'GlobalNodeGroupIdList', ], 'GlobalNodeGroupsToRetain' => [ 'shape' => 'GlobalNodeGroupIdList', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], ], ], 'DecreaseNodeGroupsInGlobalReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroup' => [ 'shape' => 'GlobalReplicationGroup', ], ], ], 'DecreaseReplicaCountMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', 'ApplyImmediately', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'NewReplicaCount' => [ 'shape' => 'IntegerOptional', ], 'ReplicaConfiguration' => [ 'shape' => 'ReplicaConfigurationList', ], 'ReplicasToRemove' => [ 'shape' => 'RemoveReplicasList', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], ], ], 'DecreaseReplicaCountResult' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'DefaultUserAssociatedToUserGroupFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DefaultUserAssociatedToUserGroup', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DefaultUserRequired' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DefaultUserRequired', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'DeleteCacheClusterMessage' => [ 'type' => 'structure', 'required' => [ 'CacheClusterId', ], 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'FinalSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteCacheClusterResult' => [ 'type' => 'structure', 'members' => [ 'CacheCluster' => [ 'shape' => 'CacheCluster', ], ], ], 'DeleteCacheParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheParameterGroupName', ], 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteCacheSecurityGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheSecurityGroupName', ], 'members' => [ 'CacheSecurityGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteCacheSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheSubnetGroupName', ], 'members' => [ 'CacheSubnetGroupName' => [ 'shape' => 'String', ], ], ], 'DeleteGlobalReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalReplicationGroupId', 'RetainPrimaryReplicationGroup', ], 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'RetainPrimaryReplicationGroup' => [ 'shape' => 'Boolean', ], ], ], 'DeleteGlobalReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroup' => [ 'shape' => 'GlobalReplicationGroup', ], ], ], 'DeleteReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'RetainPrimaryCluster' => [ 'shape' => 'BooleanOptional', ], 'FinalSnapshotIdentifier' => [ 'shape' => 'String', ], ], ], 'DeleteReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'DeleteServerlessCacheRequest' => [ 'type' => 'structure', 'required' => [ 'ServerlessCacheName', ], 'members' => [ 'ServerlessCacheName' => [ 'shape' => 'String', ], 'FinalSnapshotName' => [ 'shape' => 'String', ], ], ], 'DeleteServerlessCacheResponse' => [ 'type' => 'structure', 'members' => [ 'ServerlessCache' => [ 'shape' => 'ServerlessCache', ], ], ], 'DeleteServerlessCacheSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'ServerlessCacheSnapshotName', ], 'members' => [ 'ServerlessCacheSnapshotName' => [ 'shape' => 'String', ], ], ], 'DeleteServerlessCacheSnapshotResponse' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheSnapshot' => [ 'shape' => 'ServerlessCacheSnapshot', ], ], ], 'DeleteSnapshotMessage' => [ 'type' => 'structure', 'required' => [ 'SnapshotName', ], 'members' => [ 'SnapshotName' => [ 'shape' => 'String', ], ], ], 'DeleteSnapshotResult' => [ 'type' => 'structure', 'members' => [ 'Snapshot' => [ 'shape' => 'Snapshot', ], ], ], 'DeleteUserGroupMessage' => [ 'type' => 'structure', 'required' => [ 'UserGroupId', ], 'members' => [ 'UserGroupId' => [ 'shape' => 'String', ], ], ], 'DeleteUserMessage' => [ 'type' => 'structure', 'required' => [ 'UserId', ], 'members' => [ 'UserId' => [ 'shape' => 'UserId', ], ], ], 'DescribeCacheClustersMessage' => [ 'type' => 'structure', 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'ShowCacheNodeInfo' => [ 'shape' => 'BooleanOptional', ], 'ShowCacheClustersNotInReplicationGroups' => [ 'shape' => 'BooleanOptional', ], ], ], 'DescribeCacheEngineVersionsMessage' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'CacheParameterGroupFamily' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'DefaultOnly' => [ 'shape' => 'Boolean', ], ], ], 'DescribeCacheParameterGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeCacheParametersMessage' => [ 'type' => 'structure', 'required' => [ 'CacheParameterGroupName', ], 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeCacheSecurityGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'CacheSecurityGroupName' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeCacheSubnetGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'CacheSubnetGroupName' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultParametersMessage' => [ 'type' => 'structure', 'required' => [ 'CacheParameterGroupFamily', ], 'members' => [ 'CacheParameterGroupFamily' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeEngineDefaultParametersResult' => [ 'type' => 'structure', 'members' => [ 'EngineDefaults' => [ 'shape' => 'EngineDefaults', ], ], ], 'DescribeEventsMessage' => [ 'type' => 'structure', 'members' => [ 'SourceIdentifier' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'StartTime' => [ 'shape' => 'TStamp', ], 'EndTime' => [ 'shape' => 'TStamp', ], 'Duration' => [ 'shape' => 'IntegerOptional', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeGlobalReplicationGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], 'ShowMemberInfo' => [ 'shape' => 'BooleanOptional', ], ], ], 'DescribeGlobalReplicationGroupsResult' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'GlobalReplicationGroups' => [ 'shape' => 'GlobalReplicationGroupList', ], ], ], 'DescribeReplicationGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeReservedCacheNodesMessage' => [ 'type' => 'structure', 'members' => [ 'ReservedCacheNodeId' => [ 'shape' => 'String', ], 'ReservedCacheNodesOfferingId' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'String', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeReservedCacheNodesOfferingsMessage' => [ 'type' => 'structure', 'members' => [ 'ReservedCacheNodesOfferingId' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'String', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeServerlessCacheSnapshotsRequest' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheName' => [ 'shape' => 'String', ], 'ServerlessCacheSnapshotName' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'NextToken' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'IntegerOptional', ], ], ], 'DescribeServerlessCacheSnapshotsResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', ], 'ServerlessCacheSnapshots' => [ 'shape' => 'ServerlessCacheSnapshotList', ], ], ], 'DescribeServerlessCachesRequest' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheName' => [ 'shape' => 'String', ], 'MaxResults' => [ 'shape' => 'IntegerOptional', ], 'NextToken' => [ 'shape' => 'String', ], ], ], 'DescribeServerlessCachesResponse' => [ 'type' => 'structure', 'members' => [ 'NextToken' => [ 'shape' => 'String', ], 'ServerlessCaches' => [ 'shape' => 'ServerlessCacheList', ], ], ], 'DescribeServiceUpdatesMessage' => [ 'type' => 'structure', 'members' => [ 'ServiceUpdateName' => [ 'shape' => 'String', ], 'ServiceUpdateStatus' => [ 'shape' => 'ServiceUpdateStatusList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeSnapshotsListMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'Snapshots' => [ 'shape' => 'SnapshotList', ], ], ], 'DescribeSnapshotsMessage' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'CacheClusterId' => [ 'shape' => 'String', ], 'SnapshotName' => [ 'shape' => 'String', ], 'SnapshotSource' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'ShowNodeGroupConfig' => [ 'shape' => 'BooleanOptional', ], ], ], 'DescribeUpdateActionsMessage' => [ 'type' => 'structure', 'members' => [ 'ServiceUpdateName' => [ 'shape' => 'String', ], 'ReplicationGroupIds' => [ 'shape' => 'ReplicationGroupIdList', ], 'CacheClusterIds' => [ 'shape' => 'CacheClusterIdList', ], 'Engine' => [ 'shape' => 'String', ], 'ServiceUpdateStatus' => [ 'shape' => 'ServiceUpdateStatusList', ], 'ServiceUpdateTimeRange' => [ 'shape' => 'TimeRangeFilter', ], 'UpdateActionStatus' => [ 'shape' => 'UpdateActionStatusList', ], 'ShowNodeLevelUpdateStatus' => [ 'shape' => 'BooleanOptional', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeUserGroupsMessage' => [ 'type' => 'structure', 'members' => [ 'UserGroupId' => [ 'shape' => 'String', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeUserGroupsResult' => [ 'type' => 'structure', 'members' => [ 'UserGroups' => [ 'shape' => 'UserGroupList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeUsersMessage' => [ 'type' => 'structure', 'members' => [ 'Engine' => [ 'shape' => 'EngineType', ], 'UserId' => [ 'shape' => 'UserId', ], 'Filters' => [ 'shape' => 'FilterList', ], 'MaxRecords' => [ 'shape' => 'IntegerOptional', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DescribeUsersResult' => [ 'type' => 'structure', 'members' => [ 'Users' => [ 'shape' => 'UserList', ], 'Marker' => [ 'shape' => 'String', ], ], ], 'DestinationDetails' => [ 'type' => 'structure', 'members' => [ 'CloudWatchLogsDetails' => [ 'shape' => 'CloudWatchLogsDestinationDetails', ], 'KinesisFirehoseDetails' => [ 'shape' => 'KinesisFirehoseDestinationDetails', ], ], ], 'DestinationType' => [ 'type' => 'string', 'enum' => [ 'cloudwatch-logs', 'kinesis-firehose', ], ], 'DisassociateGlobalReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalReplicationGroupId', 'ReplicationGroupId', 'ReplicationGroupRegion', ], 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'ReplicationGroupId' => [ 'shape' => 'String', ], 'ReplicationGroupRegion' => [ 'shape' => 'String', ], ], ], 'DisassociateGlobalReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroup' => [ 'shape' => 'GlobalReplicationGroup', ], ], ], 'Double' => [ 'type' => 'double', ], 'DuplicateUserNameFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'DuplicateUserName', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'EC2SecurityGroup' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'EC2SecurityGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EC2SecurityGroup', 'locationName' => 'EC2SecurityGroup', ], ], 'ECPUPerSecond' => [ 'type' => 'structure', 'members' => [ 'Maximum' => [ 'shape' => 'IntegerOptional', ], 'Minimum' => [ 'shape' => 'IntegerOptional', ], ], ], 'Endpoint' => [ 'type' => 'structure', 'members' => [ 'Address' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'Integer', ], ], ], 'EngineDefaults' => [ 'type' => 'structure', 'members' => [ 'CacheParameterGroupFamily' => [ 'shape' => 'String', ], 'Marker' => [ 'shape' => 'String', ], 'Parameters' => [ 'shape' => 'ParametersList', ], 'CacheNodeTypeSpecificParameters' => [ 'shape' => 'CacheNodeTypeSpecificParametersList', ], ], 'wrapper' => true, ], 'EngineType' => [ 'type' => 'string', 'pattern' => '[a-zA-Z]*', ], 'Event' => [ 'type' => 'structure', 'members' => [ 'SourceIdentifier' => [ 'shape' => 'String', ], 'SourceType' => [ 'shape' => 'SourceType', ], 'Message' => [ 'shape' => 'String', ], 'Date' => [ 'shape' => 'TStamp', ], ], ], 'EventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Event', 'locationName' => 'Event', ], ], 'EventsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'Events' => [ 'shape' => 'EventList', ], ], ], 'ExportServerlessCacheSnapshotRequest' => [ 'type' => 'structure', 'required' => [ 'ServerlessCacheSnapshotName', 'S3BucketName', ], 'members' => [ 'ServerlessCacheSnapshotName' => [ 'shape' => 'String', ], 'S3BucketName' => [ 'shape' => 'String', ], ], ], 'ExportServerlessCacheSnapshotResponse' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheSnapshot' => [ 'shape' => 'ServerlessCacheSnapshot', ], ], ], 'FailoverGlobalReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalReplicationGroupId', 'PrimaryRegion', 'PrimaryReplicationGroupId', ], 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'PrimaryRegion' => [ 'shape' => 'String', ], 'PrimaryReplicationGroupId' => [ 'shape' => 'String', ], ], ], 'FailoverGlobalReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroup' => [ 'shape' => 'GlobalReplicationGroup', ], ], ], 'Filter' => [ 'type' => 'structure', 'required' => [ 'Name', 'Values', ], 'members' => [ 'Name' => [ 'shape' => 'FilterName', ], 'Values' => [ 'shape' => 'FilterValueList', ], ], ], 'FilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Filter', ], ], 'FilterName' => [ 'type' => 'string', 'pattern' => '.*\\S.*', ], 'FilterValue' => [ 'type' => 'string', 'pattern' => '.*\\S.*', ], 'FilterValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterValue', ], 'min' => 1, ], 'GlobalNodeGroup' => [ 'type' => 'structure', 'members' => [ 'GlobalNodeGroupId' => [ 'shape' => 'String', ], 'Slots' => [ 'shape' => 'String', ], ], ], 'GlobalNodeGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'GlobalNodeGroupId', ], ], 'GlobalNodeGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalNodeGroup', 'locationName' => 'GlobalNodeGroup', ], ], 'GlobalReplicationGroup' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'GlobalReplicationGroupDescription' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'Members' => [ 'shape' => 'GlobalReplicationGroupMemberList', ], 'ClusterEnabled' => [ 'shape' => 'BooleanOptional', ], 'GlobalNodeGroups' => [ 'shape' => 'GlobalNodeGroupList', ], 'AuthTokenEnabled' => [ 'shape' => 'BooleanOptional', ], 'TransitEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'AtRestEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'ARN' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'GlobalReplicationGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalReplicationGroupAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'GlobalReplicationGroupInfo' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'GlobalReplicationGroupMemberRole' => [ 'shape' => 'String', ], ], ], 'GlobalReplicationGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalReplicationGroup', 'locationName' => 'GlobalReplicationGroup', ], ], 'GlobalReplicationGroupMember' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'ReplicationGroupRegion' => [ 'shape' => 'String', ], 'Role' => [ 'shape' => 'String', ], 'AutomaticFailover' => [ 'shape' => 'AutomaticFailoverStatus', ], 'Status' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'GlobalReplicationGroupMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalReplicationGroupMember', 'locationName' => 'GlobalReplicationGroupMember', ], ], 'GlobalReplicationGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'GlobalReplicationGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'IncreaseNodeGroupsInGlobalReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalReplicationGroupId', 'NodeGroupCount', 'ApplyImmediately', ], 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'NodeGroupCount' => [ 'shape' => 'Integer', ], 'RegionalConfigurations' => [ 'shape' => 'RegionalConfigurationList', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], ], ], 'IncreaseNodeGroupsInGlobalReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroup' => [ 'shape' => 'GlobalReplicationGroup', ], ], ], 'IncreaseReplicaCountMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', 'ApplyImmediately', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'NewReplicaCount' => [ 'shape' => 'IntegerOptional', ], 'ReplicaConfiguration' => [ 'shape' => 'ReplicaConfigurationList', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], ], ], 'IncreaseReplicaCountResult' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'InputAuthenticationType' => [ 'type' => 'string', 'enum' => [ 'password', 'no-password-required', 'iam', ], ], 'InsufficientCacheClusterCapacityFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InsufficientCacheClusterCapacity', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'Integer' => [ 'type' => 'integer', ], 'IntegerOptional' => [ 'type' => 'integer', ], 'InvalidARNFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidARN', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidCacheClusterStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidCacheClusterState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidCacheParameterGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidCacheParameterGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidCacheSecurityGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidCacheSecurityGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidCredentialsException' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidCredentialsException', 'httpStatusCode' => 408, 'senderFault' => true, ], 'exception' => true, ], 'InvalidGlobalReplicationGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidGlobalReplicationGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidKMSKeyFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidKMSKeyFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidParameterCombinationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'AwsQueryErrorMessage', ], ], 'error' => [ 'code' => 'InvalidParameterCombination', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, 'synthetic' => true, ], 'InvalidParameterValueException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'AwsQueryErrorMessage', ], ], 'error' => [ 'code' => 'InvalidParameterValue', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, 'synthetic' => true, ], 'InvalidReplicationGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidReplicationGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidServerlessCacheSnapshotStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidServerlessCacheSnapshotStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidServerlessCacheStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidServerlessCacheStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidSnapshotStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidSnapshotState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidSubnet' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidSubnet', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidUserGroupStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidUserGroupState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidUserStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidUserState', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'InvalidVPCNetworkStateFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'InvalidVPCNetworkStateFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'IpDiscovery' => [ 'type' => 'string', 'enum' => [ 'ipv4', 'ipv6', ], ], 'KeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'KinesisFirehoseDestinationDetails' => [ 'type' => 'structure', 'members' => [ 'DeliveryStream' => [ 'shape' => 'String', ], ], ], 'ListAllowedNodeTypeModificationsMessage' => [ 'type' => 'structure', 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'ReplicationGroupId' => [ 'shape' => 'String', ], ], ], 'ListTagsForResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], ], ], 'LogDeliveryConfiguration' => [ 'type' => 'structure', 'members' => [ 'LogType' => [ 'shape' => 'LogType', ], 'DestinationType' => [ 'shape' => 'DestinationType', ], 'DestinationDetails' => [ 'shape' => 'DestinationDetails', ], 'LogFormat' => [ 'shape' => 'LogFormat', ], 'Status' => [ 'shape' => 'LogDeliveryConfigurationStatus', ], 'Message' => [ 'shape' => 'String', ], ], ], 'LogDeliveryConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LogDeliveryConfiguration', 'locationName' => 'LogDeliveryConfiguration', ], ], 'LogDeliveryConfigurationRequest' => [ 'type' => 'structure', 'members' => [ 'LogType' => [ 'shape' => 'LogType', ], 'DestinationType' => [ 'shape' => 'DestinationType', ], 'DestinationDetails' => [ 'shape' => 'DestinationDetails', ], 'LogFormat' => [ 'shape' => 'LogFormat', ], 'Enabled' => [ 'shape' => 'BooleanOptional', ], ], ], 'LogDeliveryConfigurationRequestList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LogDeliveryConfigurationRequest', 'locationName' => 'LogDeliveryConfigurationRequest', ], ], 'LogDeliveryConfigurationStatus' => [ 'type' => 'string', 'enum' => [ 'active', 'enabling', 'modifying', 'disabling', 'error', ], ], 'LogFormat' => [ 'type' => 'string', 'enum' => [ 'text', 'json', ], ], 'LogType' => [ 'type' => 'string', 'enum' => [ 'slow-log', 'engine-log', ], ], 'ModifyCacheClusterMessage' => [ 'type' => 'structure', 'required' => [ 'CacheClusterId', ], 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'NumCacheNodes' => [ 'shape' => 'IntegerOptional', ], 'CacheNodeIdsToRemove' => [ 'shape' => 'CacheNodeIdsList', ], 'AZMode' => [ 'shape' => 'AZMode', ], 'NewAvailabilityZones' => [ 'shape' => 'PreferredAvailabilityZoneList', ], 'CacheSecurityGroupNames' => [ 'shape' => 'CacheSecurityGroupNameList', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdsList', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'NotificationTopicArn' => [ 'shape' => 'String', ], 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'NotificationTopicStatus' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'SnapshotWindow' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'AuthToken' => [ 'shape' => 'String', ], 'AuthTokenUpdateStrategy' => [ 'shape' => 'AuthTokenUpdateStrategyType', ], 'LogDeliveryConfigurations' => [ 'shape' => 'LogDeliveryConfigurationRequestList', ], 'IpDiscovery' => [ 'shape' => 'IpDiscovery', ], ], ], 'ModifyCacheClusterResult' => [ 'type' => 'structure', 'members' => [ 'CacheCluster' => [ 'shape' => 'CacheCluster', ], ], ], 'ModifyCacheParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheParameterGroupName', 'ParameterNameValues', ], 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'ParameterNameValues' => [ 'shape' => 'ParameterNameValueList', ], ], ], 'ModifyCacheSubnetGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheSubnetGroupName', ], 'members' => [ 'CacheSubnetGroupName' => [ 'shape' => 'String', ], 'CacheSubnetGroupDescription' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdentifierList', ], ], ], 'ModifyCacheSubnetGroupResult' => [ 'type' => 'structure', 'members' => [ 'CacheSubnetGroup' => [ 'shape' => 'CacheSubnetGroup', ], ], ], 'ModifyGlobalReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalReplicationGroupId', 'ApplyImmediately', ], 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'GlobalReplicationGroupDescription' => [ 'shape' => 'String', ], 'AutomaticFailoverEnabled' => [ 'shape' => 'BooleanOptional', ], ], ], 'ModifyGlobalReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroup' => [ 'shape' => 'GlobalReplicationGroup', ], ], ], 'ModifyReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'ReplicationGroupDescription' => [ 'shape' => 'String', ], 'PrimaryClusterId' => [ 'shape' => 'String', ], 'SnapshottingClusterId' => [ 'shape' => 'String', ], 'AutomaticFailoverEnabled' => [ 'shape' => 'BooleanOptional', ], 'MultiAZEnabled' => [ 'shape' => 'BooleanOptional', ], 'NodeGroupId' => [ 'shape' => 'String', 'deprecated' => true, ], 'CacheSecurityGroupNames' => [ 'shape' => 'CacheSecurityGroupNameList', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdsList', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'NotificationTopicArn' => [ 'shape' => 'String', ], 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'NotificationTopicStatus' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'BooleanOptional', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'SnapshotWindow' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'AuthToken' => [ 'shape' => 'String', ], 'AuthTokenUpdateStrategy' => [ 'shape' => 'AuthTokenUpdateStrategyType', ], 'UserGroupIdsToAdd' => [ 'shape' => 'UserGroupIdList', ], 'UserGroupIdsToRemove' => [ 'shape' => 'UserGroupIdList', ], 'RemoveUserGroups' => [ 'shape' => 'BooleanOptional', ], 'LogDeliveryConfigurations' => [ 'shape' => 'LogDeliveryConfigurationRequestList', ], 'IpDiscovery' => [ 'shape' => 'IpDiscovery', ], 'TransitEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'TransitEncryptionMode' => [ 'shape' => 'TransitEncryptionMode', ], 'ClusterMode' => [ 'shape' => 'ClusterMode', ], ], ], 'ModifyReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'ModifyReplicationGroupShardConfigurationMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', 'NodeGroupCount', 'ApplyImmediately', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'NodeGroupCount' => [ 'shape' => 'Integer', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], 'ReshardingConfiguration' => [ 'shape' => 'ReshardingConfigurationList', ], 'NodeGroupsToRemove' => [ 'shape' => 'NodeGroupsToRemoveList', ], 'NodeGroupsToRetain' => [ 'shape' => 'NodeGroupsToRetainList', ], ], ], 'ModifyReplicationGroupShardConfigurationResult' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'ModifyServerlessCacheRequest' => [ 'type' => 'structure', 'required' => [ 'ServerlessCacheName', ], 'members' => [ 'ServerlessCacheName' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'CacheUsageLimits' => [ 'shape' => 'CacheUsageLimits', ], 'RemoveUserGroup' => [ 'shape' => 'BooleanOptional', ], 'UserGroupId' => [ 'shape' => 'String', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdsList', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'DailySnapshotTime' => [ 'shape' => 'String', ], ], ], 'ModifyServerlessCacheResponse' => [ 'type' => 'structure', 'members' => [ 'ServerlessCache' => [ 'shape' => 'ServerlessCache', ], ], ], 'ModifyUserGroupMessage' => [ 'type' => 'structure', 'required' => [ 'UserGroupId', ], 'members' => [ 'UserGroupId' => [ 'shape' => 'String', ], 'UserIdsToAdd' => [ 'shape' => 'UserIdListInput', ], 'UserIdsToRemove' => [ 'shape' => 'UserIdListInput', ], ], ], 'ModifyUserMessage' => [ 'type' => 'structure', 'required' => [ 'UserId', ], 'members' => [ 'UserId' => [ 'shape' => 'UserId', ], 'AccessString' => [ 'shape' => 'AccessString', ], 'AppendAccessString' => [ 'shape' => 'AccessString', ], 'Passwords' => [ 'shape' => 'PasswordListInput', ], 'NoPasswordRequired' => [ 'shape' => 'BooleanOptional', ], 'AuthenticationMode' => [ 'shape' => 'AuthenticationMode', ], ], ], 'MultiAZStatus' => [ 'type' => 'string', 'enum' => [ 'enabled', 'disabled', ], ], 'NetworkType' => [ 'type' => 'string', 'enum' => [ 'ipv4', 'ipv6', 'dual_stack', ], ], 'NetworkTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkType', ], ], 'NoOperationFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'NoOperationFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'NodeGroup' => [ 'type' => 'structure', 'members' => [ 'NodeGroupId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'PrimaryEndpoint' => [ 'shape' => 'Endpoint', ], 'ReaderEndpoint' => [ 'shape' => 'Endpoint', ], 'Slots' => [ 'shape' => 'String', ], 'NodeGroupMembers' => [ 'shape' => 'NodeGroupMemberList', ], ], ], 'NodeGroupConfiguration' => [ 'type' => 'structure', 'members' => [ 'NodeGroupId' => [ 'shape' => 'AllowedNodeGroupId', ], 'Slots' => [ 'shape' => 'String', ], 'ReplicaCount' => [ 'shape' => 'IntegerOptional', ], 'PrimaryAvailabilityZone' => [ 'shape' => 'String', ], 'ReplicaAvailabilityZones' => [ 'shape' => 'AvailabilityZonesList', ], 'PrimaryOutpostArn' => [ 'shape' => 'String', ], 'ReplicaOutpostArns' => [ 'shape' => 'OutpostArnsList', ], ], ], 'NodeGroupConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NodeGroupConfiguration', 'locationName' => 'NodeGroupConfiguration', ], ], 'NodeGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NodeGroup', 'locationName' => 'NodeGroup', ], ], 'NodeGroupMember' => [ 'type' => 'structure', 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'CacheNodeId' => [ 'shape' => 'String', ], 'ReadEndpoint' => [ 'shape' => 'Endpoint', ], 'PreferredAvailabilityZone' => [ 'shape' => 'String', ], 'PreferredOutpostArn' => [ 'shape' => 'String', ], 'CurrentRole' => [ 'shape' => 'String', ], ], ], 'NodeGroupMemberList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NodeGroupMember', 'locationName' => 'NodeGroupMember', ], ], 'NodeGroupMemberUpdateStatus' => [ 'type' => 'structure', 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'CacheNodeId' => [ 'shape' => 'String', ], 'NodeUpdateStatus' => [ 'shape' => 'NodeUpdateStatus', ], 'NodeDeletionDate' => [ 'shape' => 'TStamp', ], 'NodeUpdateStartDate' => [ 'shape' => 'TStamp', ], 'NodeUpdateEndDate' => [ 'shape' => 'TStamp', ], 'NodeUpdateInitiatedBy' => [ 'shape' => 'NodeUpdateInitiatedBy', ], 'NodeUpdateInitiatedDate' => [ 'shape' => 'TStamp', ], 'NodeUpdateStatusModifiedDate' => [ 'shape' => 'TStamp', ], ], ], 'NodeGroupMemberUpdateStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NodeGroupMemberUpdateStatus', 'locationName' => 'NodeGroupMemberUpdateStatus', ], ], 'NodeGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'NodeGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'NodeGroupUpdateStatus' => [ 'type' => 'structure', 'members' => [ 'NodeGroupId' => [ 'shape' => 'String', ], 'NodeGroupMemberUpdateStatus' => [ 'shape' => 'NodeGroupMemberUpdateStatusList', ], ], ], 'NodeGroupUpdateStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NodeGroupUpdateStatus', 'locationName' => 'NodeGroupUpdateStatus', ], ], 'NodeGroupsPerReplicationGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'NodeGroupsPerReplicationGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'NodeGroupsToRemoveList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AllowedNodeGroupId', 'locationName' => 'NodeGroupToRemove', ], ], 'NodeGroupsToRetainList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AllowedNodeGroupId', 'locationName' => 'NodeGroupToRetain', ], ], 'NodeQuotaForClusterExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'NodeQuotaForClusterExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'NodeQuotaForCustomerExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'NodeQuotaForCustomerExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'NodeSnapshot' => [ 'type' => 'structure', 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'NodeGroupId' => [ 'shape' => 'String', ], 'CacheNodeId' => [ 'shape' => 'String', ], 'NodeGroupConfiguration' => [ 'shape' => 'NodeGroupConfiguration', ], 'CacheSize' => [ 'shape' => 'String', ], 'CacheNodeCreateTime' => [ 'shape' => 'TStamp', ], 'SnapshotCreateTime' => [ 'shape' => 'TStamp', ], ], 'wrapper' => true, ], 'NodeSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NodeSnapshot', 'locationName' => 'NodeSnapshot', ], ], 'NodeTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'NodeUpdateInitiatedBy' => [ 'type' => 'string', 'enum' => [ 'system', 'customer', ], ], 'NodeUpdateStatus' => [ 'type' => 'string', 'enum' => [ 'not-applied', 'waiting-to-start', 'in-progress', 'stopping', 'stopped', 'complete', ], ], 'NotificationConfiguration' => [ 'type' => 'structure', 'members' => [ 'TopicArn' => [ 'shape' => 'String', ], 'TopicStatus' => [ 'shape' => 'String', ], ], ], 'OutpostArnsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'OutpostArn', ], ], 'OutpostMode' => [ 'type' => 'string', 'enum' => [ 'single-outpost', 'cross-outpost', ], ], 'Parameter' => [ 'type' => 'structure', 'members' => [ 'ParameterName' => [ 'shape' => 'String', ], 'ParameterValue' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'Source' => [ 'shape' => 'String', ], 'DataType' => [ 'shape' => 'String', ], 'AllowedValues' => [ 'shape' => 'String', ], 'IsModifiable' => [ 'shape' => 'Boolean', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], 'ChangeType' => [ 'shape' => 'ChangeType', ], ], ], 'ParameterNameValue' => [ 'type' => 'structure', 'members' => [ 'ParameterName' => [ 'shape' => 'String', ], 'ParameterValue' => [ 'shape' => 'String', ], ], ], 'ParameterNameValueList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ParameterNameValue', 'locationName' => 'ParameterNameValue', ], ], 'ParametersList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Parameter', 'locationName' => 'Parameter', ], ], 'PasswordListInput' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'min' => 1, ], 'PendingAutomaticFailoverStatus' => [ 'type' => 'string', 'enum' => [ 'enabled', 'disabled', ], ], 'PendingLogDeliveryConfiguration' => [ 'type' => 'structure', 'members' => [ 'LogType' => [ 'shape' => 'LogType', ], 'DestinationType' => [ 'shape' => 'DestinationType', ], 'DestinationDetails' => [ 'shape' => 'DestinationDetails', ], 'LogFormat' => [ 'shape' => 'LogFormat', ], ], ], 'PendingLogDeliveryConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PendingLogDeliveryConfiguration', ], 'locationName' => 'PendingLogDeliveryConfiguration', ], 'PendingModifiedValues' => [ 'type' => 'structure', 'members' => [ 'NumCacheNodes' => [ 'shape' => 'IntegerOptional', ], 'CacheNodeIdsToRemove' => [ 'shape' => 'CacheNodeIdsList', ], 'EngineVersion' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'AuthTokenStatus' => [ 'shape' => 'AuthTokenUpdateStatus', ], 'LogDeliveryConfigurations' => [ 'shape' => 'PendingLogDeliveryConfigurationList', ], 'TransitEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'TransitEncryptionMode' => [ 'shape' => 'TransitEncryptionMode', ], ], ], 'PreferredAvailabilityZoneList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'PreferredAvailabilityZone', ], ], 'PreferredOutpostArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'PreferredOutpostArn', ], ], 'ProcessedUpdateAction' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'CacheClusterId' => [ 'shape' => 'String', ], 'ServiceUpdateName' => [ 'shape' => 'String', ], 'UpdateActionStatus' => [ 'shape' => 'UpdateActionStatus', ], ], ], 'ProcessedUpdateActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProcessedUpdateAction', 'locationName' => 'ProcessedUpdateAction', ], ], 'PurchaseReservedCacheNodesOfferingMessage' => [ 'type' => 'structure', 'required' => [ 'ReservedCacheNodesOfferingId', ], 'members' => [ 'ReservedCacheNodesOfferingId' => [ 'shape' => 'String', ], 'ReservedCacheNodeId' => [ 'shape' => 'String', ], 'CacheNodeCount' => [ 'shape' => 'IntegerOptional', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'PurchaseReservedCacheNodesOfferingResult' => [ 'type' => 'structure', 'members' => [ 'ReservedCacheNode' => [ 'shape' => 'ReservedCacheNode', ], ], ], 'RebalanceSlotsInGlobalReplicationGroupMessage' => [ 'type' => 'structure', 'required' => [ 'GlobalReplicationGroupId', 'ApplyImmediately', ], 'members' => [ 'GlobalReplicationGroupId' => [ 'shape' => 'String', ], 'ApplyImmediately' => [ 'shape' => 'Boolean', ], ], ], 'RebalanceSlotsInGlobalReplicationGroupResult' => [ 'type' => 'structure', 'members' => [ 'GlobalReplicationGroup' => [ 'shape' => 'GlobalReplicationGroup', ], ], ], 'RebootCacheClusterMessage' => [ 'type' => 'structure', 'required' => [ 'CacheClusterId', 'CacheNodeIdsToReboot', ], 'members' => [ 'CacheClusterId' => [ 'shape' => 'String', ], 'CacheNodeIdsToReboot' => [ 'shape' => 'CacheNodeIdsList', ], ], ], 'RebootCacheClusterResult' => [ 'type' => 'structure', 'members' => [ 'CacheCluster' => [ 'shape' => 'CacheCluster', ], ], ], 'RecurringCharge' => [ 'type' => 'structure', 'members' => [ 'RecurringChargeAmount' => [ 'shape' => 'Double', ], 'RecurringChargeFrequency' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'RecurringChargeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecurringCharge', 'locationName' => 'RecurringCharge', ], ], 'RegionalConfiguration' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', 'ReplicationGroupRegion', 'ReshardingConfiguration', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'ReplicationGroupRegion' => [ 'shape' => 'String', ], 'ReshardingConfiguration' => [ 'shape' => 'ReshardingConfigurationList', ], ], ], 'RegionalConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RegionalConfiguration', 'locationName' => 'RegionalConfiguration', ], ], 'RemoveReplicasList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'RemoveTagsFromResourceMessage' => [ 'type' => 'structure', 'required' => [ 'ResourceName', 'TagKeys', ], 'members' => [ 'ResourceName' => [ 'shape' => 'String', ], 'TagKeys' => [ 'shape' => 'KeyList', ], ], ], 'ReplicaConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConfigureShard', 'locationName' => 'ConfigureShard', ], ], 'ReplicationGroup' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'GlobalReplicationGroupInfo' => [ 'shape' => 'GlobalReplicationGroupInfo', ], 'Status' => [ 'shape' => 'String', ], 'PendingModifiedValues' => [ 'shape' => 'ReplicationGroupPendingModifiedValues', ], 'MemberClusters' => [ 'shape' => 'ClusterIdList', ], 'NodeGroups' => [ 'shape' => 'NodeGroupList', ], 'SnapshottingClusterId' => [ 'shape' => 'String', ], 'AutomaticFailover' => [ 'shape' => 'AutomaticFailoverStatus', ], 'MultiAZ' => [ 'shape' => 'MultiAZStatus', ], 'ConfigurationEndpoint' => [ 'shape' => 'Endpoint', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'SnapshotWindow' => [ 'shape' => 'String', ], 'ClusterEnabled' => [ 'shape' => 'BooleanOptional', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'AuthTokenEnabled' => [ 'shape' => 'BooleanOptional', ], 'AuthTokenLastModifiedDate' => [ 'shape' => 'TStamp', ], 'TransitEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'AtRestEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'MemberClustersOutpostArns' => [ 'shape' => 'ReplicationGroupOutpostArnList', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'ARN' => [ 'shape' => 'String', ], 'UserGroupIds' => [ 'shape' => 'UserGroupIdList', ], 'LogDeliveryConfigurations' => [ 'shape' => 'LogDeliveryConfigurationList', ], 'ReplicationGroupCreateTime' => [ 'shape' => 'TStamp', ], 'DataTiering' => [ 'shape' => 'DataTieringStatus', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'NetworkType' => [ 'shape' => 'NetworkType', ], 'IpDiscovery' => [ 'shape' => 'IpDiscovery', ], 'TransitEncryptionMode' => [ 'shape' => 'TransitEncryptionMode', ], 'ClusterMode' => [ 'shape' => 'ClusterMode', ], ], 'wrapper' => true, ], 'ReplicationGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReplicationGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ReplicationGroupAlreadyUnderMigrationFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReplicationGroupAlreadyUnderMigrationFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ReplicationGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], 'max' => 20, ], 'ReplicationGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReplicationGroup', 'locationName' => 'ReplicationGroup', ], ], 'ReplicationGroupMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ReplicationGroups' => [ 'shape' => 'ReplicationGroupList', ], ], ], 'ReplicationGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReplicationGroupNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ReplicationGroupNotUnderMigrationFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReplicationGroupNotUnderMigrationFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ReplicationGroupOutpostArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'ReplicationGroupOutpostArn', ], ], 'ReplicationGroupPendingModifiedValues' => [ 'type' => 'structure', 'members' => [ 'PrimaryClusterId' => [ 'shape' => 'String', ], 'AutomaticFailoverStatus' => [ 'shape' => 'PendingAutomaticFailoverStatus', ], 'Resharding' => [ 'shape' => 'ReshardingStatus', ], 'AuthTokenStatus' => [ 'shape' => 'AuthTokenUpdateStatus', ], 'UserGroups' => [ 'shape' => 'UserGroupsUpdateStatus', ], 'LogDeliveryConfigurations' => [ 'shape' => 'PendingLogDeliveryConfigurationList', ], 'TransitEncryptionEnabled' => [ 'shape' => 'BooleanOptional', ], 'TransitEncryptionMode' => [ 'shape' => 'TransitEncryptionMode', ], 'ClusterMode' => [ 'shape' => 'ClusterMode', ], ], ], 'ReservedCacheNode' => [ 'type' => 'structure', 'members' => [ 'ReservedCacheNodeId' => [ 'shape' => 'String', ], 'ReservedCacheNodesOfferingId' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'StartTime' => [ 'shape' => 'TStamp', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'CacheNodeCount' => [ 'shape' => 'Integer', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'State' => [ 'shape' => 'String', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], 'ReservationARN' => [ 'shape' => 'String', ], ], 'wrapper' => true, ], 'ReservedCacheNodeAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedCacheNodeAlreadyExists', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ReservedCacheNodeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedCacheNode', 'locationName' => 'ReservedCacheNode', ], ], 'ReservedCacheNodeMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ReservedCacheNodes' => [ 'shape' => 'ReservedCacheNodeList', ], ], ], 'ReservedCacheNodeNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedCacheNodeNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ReservedCacheNodeQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedCacheNodeQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ReservedCacheNodesOffering' => [ 'type' => 'structure', 'members' => [ 'ReservedCacheNodesOfferingId' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'Duration' => [ 'shape' => 'Integer', ], 'FixedPrice' => [ 'shape' => 'Double', ], 'UsagePrice' => [ 'shape' => 'Double', ], 'ProductDescription' => [ 'shape' => 'String', ], 'OfferingType' => [ 'shape' => 'String', ], 'RecurringCharges' => [ 'shape' => 'RecurringChargeList', ], ], 'wrapper' => true, ], 'ReservedCacheNodesOfferingList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReservedCacheNodesOffering', 'locationName' => 'ReservedCacheNodesOffering', ], ], 'ReservedCacheNodesOfferingMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ReservedCacheNodesOfferings' => [ 'shape' => 'ReservedCacheNodesOfferingList', ], ], ], 'ReservedCacheNodesOfferingNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ReservedCacheNodesOfferingNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ResetCacheParameterGroupMessage' => [ 'type' => 'structure', 'required' => [ 'CacheParameterGroupName', ], 'members' => [ 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'ResetAllParameters' => [ 'shape' => 'Boolean', ], 'ParameterNameValues' => [ 'shape' => 'ParameterNameValueList', ], ], ], 'ReshardingConfiguration' => [ 'type' => 'structure', 'members' => [ 'NodeGroupId' => [ 'shape' => 'AllowedNodeGroupId', ], 'PreferredAvailabilityZones' => [ 'shape' => 'AvailabilityZonesList', ], ], ], 'ReshardingConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReshardingConfiguration', 'locationName' => 'ReshardingConfiguration', ], ], 'ReshardingStatus' => [ 'type' => 'structure', 'members' => [ 'SlotMigration' => [ 'shape' => 'SlotMigration', ], ], ], 'RevokeCacheSecurityGroupIngressMessage' => [ 'type' => 'structure', 'required' => [ 'CacheSecurityGroupName', 'EC2SecurityGroupName', 'EC2SecurityGroupOwnerId', ], 'members' => [ 'CacheSecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupName' => [ 'shape' => 'String', ], 'EC2SecurityGroupOwnerId' => [ 'shape' => 'String', ], ], ], 'RevokeCacheSecurityGroupIngressResult' => [ 'type' => 'structure', 'members' => [ 'CacheSecurityGroup' => [ 'shape' => 'CacheSecurityGroup', ], ], ], 'SecurityGroupIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SecurityGroupId', ], ], 'SecurityGroupMembership' => [ 'type' => 'structure', 'members' => [ 'SecurityGroupId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], ], ], 'SecurityGroupMembershipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SecurityGroupMembership', ], ], 'ServerlessCache' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheName' => [ 'shape' => 'String', ], 'Description' => [ 'shape' => 'String', ], 'CreateTime' => [ 'shape' => 'TStamp', ], 'Status' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], 'FullEngineVersion' => [ 'shape' => 'String', ], 'CacheUsageLimits' => [ 'shape' => 'CacheUsageLimits', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'SecurityGroupIds' => [ 'shape' => 'SecurityGroupIdsList', ], 'Endpoint' => [ 'shape' => 'Endpoint', ], 'ReaderEndpoint' => [ 'shape' => 'Endpoint', ], 'ARN' => [ 'shape' => 'String', ], 'UserGroupId' => [ 'shape' => 'String', ], 'SubnetIds' => [ 'shape' => 'SubnetIdsList', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'DailySnapshotTime' => [ 'shape' => 'String', ], ], ], 'ServerlessCacheAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ServerlessCacheAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ServerlessCacheConfiguration' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheName' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'MajorEngineVersion' => [ 'shape' => 'String', ], ], ], 'ServerlessCacheList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServerlessCache', ], ], 'ServerlessCacheNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ServerlessCacheNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ServerlessCacheQuotaForCustomerExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ServerlessCacheQuotaForCustomerExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ServerlessCacheSnapshot' => [ 'type' => 'structure', 'members' => [ 'ServerlessCacheSnapshotName' => [ 'shape' => 'String', ], 'ARN' => [ 'shape' => 'String', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'SnapshotType' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'CreateTime' => [ 'shape' => 'TStamp', ], 'ExpiryTime' => [ 'shape' => 'TStamp', ], 'BytesUsedForCache' => [ 'shape' => 'String', ], 'ServerlessCacheConfiguration' => [ 'shape' => 'ServerlessCacheConfiguration', ], ], ], 'ServerlessCacheSnapshotAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ServerlessCacheSnapshotAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ServerlessCacheSnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServerlessCacheSnapshot', 'locationName' => 'ServerlessCacheSnapshot', ], ], 'ServerlessCacheSnapshotNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ServerlessCacheSnapshotNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ServerlessCacheSnapshotQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ServerlessCacheSnapshotQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ServiceLinkedRoleNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ServiceLinkedRoleNotFoundFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ServiceUpdate' => [ 'type' => 'structure', 'members' => [ 'ServiceUpdateName' => [ 'shape' => 'String', ], 'ServiceUpdateReleaseDate' => [ 'shape' => 'TStamp', ], 'ServiceUpdateEndDate' => [ 'shape' => 'TStamp', ], 'ServiceUpdateSeverity' => [ 'shape' => 'ServiceUpdateSeverity', ], 'ServiceUpdateRecommendedApplyByDate' => [ 'shape' => 'TStamp', ], 'ServiceUpdateStatus' => [ 'shape' => 'ServiceUpdateStatus', ], 'ServiceUpdateDescription' => [ 'shape' => 'String', ], 'ServiceUpdateType' => [ 'shape' => 'ServiceUpdateType', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'AutoUpdateAfterRecommendedApplyByDate' => [ 'shape' => 'BooleanOptional', ], 'EstimatedUpdateTime' => [ 'shape' => 'String', ], ], ], 'ServiceUpdateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceUpdate', 'locationName' => 'ServiceUpdate', ], ], 'ServiceUpdateNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'ServiceUpdateNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'ServiceUpdateSeverity' => [ 'type' => 'string', 'enum' => [ 'critical', 'important', 'medium', 'low', ], ], 'ServiceUpdateStatus' => [ 'type' => 'string', 'enum' => [ 'available', 'cancelled', 'expired', ], ], 'ServiceUpdateStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceUpdateStatus', ], 'max' => 3, ], 'ServiceUpdateType' => [ 'type' => 'string', 'enum' => [ 'security-update', ], ], 'ServiceUpdatesMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'ServiceUpdates' => [ 'shape' => 'ServiceUpdateList', ], ], ], 'SlaMet' => [ 'type' => 'string', 'enum' => [ 'yes', 'no', 'n/a', ], ], 'SlotMigration' => [ 'type' => 'structure', 'members' => [ 'ProgressPercentage' => [ 'shape' => 'Double', ], ], ], 'Snapshot' => [ 'type' => 'structure', 'members' => [ 'SnapshotName' => [ 'shape' => 'String', ], 'ReplicationGroupId' => [ 'shape' => 'String', ], 'ReplicationGroupDescription' => [ 'shape' => 'String', ], 'CacheClusterId' => [ 'shape' => 'String', ], 'SnapshotStatus' => [ 'shape' => 'String', ], 'SnapshotSource' => [ 'shape' => 'String', ], 'CacheNodeType' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], 'EngineVersion' => [ 'shape' => 'String', ], 'NumCacheNodes' => [ 'shape' => 'IntegerOptional', ], 'PreferredAvailabilityZone' => [ 'shape' => 'String', ], 'PreferredOutpostArn' => [ 'shape' => 'String', ], 'CacheClusterCreateTime' => [ 'shape' => 'TStamp', ], 'PreferredMaintenanceWindow' => [ 'shape' => 'String', ], 'TopicArn' => [ 'shape' => 'String', ], 'Port' => [ 'shape' => 'IntegerOptional', ], 'CacheParameterGroupName' => [ 'shape' => 'String', ], 'CacheSubnetGroupName' => [ 'shape' => 'String', ], 'VpcId' => [ 'shape' => 'String', ], 'AutoMinorVersionUpgrade' => [ 'shape' => 'Boolean', ], 'SnapshotRetentionLimit' => [ 'shape' => 'IntegerOptional', ], 'SnapshotWindow' => [ 'shape' => 'String', ], 'NumNodeGroups' => [ 'shape' => 'IntegerOptional', ], 'AutomaticFailover' => [ 'shape' => 'AutomaticFailoverStatus', ], 'NodeSnapshots' => [ 'shape' => 'NodeSnapshotList', ], 'KmsKeyId' => [ 'shape' => 'String', ], 'ARN' => [ 'shape' => 'String', ], 'DataTiering' => [ 'shape' => 'DataTieringStatus', ], ], 'wrapper' => true, ], 'SnapshotAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SnapshotAlreadyExistsFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SnapshotArnsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SnapshotArn', ], ], 'SnapshotFeatureNotSupportedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SnapshotFeatureNotSupportedFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SnapshotList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Snapshot', 'locationName' => 'Snapshot', ], ], 'SnapshotNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SnapshotNotFoundFault', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'SnapshotQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SnapshotQuotaExceededFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SourceType' => [ 'type' => 'string', 'enum' => [ 'cache-cluster', 'cache-parameter-group', 'cache-security-group', 'cache-subnet-group', 'replication-group', 'serverless-cache', 'serverless-cache-snapshot', 'user', 'user-group', ], ], 'StartMigrationMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', 'CustomerNodeEndpointList', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'CustomerNodeEndpointList' => [ 'shape' => 'CustomerNodeEndpointList', ], ], ], 'StartMigrationResponse' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'String' => [ 'type' => 'string', ], 'Subnet' => [ 'type' => 'structure', 'members' => [ 'SubnetIdentifier' => [ 'shape' => 'String', ], 'SubnetAvailabilityZone' => [ 'shape' => 'AvailabilityZone', ], 'SubnetOutpost' => [ 'shape' => 'SubnetOutpost', ], 'SupportedNetworkTypes' => [ 'shape' => 'NetworkTypeList', ], ], ], 'SubnetIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SubnetIdentifier', ], ], 'SubnetIdsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', 'locationName' => 'SubnetId', ], ], 'SubnetInUse' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubnetInUse', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SubnetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Subnet', 'locationName' => 'Subnet', ], ], 'SubnetNotAllowedFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'SubnetNotAllowedFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'SubnetOutpost' => [ 'type' => 'structure', 'members' => [ 'SubnetOutpostArn' => [ 'shape' => 'String', ], ], ], 'TStamp' => [ 'type' => 'timestamp', ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'String', ], 'Value' => [ 'shape' => 'String', ], ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', 'locationName' => 'Tag', ], ], 'TagListMessage' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], 'TagNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'TagNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'TagQuotaPerResourceExceeded' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'TagQuotaPerResourceExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'TestFailoverMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', 'NodeGroupId', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'NodeGroupId' => [ 'shape' => 'AllowedNodeGroupId', ], ], ], 'TestFailoverNotAvailableFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'TestFailoverNotAvailableFault', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'TestFailoverResult' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'TestMigrationMessage' => [ 'type' => 'structure', 'required' => [ 'ReplicationGroupId', 'CustomerNodeEndpointList', ], 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'CustomerNodeEndpointList' => [ 'shape' => 'CustomerNodeEndpointList', ], ], ], 'TestMigrationResponse' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroup' => [ 'shape' => 'ReplicationGroup', ], ], ], 'TimeRangeFilter' => [ 'type' => 'structure', 'members' => [ 'StartTime' => [ 'shape' => 'TStamp', ], 'EndTime' => [ 'shape' => 'TStamp', ], ], ], 'TransitEncryptionMode' => [ 'type' => 'string', 'enum' => [ 'preferred', 'required', ], ], 'UGReplicationGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'UGServerlessCacheIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'UnprocessedUpdateAction' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'CacheClusterId' => [ 'shape' => 'String', ], 'ServiceUpdateName' => [ 'shape' => 'String', ], 'ErrorType' => [ 'shape' => 'String', ], 'ErrorMessage' => [ 'shape' => 'String', ], ], ], 'UnprocessedUpdateActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UnprocessedUpdateAction', 'locationName' => 'UnprocessedUpdateAction', ], ], 'UpdateAction' => [ 'type' => 'structure', 'members' => [ 'ReplicationGroupId' => [ 'shape' => 'String', ], 'CacheClusterId' => [ 'shape' => 'String', ], 'ServiceUpdateName' => [ 'shape' => 'String', ], 'ServiceUpdateReleaseDate' => [ 'shape' => 'TStamp', ], 'ServiceUpdateSeverity' => [ 'shape' => 'ServiceUpdateSeverity', ], 'ServiceUpdateStatus' => [ 'shape' => 'ServiceUpdateStatus', ], 'ServiceUpdateRecommendedApplyByDate' => [ 'shape' => 'TStamp', ], 'ServiceUpdateType' => [ 'shape' => 'ServiceUpdateType', ], 'UpdateActionAvailableDate' => [ 'shape' => 'TStamp', ], 'UpdateActionStatus' => [ 'shape' => 'UpdateActionStatus', ], 'NodesUpdated' => [ 'shape' => 'String', ], 'UpdateActionStatusModifiedDate' => [ 'shape' => 'TStamp', ], 'SlaMet' => [ 'shape' => 'SlaMet', ], 'NodeGroupUpdateStatus' => [ 'shape' => 'NodeGroupUpdateStatusList', ], 'CacheNodeUpdateStatus' => [ 'shape' => 'CacheNodeUpdateStatusList', ], 'EstimatedUpdateTime' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'String', ], ], ], 'UpdateActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpdateAction', 'locationName' => 'UpdateAction', ], ], 'UpdateActionResultsMessage' => [ 'type' => 'structure', 'members' => [ 'ProcessedUpdateActions' => [ 'shape' => 'ProcessedUpdateActionList', ], 'UnprocessedUpdateActions' => [ 'shape' => 'UnprocessedUpdateActionList', ], ], ], 'UpdateActionStatus' => [ 'type' => 'string', 'enum' => [ 'not-applied', 'waiting-to-start', 'in-progress', 'stopping', 'stopped', 'complete', 'scheduling', 'scheduled', 'not-applicable', ], ], 'UpdateActionStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UpdateActionStatus', ], 'max' => 9, ], 'UpdateActionsMessage' => [ 'type' => 'structure', 'members' => [ 'Marker' => [ 'shape' => 'String', ], 'UpdateActions' => [ 'shape' => 'UpdateActionList', ], ], ], 'User' => [ 'type' => 'structure', 'members' => [ 'UserId' => [ 'shape' => 'String', ], 'UserName' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'EngineType', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], 'AccessString' => [ 'shape' => 'String', ], 'UserGroupIds' => [ 'shape' => 'UserGroupIdList', ], 'Authentication' => [ 'shape' => 'Authentication', ], 'ARN' => [ 'shape' => 'String', ], ], ], 'UserAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'UserAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'UserGroup' => [ 'type' => 'structure', 'members' => [ 'UserGroupId' => [ 'shape' => 'String', ], 'Status' => [ 'shape' => 'String', ], 'Engine' => [ 'shape' => 'EngineType', ], 'UserIds' => [ 'shape' => 'UserIdList', ], 'MinimumEngineVersion' => [ 'shape' => 'String', ], 'PendingChanges' => [ 'shape' => 'UserGroupPendingChanges', ], 'ReplicationGroups' => [ 'shape' => 'UGReplicationGroupIdList', ], 'ServerlessCaches' => [ 'shape' => 'UGServerlessCacheIdList', ], 'ARN' => [ 'shape' => 'String', ], ], ], 'UserGroupAlreadyExistsFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'UserGroupAlreadyExists', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'UserGroupId' => [ 'type' => 'string', 'min' => 1, 'pattern' => '[a-zA-Z][a-zA-Z0-9\\-]*', ], 'UserGroupIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserGroupId', ], ], 'UserGroupIdListInput' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserGroupId', ], 'min' => 1, ], 'UserGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserGroup', ], ], 'UserGroupNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'UserGroupNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'UserGroupPendingChanges' => [ 'type' => 'structure', 'members' => [ 'UserIdsToRemove' => [ 'shape' => 'UserIdList', ], 'UserIdsToAdd' => [ 'shape' => 'UserIdList', ], ], ], 'UserGroupQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'UserGroupQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'UserGroupsUpdateStatus' => [ 'type' => 'structure', 'members' => [ 'UserGroupIdsToAdd' => [ 'shape' => 'UserGroupIdList', ], 'UserGroupIdsToRemove' => [ 'shape' => 'UserGroupIdList', ], ], ], 'UserId' => [ 'type' => 'string', 'min' => 1, 'pattern' => '[a-zA-Z][a-zA-Z0-9\\-]*', ], 'UserIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserId', ], ], 'UserIdListInput' => [ 'type' => 'list', 'member' => [ 'shape' => 'UserId', ], 'min' => 1, ], 'UserList' => [ 'type' => 'list', 'member' => [ 'shape' => 'User', ], ], 'UserName' => [ 'type' => 'string', 'min' => 1, ], 'UserNotFoundFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'UserNotFound', 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'UserQuotaExceededFault' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'code' => 'UserQuotaExceeded', 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], ],]; diff --git a/src/data/elasticache/2015-02-02/docs-2.json b/src/data/elasticache/2015-02-02/docs-2.json index 751b7a4abf..6332edb2c2 100644 --- a/src/data/elasticache/2015-02-02/docs-2.json +++ b/src/data/elasticache/2015-02-02/docs-2.json @@ -75,7 +75,7 @@ "ResetCacheParameterGroup": "Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.
Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
", "StartMigration": "Start the migration of data.
", - "TestFailover": "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.
", + "TestFailover": "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": "Async API to test connection between source and target replication group.
" }, "shapes": { @@ -112,7 +112,7 @@ "NodeGroupsToRemoveList$member": null, "NodeGroupsToRetainList$member": null, "ReshardingConfiguration$NodeGroupId": "Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
", - "TestFailoverMessage$NodeGroupId": "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.
" + "TestFailoverMessage$NodeGroupId": "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.
" } }, "AllowedNodeTypeModificationsMessage": { @@ -130,8 +130,8 @@ "AuthTokenUpdateStrategyType": { "base": null, "refs": { - "ModifyCacheClusterMessage$AuthTokenUpdateStrategy": "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
", - "ModifyReplicationGroupMessage$AuthTokenUpdateStrategy": "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
" + "ModifyCacheClusterMessage$AuthTokenUpdateStrategy": "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
", + "ModifyReplicationGroupMessage$AuthTokenUpdateStrategy": "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
" } }, "Authentication": { @@ -2480,7 +2480,7 @@ "DescribeUpdateActionsMessage$Marker": "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.
The ID of the user group.
", "DescribeUserGroupsMessage$Marker": "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. >
", - "DescribeUserGroupsResult$Marker": "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. >
", + "DescribeUserGroupsResult$Marker": "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.>
", "DescribeUsersMessage$Marker": "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. >
", "DescribeUsersResult$Marker": "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. >
", "DisassociateGlobalReplicationGroupMessage$GlobalReplicationGroupId": "The name of the Global datastore
", diff --git a/src/data/elasticache/2015-02-02/docs-2.json.php b/src/data/elasticache/2015-02-02/docs-2.json.php index 5b5b5f39cc..6d2e4fe056 100644 --- a/src/data/elasticache/2015-02-02/docs-2.json.php +++ b/src/data/elasticache/2015-02-02/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => 'Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.
With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.
In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.
', 'operations' => [ 'AddTagsToResource' => 'A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services.
For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.
', 'AuthorizeCacheSecurityGroupIngress' => 'Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.
You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.
Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
', 'BatchStopUpdateAction' => 'Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
', 'CompleteMigration' => 'Complete the migration of data.
', 'CopyServerlessCacheSnapshot' => 'Creates a copy of an existing serverless cache’s snapshot. Available for Redis only.
', 'CopySnapshot' => 'Makes a copy of an existing snapshot.
This operation is valid for Redis only.
Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.
You could receive the following error messages.
Error Messages
Error Message: The S3 bucket %s is outside of the region.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s does not exist.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s is not owned by the authenticated user.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.
Solution: Contact your system administrator to get the needed permissions.
Error Message: The S3 bucket %s already contains an object with key %s.
Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.
Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis.
This operation is not supported for Redis (cluster mode enabled) clusters.
', 'CreateCacheParameterGroup' => 'Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.
A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:
ModifyCacheParameterGroup in the ElastiCache API Reference.
Parameters and Parameter Groups in the ElastiCache User Guide.
Creates a new cache security group. Use a cache security group to control access to one or more clusters.
Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.
', 'CreateCacheSubnetGroup' => 'Creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
', 'CreateGlobalReplicationGroup' => 'Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.
The GlobalReplicationGroupIdSuffix is the name of the Global datastore.
The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.
A Redis (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.
The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.
To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.
When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis\' scaling. For more information, see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.
This operation is valid for Redis only.
Creates a serverless cache.
', 'CreateServerlessCacheSnapshot' => 'This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis only.
', 'CreateSnapshot' => 'Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Redis only.
For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).
', 'CreateUserGroup' => 'For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC)
', 'DecreaseNodeGroupsInGlobalReplicationGroup' => 'Decreases the number of node groups in a Global datastore
', 'DecreaseReplicaCount' => 'Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
', 'DeleteCacheCluster' => 'Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.
This operation is not valid for:
Redis (cluster mode enabled) clusters
Redis (cluster mode disabled) clusters
A cluster that is the last read replica of a replication group
A cluster that is the primary node of a replication group
A node group (shard) that has Multi-AZ mode enabled
A cluster from a Redis (cluster mode enabled) replication group
A cluster that is not in the available state
Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account.
', 'DeleteCacheSecurityGroup' => 'Deletes a cache security group.
You cannot delete a cache security group if it is associated with any clusters.
Deletes a cache subnet group.
You cannot delete a default cache subnet group or one that is associated with any clusters.
Deleting a Global datastore is a two-step process:
First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.
Once the Global datastore contains only the primary cluster, you can use the DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary cluster using RetainPrimaryReplicationGroup=true.
Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
', 'DeleteReplicationGroup' => 'Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
This operation is valid for Redis only.
Deletes a specified existing serverless cache.
', 'DeleteServerlessCacheSnapshot' => 'Deletes an existing serverless cache snapshot. Available for Redis only.
', 'DeleteSnapshot' => 'Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.
This operation is valid for Redis only.
For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).
', 'DeleteUserGroup' => 'For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).
', 'DescribeCacheClusters' => 'Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.
By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.
If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.
If the cluster is in the deleting state, only cluster-level information is displayed.
If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.
If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.
', 'DescribeCacheEngineVersions' => 'Returns a list of the available cache engines and their versions.
', 'DescribeCacheParameterGroups' => 'Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
', 'DescribeCacheParameters' => 'Returns the detailed parameter list for a particular cache parameter group.
', 'DescribeCacheSecurityGroups' => 'Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup
', 'DescribeCacheSubnetGroups' => 'Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
', 'DescribeEngineDefaultParameters' => 'Returns the default engine and system parameter information for the specified cache engine.
', 'DescribeEvents' => 'Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.
By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days\' worth of events if necessary.
', 'DescribeGlobalReplicationGroups' => 'Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
', 'DescribeReplicationGroups' => 'Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
This operation is valid for Redis only.
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
', 'DescribeReservedCacheNodesOfferings' => 'Lists available reserved cache node offerings.
', 'DescribeServerlessCacheSnapshots' => 'Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Redis only.
', 'DescribeServerlessCaches' => 'Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account.
', 'DescribeServiceUpdates' => 'Returns details of the service updates
', 'DescribeSnapshots' => 'Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.
This operation is valid for Redis only.
Returns details of the update actions
', 'DescribeUserGroups' => 'Returns a list of user groups.
', 'DescribeUsers' => 'Returns a list of users.
', 'DisassociateGlobalReplicationGroup' => 'Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.
', 'ExportServerlessCacheSnapshot' => 'Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis only.
', 'FailoverGlobalReplicationGroup' => 'Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.
', 'IncreaseNodeGroupsInGlobalReplicationGroup' => 'Increase the number of node groups in the Global datastore
', 'IncreaseReplicaCount' => 'Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
', 'ListAllowedNodeTypeModifications' => 'Lists all available node types that you can scale your Redis cluster\'s or replication group\'s current node type.
When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.
Lists all tags currently on a named resource.
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
If the cluster is not in the available state, ListTagsForResource returns an error.
Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
', 'ModifyCacheParameterGroup' => 'Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
', 'ModifyCacheSubnetGroup' => 'Modifies an existing cache subnet group.
', 'ModifyGlobalReplicationGroup' => 'Modifies the settings for a Global datastore.
', 'ModifyReplicationGroup' => 'Modifies the settings for a replication group. This is limited to Redis 7 and newer.
Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in the ElastiCache User Guide
ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
This operation is valid for Redis only.
Modifies a replication group\'s shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.
', 'ModifyServerlessCache' => 'This API modifies the attributes of a serverless cache.
', 'ModifyUser' => 'Changes user password(s) and/or access string.
', 'ModifyUserGroup' => 'Changes the list of users that belong to the user group.
', 'PurchaseReservedCacheNodesOffering' => 'Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis or Managing Costs with Reserved Nodes for Memcached.
', 'RebalanceSlotsInGlobalReplicationGroup' => 'Redistribute slots to ensure uniform distribution across existing shards in the cluster.
', 'RebootCacheCluster' => 'Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.
The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.
When the reboot is complete, a cluster event is created.
Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters.
If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
', 'RemoveTagsFromResource' => 'Removes the tags identified by the TagKeys list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.
Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
', 'StartMigration' => 'Start the migration of data.
', 'TestFailover' => '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.
', 'TestMigration' => 'Async API to test connection between source and target replication group.
', ], 'shapes' => [ 'APICallRateForCustomerExceededFault' => [ 'base' => 'The customer has exceeded the allowed rate of API calls.
', 'refs' => [], ], 'AZMode' => [ 'base' => NULL, 'refs' => [ 'CreateCacheClusterMessage$AZMode' => 'Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster\'s region.
This parameter is only supported for Memcached clusters.
If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.
Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.
Valid values: single-az | cross-az.
This option is only supported for Memcached clusters.
You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.
Only newly created nodes are located in different Availability Zones.
Access permissions string used for this user.
', 'ModifyUserMessage$AccessString' => 'Access permissions string used for this user.
', 'ModifyUserMessage$AppendAccessString' => 'Adds additional user permissions to the access string.
', ], ], 'AddTagsToResourceMessage' => [ 'base' => 'Represents the input of an AddTagsToResource operation.
', 'refs' => [], ], 'AllowedNodeGroupId' => [ 'base' => NULL, 'refs' => [ 'ConfigureShard$NodeGroupId' => 'The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)\'s node group\'s (shard\'s) id, see Finding a Shard\'s Id.
', 'NodeGroupConfiguration$NodeGroupId' => 'Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
', 'NodeGroupsToRemoveList$member' => NULL, 'NodeGroupsToRetainList$member' => NULL, 'ReshardingConfiguration$NodeGroupId' => 'Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
', 'TestFailoverMessage$NodeGroupId' => '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.
', ], ], 'AllowedNodeTypeModificationsMessage' => [ 'base' => 'Represents the allowed node types you can use to modify your cluster or replication group.
', 'refs' => [], ], 'AuthTokenUpdateStatus' => [ 'base' => NULL, 'refs' => [ 'PendingModifiedValues$AuthTokenStatus' => 'The auth token status
', 'ReplicationGroupPendingModifiedValues$AuthTokenStatus' => 'The auth token status
', ], ], 'AuthTokenUpdateStrategyType' => [ 'base' => NULL, 'refs' => [ 'ModifyCacheClusterMessage$AuthTokenUpdateStrategy' => '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
', 'ModifyReplicationGroupMessage$AuthTokenUpdateStrategy' => '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
', ], ], 'Authentication' => [ 'base' => 'Indicates whether the user requires a password to authenticate.
', 'refs' => [ 'User$Authentication' => 'Denotes whether the user requires a password to authenticate.
', ], ], 'AuthenticationMode' => [ 'base' => 'Specifies the authentication mode to use.
', 'refs' => [ 'CreateUserMessage$AuthenticationMode' => 'Specifies how to authenticate the user.
', 'ModifyUserMessage$AuthenticationMode' => 'Specifies how to authenticate the user.
', ], ], 'AuthenticationType' => [ 'base' => NULL, 'refs' => [ 'Authentication$Type' => 'Indicates whether the user requires a password to authenticate.
', ], ], 'AuthorizationAlreadyExistsFault' => [ 'base' => 'The specified Amazon EC2 security group is already authorized for the specified cache security group.
', 'refs' => [], ], 'AuthorizationNotFoundFault' => [ 'base' => 'The specified Amazon EC2 security group is not authorized for the specified cache security group.
', 'refs' => [], ], 'AuthorizeCacheSecurityGroupIngressMessage' => [ 'base' => 'Represents the input of an AuthorizeCacheSecurityGroupIngress operation.
', 'refs' => [], ], 'AuthorizeCacheSecurityGroupIngressResult' => [ 'base' => NULL, 'refs' => [], ], 'AutomaticFailoverStatus' => [ 'base' => NULL, 'refs' => [ 'GlobalReplicationGroupMember$AutomaticFailover' => 'Indicates whether automatic failover is enabled for the replication group.
', 'ReplicationGroup$AutomaticFailover' => 'Indicates the status of automatic failover for this Redis replication group.
', 'Snapshot$AutomaticFailover' => 'Indicates the status of automatic failover for the source Redis replication group.
', ], ], 'AvailabilityZone' => [ 'base' => 'Describes an Availability Zone in which the cluster is launched.
', 'refs' => [ 'Subnet$SubnetAvailabilityZone' => 'The Availability Zone associated with the subnet.
', ], ], 'AvailabilityZonesList' => [ 'base' => NULL, 'refs' => [ 'CreateReplicationGroupMessage$PreferredCacheClusterAZs' => 'A list of EC2 Availability Zones in which the replication group\'s clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.
This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.
If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of NumCacheClusters.
Default: system chosen Availability Zones.
', 'NodeGroupConfiguration$ReplicaAvailabilityZones' => 'A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.
A list of preferred availability zones for the nodes in this cluster.
', ], ], 'AwsQueryErrorMessage' => [ 'base' => NULL, 'refs' => [ 'InvalidParameterCombinationException$message' => 'Two or more parameters that must not be used together were used together.
', 'InvalidParameterValueException$message' => 'A parameter value is invalid.
', ], ], 'BatchApplyUpdateActionMessage' => [ 'base' => NULL, 'refs' => [], ], 'BatchStopUpdateActionMessage' => [ 'base' => NULL, 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$AutoMinorVersionUpgrade' => 'If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
', 'CacheCluster$ReplicationGroupLogDeliveryEnabled' => 'A boolean value indicating whether log delivery is enabled for the replication group.
', 'CacheNodeTypeSpecificParameter$IsModifiable' => 'Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
Indicates whether the parameter group is associated with a Global datastore
', 'CompleteMigrationMessage$Force' => 'Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.
', 'DecreaseNodeGroupsInGlobalReplicationGroupMessage$ApplyImmediately' => 'Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.
', 'DecreaseReplicaCountMessage$ApplyImmediately' => 'If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.
The primary replication group is retained as a standalone replication group.
', 'DescribeCacheEngineVersionsMessage$DefaultOnly' => 'If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.
Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.
', 'IncreaseReplicaCountMessage$ApplyImmediately' => 'If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported.
If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster.
If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.
If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.
Valid values: true | false
Default: false
This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.
', 'ModifyReplicationGroupMessage$ApplyImmediately' => 'If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.
If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.
Valid values: true | false
Default: false
Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.
Value: true
', 'Parameter$IsModifiable' => 'Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
If True, redistribution is applied immediately.
If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
', 'ResetCacheParameterGroupMessage$ResetAllParameters' => 'If true, all parameters in the cache parameter group are reset to their default values. If false, only the parameters listed by ParameterNameValues are reset to their default values.
Valid values: true | false
If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
', ], ], 'BooleanOptional' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$AuthTokenEnabled' => 'A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false
A flag that enables in-transit encryption when set to true.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
A flag that enables encryption at-rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
', 'CreateCacheClusterMessage$TransitEncryptionEnabled' => 'A flag that enables in-transit encryption when set to true.
', 'CreateReplicationGroupMessage$AutomaticFailoverEnabled' => 'Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
', 'CreateReplicationGroupMessage$MultiAZEnabled' => 'A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
', 'CreateReplicationGroupMessage$AutoMinorVersionUpgrade' => 'If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
', 'CreateReplicationGroupMessage$TransitEncryptionEnabled' => 'A flag that enables in-transit encryption when set to true.
This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC.
If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.
A flag that enables encryption at rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.
', 'CreateUserMessage$NoPasswordRequired' => 'Indicates a password is not required for this user.
', 'DeleteReplicationGroupMessage$RetainPrimaryCluster' => 'If set to true, all of the read replicas are deleted, but the primary node is retained.
An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.
Returns the list of members that comprise the Global datastore.
', 'DescribeSnapshotsMessage$ShowNodeGroupConfig' => 'A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
', 'DescribeUpdateActionsMessage$ShowNodeLevelUpdateStatus' => 'Dictates whether to include node level update status in the response
', 'GlobalReplicationGroup$ClusterEnabled' => 'A flag that indicates whether the Global datastore is cluster enabled.
', 'GlobalReplicationGroup$AuthTokenEnabled' => 'A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false
A flag that enables in-transit encryption when set to true.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
A flag that enables encryption at rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Specify if log delivery is enabled. Default true.
If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
', 'ModifyGlobalReplicationGroupMessage$AutomaticFailoverEnabled' => 'Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
', 'ModifyReplicationGroupMessage$AutomaticFailoverEnabled' => 'Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
Valid values: true | false
A flag to indicate MultiAZ is enabled.
', 'ModifyReplicationGroupMessage$AutoMinorVersionUpgrade' => 'If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
', 'ModifyReplicationGroupMessage$RemoveUserGroups' => 'Removes the user group associated with this replication group.
', 'ModifyReplicationGroupMessage$TransitEncryptionEnabled' => 'A flag that enables in-transit encryption when set to true. If you are enabling in-transit encryption for an existing cluster, you must also set TransitEncryptionMode to preferred.
The identifier of the UserGroup to be removed from association with the Redis serverless cache. Available for Redis only. Default is NULL.
', 'ModifyUserMessage$NoPasswordRequired' => 'Indicates no password is required for the user.
', 'PendingModifiedValues$TransitEncryptionEnabled' => 'A flag that enables in-transit encryption when set to true.
', 'ReplicationGroup$ClusterEnabled' => 'A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).
Valid values: true | false
A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false
A flag that enables in-transit encryption when set to true.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
A flag that enables encryption at-rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
A flag that enables in-transit encryption when set to true.
', 'ServiceUpdate$AutoUpdateAfterRecommendedApplyByDate' => 'Indicates whether the service update will be automatically applied once the recommended apply-by date has expired.
', ], ], 'CacheCluster' => [ 'base' => 'Contains all of the attributes of a specific cluster.
', 'refs' => [ 'CacheClusterList$member' => NULL, 'CreateCacheClusterResult$CacheCluster' => NULL, 'DeleteCacheClusterResult$CacheCluster' => NULL, 'ModifyCacheClusterResult$CacheCluster' => NULL, 'RebootCacheClusterResult$CacheCluster' => NULL, ], ], 'CacheClusterAlreadyExistsFault' => [ 'base' => 'You already have a cluster with the given identifier.
', 'refs' => [], ], 'CacheClusterIdList' => [ 'base' => NULL, 'refs' => [ 'BatchApplyUpdateActionMessage$CacheClusterIds' => 'The cache cluster IDs
', 'BatchStopUpdateActionMessage$CacheClusterIds' => 'The cache cluster IDs
', 'DescribeUpdateActionsMessage$CacheClusterIds' => 'The cache cluster IDs
', ], ], 'CacheClusterList' => [ 'base' => NULL, 'refs' => [ 'CacheClusterMessage$CacheClusters' => 'A list of clusters. Each item in the list contains detailed information about one cluster.
', ], ], 'CacheClusterMessage' => [ 'base' => 'Represents the output of a DescribeCacheClusters operation.
The requested cluster ID does not refer to an existing cluster.
', 'refs' => [], ], 'CacheEngineVersion' => [ 'base' => 'Provides all of the details about a particular cache engine version.
', 'refs' => [ 'CacheEngineVersionList$member' => NULL, ], ], 'CacheEngineVersionList' => [ 'base' => NULL, 'refs' => [ 'CacheEngineVersionMessage$CacheEngineVersions' => 'A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.
', ], ], 'CacheEngineVersionMessage' => [ 'base' => 'Represents the output of a DescribeCacheEngineVersions operation.
', 'refs' => [], ], 'CacheNode' => [ 'base' => 'Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster\'s protocol-compliant caching software - either Memcached or Redis.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
', 'ModifyCacheClusterMessage$CacheNodeIdsToRemove' => 'A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.
For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.
A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).
', 'RebootCacheClusterMessage$CacheNodeIdsToReboot' => 'A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.
', ], ], 'CacheNodeList' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$CacheNodes' => 'A list of cache nodes that are members of the cluster.
', ], ], 'CacheNodeTypeSpecificParameter' => [ 'base' => 'A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.
A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
', 'EngineDefaults$CacheNodeTypeSpecificParameters' => 'A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
', ], ], 'CacheNodeTypeSpecificValue' => [ 'base' => 'A value that applies only to a certain cache node type.
', 'refs' => [ 'CacheNodeTypeSpecificValueList$member' => NULL, ], ], 'CacheNodeTypeSpecificValueList' => [ 'base' => NULL, 'refs' => [ 'CacheNodeTypeSpecificParameter$CacheNodeTypeSpecificValues' => 'A list of cache node types and their corresponding values for this parameter.
', ], ], 'CacheNodeUpdateStatus' => [ 'base' => 'The status of the service update on the cache node
', 'refs' => [ 'CacheNodeUpdateStatusList$member' => NULL, ], ], 'CacheNodeUpdateStatusList' => [ 'base' => NULL, 'refs' => [ 'UpdateAction$CacheNodeUpdateStatus' => 'The status of the service update on the cache node
', ], ], 'CacheParameterGroup' => [ 'base' => 'Represents the output of a CreateCacheParameterGroup operation.
A cache parameter group with the requested name already exists.
', 'refs' => [], ], 'CacheParameterGroupDetails' => [ 'base' => 'Represents the output of a DescribeCacheParameters operation.
A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.
', ], ], 'CacheParameterGroupNameMessage' => [ 'base' => 'Represents the output of one of the following operations:
ModifyCacheParameterGroup
ResetCacheParameterGroup
The requested cache parameter group name does not refer to an existing cache parameter group.
', 'refs' => [], ], 'CacheParameterGroupQuotaExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the maximum number of cache security groups.
', 'refs' => [], ], 'CacheParameterGroupStatus' => [ 'base' => 'Status of the cache parameter group.
', 'refs' => [ 'CacheCluster$CacheParameterGroup' => 'Status of the cache parameter group.
', ], ], 'CacheParameterGroupsMessage' => [ 'base' => 'Represents the output of a DescribeCacheParameterGroups operation.
Represents the output of one of the following operations:
AuthorizeCacheSecurityGroupIngress
CreateCacheSecurityGroup
RevokeCacheSecurityGroupIngress
A cache security group with the specified name already exists.
', 'refs' => [], ], 'CacheSecurityGroupMembership' => [ 'base' => 'Represents a cluster\'s status within a particular cache security group.
', 'refs' => [ 'CacheSecurityGroupMembershipList$member' => NULL, ], ], 'CacheSecurityGroupMembershipList' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$CacheSecurityGroups' => 'A list of cache security group elements, composed of name and status sub-elements.
', ], ], 'CacheSecurityGroupMessage' => [ 'base' => 'Represents the output of a DescribeCacheSecurityGroups operation.
A list of security group names to associate with this cluster.
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
', 'CreateReplicationGroupMessage$CacheSecurityGroupNames' => 'A list of cache security group names to associate with this replication group.
', 'ModifyCacheClusterMessage$CacheSecurityGroupNames' => 'A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.
You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
', 'ModifyReplicationGroupMessage$CacheSecurityGroupNames' => 'A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.
This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.
The requested cache security group name does not refer to an existing cache security group.
', 'refs' => [], ], 'CacheSecurityGroupQuotaExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the allowed number of cache security groups.
', 'refs' => [], ], 'CacheSecurityGroups' => [ 'base' => NULL, 'refs' => [ 'CacheSecurityGroupMessage$CacheSecurityGroups' => 'A list of cache security groups. Each element in the list contains detailed information about one group.
', ], ], 'CacheSubnetGroup' => [ 'base' => 'Represents the output of one of the following operations:
CreateCacheSubnetGroup
ModifyCacheSubnetGroup
The requested cache subnet group name is already in use by an existing cache subnet group.
', 'refs' => [], ], 'CacheSubnetGroupInUse' => [ 'base' => 'The requested cache subnet group is currently in use.
', 'refs' => [], ], 'CacheSubnetGroupMessage' => [ 'base' => 'Represents the output of a DescribeCacheSubnetGroups operation.
The requested cache subnet group name does not refer to an existing cache subnet group.
', 'refs' => [], ], 'CacheSubnetGroupQuotaExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the allowed number of cache subnet groups.
', 'refs' => [], ], 'CacheSubnetGroups' => [ 'base' => NULL, 'refs' => [ 'CacheSubnetGroupMessage$CacheSubnetGroups' => 'A list of cache subnet groups. Each element in the list contains detailed information about one group.
', ], ], 'CacheSubnetQuotaExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.
', 'refs' => [], ], 'CacheUsageLimits' => [ 'base' => 'The usage limits for storage and ElastiCache Processing Units for the cache.
', 'refs' => [ 'CreateServerlessCacheRequest$CacheUsageLimits' => 'Sets the cache usage limits for storage and ElastiCache Processing Units for the cache.
', 'ModifyServerlessCacheRequest$CacheUsageLimits' => 'Modify the cache usage limit for the serverless cache.
', 'ServerlessCache$CacheUsageLimits' => 'The cache usage limit for the serverless cache.
', ], ], 'ChangeType' => [ 'base' => NULL, 'refs' => [ 'CacheNodeTypeSpecificParameter$ChangeType' => 'Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window\'s reboot. For more information, see Rebooting a Cluster.
', 'Parameter$ChangeType' => 'Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window\'s reboot. For more information, see Rebooting a Cluster.
', ], ], 'CloudWatchLogsDestinationDetails' => [ 'base' => 'The configuration details of the CloudWatch Logs destination.
', 'refs' => [ 'DestinationDetails$CloudWatchLogsDetails' => 'The configuration details of the CloudWatch Logs destination.
', ], ], 'ClusterIdList' => [ 'base' => NULL, 'refs' => [ 'ReplicationGroup$MemberClusters' => 'The names of all the cache clusters that are part of this replication group.
', ], ], 'ClusterMode' => [ 'base' => NULL, 'refs' => [ 'CreateReplicationGroupMessage$ClusterMode' => 'Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
', 'ModifyReplicationGroupMessage$ClusterMode' => 'Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
', 'ReplicationGroup$ClusterMode' => 'Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
', 'ReplicationGroupPendingModifiedValues$ClusterMode' => 'Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
', ], ], 'ClusterQuotaForCustomerExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the allowed number of clusters per customer.
', 'refs' => [], ], 'CompleteMigrationMessage' => [ 'base' => NULL, 'refs' => [], ], 'CompleteMigrationResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConfigureShard' => [ 'base' => 'Node group (shard) configuration options when adding or removing replicas. Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.
', 'refs' => [ 'ReplicaConfigurationList$member' => NULL, ], ], 'CopyServerlessCacheSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CopyServerlessCacheSnapshotResponse' => [ 'base' => NULL, 'refs' => [], ], 'CopySnapshotMessage' => [ 'base' => 'Represents the input of a CopySnapshotMessage operation.
Represents the input of a CreateCacheCluster operation.
', 'refs' => [], ], 'CreateCacheClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateCacheParameterGroupMessage' => [ 'base' => 'Represents the input of a CreateCacheParameterGroup operation.
Represents the input of a CreateCacheSecurityGroup operation.
Represents the input of a CreateCacheSubnetGroup operation.
Represents the input of a CreateReplicationGroup operation.
Represents the input of a CreateSnapshot operation.
The endpoint from which data should be migrated.
', 'refs' => [ 'CustomerNodeEndpointList$member' => NULL, ], ], 'CustomerNodeEndpointList' => [ 'base' => NULL, 'refs' => [ 'StartMigrationMessage$CustomerNodeEndpointList' => 'List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only one element.
', 'TestMigrationMessage$CustomerNodeEndpointList' => 'List of endpoints from which data should be migrated. List should have only one element.
', ], ], 'DataStorage' => [ 'base' => 'The data storage limit.
', 'refs' => [ 'CacheUsageLimits$DataStorage' => 'The maximum data storage limit in the cache, expressed in Gigabytes.
', ], ], 'DataStorageUnit' => [ 'base' => NULL, 'refs' => [ 'DataStorage$Unit' => 'The unit that the storage is measured in, in GB.
', ], ], 'DataTieringStatus' => [ 'base' => NULL, 'refs' => [ 'ReplicationGroup$DataTiering' => 'Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.
', 'Snapshot$DataTiering' => 'Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.
', ], ], 'DecreaseNodeGroupsInGlobalReplicationGroupMessage' => [ 'base' => NULL, 'refs' => [], ], 'DecreaseNodeGroupsInGlobalReplicationGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'DecreaseReplicaCountMessage' => [ 'base' => NULL, 'refs' => [], ], 'DecreaseReplicaCountResult' => [ 'base' => NULL, 'refs' => [], ], 'DefaultUserAssociatedToUserGroupFault' => [ 'base' => 'The default user assigned to the user group.
', 'refs' => [], ], 'DefaultUserRequired' => [ 'base' => 'You must add default user to a user group.
', 'refs' => [], ], 'DeleteCacheClusterMessage' => [ 'base' => 'Represents the input of a DeleteCacheCluster operation.
Represents the input of a DeleteCacheParameterGroup operation.
Represents the input of a DeleteCacheSecurityGroup operation.
Represents the input of a DeleteCacheSubnetGroup operation.
Represents the input of a DeleteReplicationGroup operation.
Represents the input of a DeleteSnapshot operation.
Represents the input of a DescribeCacheClusters operation.
Represents the input of a DescribeCacheEngineVersions operation.
Represents the input of a DescribeCacheParameterGroups operation.
Represents the input of a DescribeCacheParameters operation.
Represents the input of a DescribeCacheSecurityGroups operation.
Represents the input of a DescribeCacheSubnetGroups operation.
Represents the input of a DescribeEngineDefaultParameters operation.
Represents the input of a DescribeEvents operation.
Represents the input of a DescribeReplicationGroups operation.
Represents the input of a DescribeReservedCacheNodes operation.
Represents the input of a DescribeReservedCacheNodesOfferings operation.
Represents the output of a DescribeSnapshots operation.
Represents the input of a DescribeSnapshotsMessage operation.
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
', 'refs' => [ 'LogDeliveryConfiguration$DestinationDetails' => 'Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
', 'LogDeliveryConfigurationRequest$DestinationDetails' => 'Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
', 'PendingLogDeliveryConfiguration$DestinationDetails' => 'Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
', ], ], 'DestinationType' => [ 'base' => NULL, 'refs' => [ 'LogDeliveryConfiguration$DestinationType' => 'Returns the destination type, either cloudwatch-logs or kinesis-firehose.
Specify either cloudwatch-logs or kinesis-firehose as the destination type.
Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
', ], ], 'DisassociateGlobalReplicationGroupMessage' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateGlobalReplicationGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'RecurringCharge$RecurringChargeAmount' => 'The monetary amount of the recurring charge.
', 'ReservedCacheNode$FixedPrice' => 'The fixed price charged for this reserved cache node.
', 'ReservedCacheNode$UsagePrice' => 'The hourly price charged for this reserved cache node.
', 'ReservedCacheNodesOffering$FixedPrice' => 'The fixed price charged for this offering.
', 'ReservedCacheNodesOffering$UsagePrice' => 'The hourly price charged for this offering.
', 'SlotMigration$ProgressPercentage' => 'The percentage of the slot migration that is complete.
', ], ], 'DuplicateUserNameFault' => [ 'base' => 'A user with this username already exists.
', 'refs' => [], ], 'EC2SecurityGroup' => [ 'base' => 'Provides ownership and status information for an Amazon EC2 security group.
', 'refs' => [ 'EC2SecurityGroupList$member' => NULL, ], ], 'EC2SecurityGroupList' => [ 'base' => NULL, 'refs' => [ 'CacheSecurityGroup$EC2SecurityGroups' => 'A list of Amazon EC2 security groups that are associated with this cache security group.
', ], ], 'ECPUPerSecond' => [ 'base' => 'The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.
', 'refs' => [ 'CacheUsageLimits$ECPUPerSecond' => NULL, ], ], 'Endpoint' => [ 'base' => 'Represents the information required for client programs to connect to a cache node. This value is read-only.
', 'refs' => [ 'CacheCluster$ConfigurationEndpoint' => 'Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.
Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
The hostname for connecting to this cache node.
', 'NodeGroup$PrimaryEndpoint' => 'The endpoint of the primary node in this node group (shard).
', 'NodeGroup$ReaderEndpoint' => 'The endpoint of the replica nodes in this node group (shard). This value is read-only.
', 'NodeGroupMember$ReadEndpoint' => 'The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.
', 'ReplicationGroup$ConfigurationEndpoint' => 'The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
', 'ServerlessCache$Endpoint' => NULL, 'ServerlessCache$ReaderEndpoint' => NULL, ], ], 'EngineDefaults' => [ 'base' => 'Represents the output of a DescribeEngineDefaultParameters operation.
The current supported value is Redis.
', 'CreateUserMessage$Engine' => 'The current supported value is Redis.
', 'DescribeUsersMessage$Engine' => 'The Redis engine.
', 'User$Engine' => 'The current supported value is Redis.
', 'UserGroup$Engine' => 'The current supported value is Redis.
', ], ], 'Event' => [ 'base' => 'Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.
', 'refs' => [ 'EventList$member' => NULL, ], ], 'EventList' => [ 'base' => NULL, 'refs' => [ 'EventsMessage$Events' => 'A list of events. Each element in the list contains detailed information about one event.
', ], ], 'EventsMessage' => [ 'base' => 'Represents the output of a DescribeEvents operation.
Used to streamline results of a search based on the property being filtered.
', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeUsersMessage$Filters' => 'Filter to determine the list of User IDs to return.
', ], ], 'FilterName' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => 'The property being filtered. For example, UserId.
', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'FilterValueList$member' => NULL, ], ], 'FilterValueList' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => 'The property values to filter on. For example, "user-123".
', ], ], 'GlobalNodeGroup' => [ 'base' => 'Indicates the slot configuration and global identifier for a slice group.
', 'refs' => [ 'GlobalNodeGroupList$member' => NULL, ], ], 'GlobalNodeGroupIdList' => [ 'base' => NULL, 'refs' => [ 'DecreaseNodeGroupsInGlobalReplicationGroupMessage$GlobalNodeGroupsToRemove' => 'If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.
', 'DecreaseNodeGroupsInGlobalReplicationGroupMessage$GlobalNodeGroupsToRetain' => 'If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache for Redis will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster.
', ], ], 'GlobalNodeGroupList' => [ 'base' => NULL, 'refs' => [ 'GlobalReplicationGroup$GlobalNodeGroups' => 'Indicates the slot configuration and global identifier for each slice group.
', ], ], 'GlobalReplicationGroup' => [ 'base' => 'Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.
The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.
The Global datastore name already exists.
', 'refs' => [], ], 'GlobalReplicationGroupInfo' => [ 'base' => 'The name of the Global datastore and role of this replication group in the Global datastore.
', 'refs' => [ 'ReplicationGroup$GlobalReplicationGroupInfo' => 'The name of the Global datastore and role of this replication group in the Global datastore.
', ], ], 'GlobalReplicationGroupList' => [ 'base' => NULL, 'refs' => [ 'DescribeGlobalReplicationGroupsResult$GlobalReplicationGroups' => 'Indicates the slot configuration and global identifier for each slice group.
', ], ], 'GlobalReplicationGroupMember' => [ 'base' => 'A member of a Global datastore. It contains the Replication Group Id, the Amazon region and the role of the replication group.
', 'refs' => [ 'GlobalReplicationGroupMemberList$member' => NULL, ], ], 'GlobalReplicationGroupMemberList' => [ 'base' => NULL, 'refs' => [ 'GlobalReplicationGroup$Members' => 'The replication groups that comprise the Global datastore.
', ], ], 'GlobalReplicationGroupNotFoundFault' => [ 'base' => 'The Global datastore does not exist
', 'refs' => [], ], 'IncreaseNodeGroupsInGlobalReplicationGroupMessage' => [ 'base' => NULL, 'refs' => [], ], 'IncreaseNodeGroupsInGlobalReplicationGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'IncreaseReplicaCountMessage' => [ 'base' => NULL, 'refs' => [], ], 'IncreaseReplicaCountResult' => [ 'base' => NULL, 'refs' => [], ], 'InputAuthenticationType' => [ 'base' => NULL, 'refs' => [ 'AuthenticationMode$Type' => 'Specifies the authentication type. Possible options are IAM authentication, password and no password.
', ], ], 'InsufficientCacheClusterCapacityFault' => [ 'base' => 'The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
', 'refs' => [], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ConfigureShard$NewReplicaCount' => 'The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with.
The minimum number of replicas in a shard or replication group is:
Redis (cluster mode disabled)
If Multi-AZ: 1
If Multi-AZ: 0
Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
The number of node groups (shards) that results from the modification of the shard configuration
', 'Endpoint$Port' => 'The port number that the cache engine is listening on.
', 'IncreaseNodeGroupsInGlobalReplicationGroupMessage$NodeGroupCount' => 'Total number of node groups you want
', 'ModifyReplicationGroupShardConfigurationMessage$NodeGroupCount' => 'The number of node groups (shards) that results from the modification of the shard configuration.
', 'ReservedCacheNode$Duration' => 'The duration of the reservation in seconds.
', 'ReservedCacheNode$CacheNodeCount' => 'The number of cache nodes that have been reserved.
', 'ReservedCacheNodesOffering$Duration' => 'The duration of the offering. in seconds.
', ], ], 'IntegerOptional' => [ 'base' => NULL, 'refs' => [ 'Authentication$PasswordCount' => 'The number of passwords belonging to the user. The maximum is two.
', 'CacheCluster$NumCacheNodes' => 'The number of cache nodes in the cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
', 'CacheCluster$SnapshotRetentionLimit' => 'The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The initial number of cache nodes that the cluster has.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
', 'CreateCacheClusterMessage$Port' => 'The port number on which each of the cache nodes accepts connections.
', 'CreateCacheClusterMessage$SnapshotRetentionLimit' => 'The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted.
This parameter is only valid if the Engine parameter is redis.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
', 'CreateReplicationGroupMessage$NumCacheClusters' => 'The number of clusters this replication group initially has.
This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.
If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).
An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.
Default: 1
', 'CreateReplicationGroupMessage$ReplicasPerNodeGroup' => 'An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
', 'CreateReplicationGroupMessage$Port' => 'The port number on which each member of the replication group accepts connections.
', 'CreateReplicationGroupMessage$SnapshotRetentionLimit' => 'The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
Default: 0 (i.e., automatic backups are disabled for this cluster).
', 'CreateServerlessCacheRequest$SnapshotRetentionLimit' => 'The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
', 'CustomerNodeEndpoint$Port' => 'The port of the node endpoint
', 'DataStorage$Maximum' => 'The upper limit for data storage the cache is set to use.
', 'DataStorage$Minimum' => 'The lower limit for data storage the cache is set to use.
', 'DecreaseReplicaCountMessage$NewReplicaCount' => 'The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group\'s node groups.
The minimum number of replicas in a shard or replication group is:
Redis (cluster mode disabled)
If Multi-AZ is enabled: 1
If Multi-AZ is not enabled: 0
Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeCacheEngineVersionsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeCacheParameterGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeCacheParametersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeCacheSecurityGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeCacheSubnetGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeEngineDefaultParametersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeEventsMessage$Duration' => 'The number of minutes worth of events to retrieve.
', 'DescribeEventsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeGlobalReplicationGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
', 'DescribeReplicationGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeReservedCacheNodesMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeReservedCacheNodesOfferingsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeServerlessCacheSnapshotsRequest$MaxResults' => 'The maximum number of records to include in the response. If more records exist than the specified max-results value, a market is included in the response so that remaining results can be retrieved. Available for Redis only.The default is 50. The Validation Constraints are a maximum of 50.
', 'DescribeServerlessCachesRequest$MaxResults' => 'The maximum number of records in the response. If more records exist than the specified max-records value, the next token is included in the response so that remaining results can be retrieved. The default is 50.
', 'DescribeServiceUpdatesMessage$MaxRecords' => 'The maximum number of records to include in the response
', 'DescribeSnapshotsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 50
Constraints: minimum 20; maximum 50.
', 'DescribeUpdateActionsMessage$MaxRecords' => 'The maximum number of records to include in the response
', 'DescribeUserGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
', 'DescribeUsersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
', 'ECPUPerSecond$Maximum' => 'The configuration for the maximum number of ECPUs the cache can consume per second.
', 'ECPUPerSecond$Minimum' => 'The configuration for the minimum number of ECPUs the cache should be able consume per second.
', 'IncreaseReplicaCountMessage$NewReplicaCount' => 'The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group\'s node groups.
', 'ModifyCacheClusterMessage$NumCacheNodes' => 'The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).
A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer\'s latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
', 'ModifyServerlessCacheRequest$SnapshotRetentionLimit' => 'The number of days for which Elasticache retains automatic snapshots before deleting them. Available for Redis only. Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. The maximum value allowed is 35 days.
', 'NodeGroupConfiguration$ReplicaCount' => 'The number of read replica nodes in this node group (shard).
', 'PendingModifiedValues$NumCacheNodes' => 'The new number of cache nodes for the cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
', 'PurchaseReservedCacheNodesOfferingMessage$CacheNodeCount' => 'The number of cache node instances to reserve.
Default: 1
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The current setting for the number of serverless cache snapshots the system will retain. Available for Redis only.
', 'Snapshot$NumCacheNodes' => 'The number of cache nodes in the source cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
', 'Snapshot$Port' => 'The port number used by each cache nodes in the source cluster.
', 'Snapshot$SnapshotRetentionLimit' => 'For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
', 'Snapshot$NumNodeGroups' => 'The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.
', ], ], 'InvalidARNFault' => [ 'base' => 'The requested Amazon Resource Name (ARN) does not refer to an existing resource.
', 'refs' => [], ], 'InvalidCacheClusterStateFault' => [ 'base' => 'The requested cluster is not in the available state.
The current state of the cache parameter group does not allow the requested operation to occur.
', 'refs' => [], ], 'InvalidCacheSecurityGroupStateFault' => [ 'base' => 'The current state of the cache security group does not allow deletion.
', 'refs' => [], ], 'InvalidCredentialsException' => [ 'base' => 'You must enter valid credentials.
', 'refs' => [], ], 'InvalidGlobalReplicationGroupStateFault' => [ 'base' => 'The Global datastore is not available or in primary-only state.
', 'refs' => [], ], 'InvalidKMSKeyFault' => [ 'base' => 'The KMS key supplied is not valid.
', 'refs' => [], ], 'InvalidParameterCombinationException' => [ 'base' => 'Two or more incompatible parameters were specified.
', 'refs' => [], ], 'InvalidParameterValueException' => [ 'base' => 'The value for a parameter is invalid.
', 'refs' => [], ], 'InvalidReplicationGroupStateFault' => [ 'base' => 'The requested replication group is not in the available state.
The state of the serverless cache snapshot was not received. Available for Redis only.
', 'refs' => [], ], 'InvalidServerlessCacheStateFault' => [ 'base' => 'The account for these credentials is not currently active.
', 'refs' => [], ], 'InvalidSnapshotStateFault' => [ 'base' => 'The current state of the snapshot does not allow the requested operation to occur.
', 'refs' => [], ], 'InvalidSubnet' => [ 'base' => 'An invalid subnet identifier was specified.
', 'refs' => [], ], 'InvalidUserGroupStateFault' => [ 'base' => 'The user group is not in an active state.
', 'refs' => [], ], 'InvalidUserStateFault' => [ 'base' => 'The user is not in active state.
', 'refs' => [], ], 'InvalidVPCNetworkStateFault' => [ 'base' => 'The VPC network is in an invalid state.
', 'refs' => [], ], 'IpDiscovery' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$IpDiscovery' => 'The network type associated with the cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The network type you choose when creating a replication group, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
A list of TagKeys identifying the tags you want removed from the named resource.
The configuration details of the Kinesis Data Firehose destination.
', 'refs' => [ 'DestinationDetails$KinesisFirehoseDetails' => 'The configuration details of the Kinesis Data Firehose destination.
', ], ], 'ListAllowedNodeTypeModificationsMessage' => [ 'base' => 'The input parameters for the ListAllowedNodeTypeModifications operation.
The input parameters for the ListTagsForResource operation.
Returns the destination, format and type of the logs.
', 'refs' => [ 'LogDeliveryConfigurationList$member' => NULL, ], ], 'LogDeliveryConfigurationList' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$LogDeliveryConfigurations' => 'Returns the destination, format and type of the logs.
', 'ReplicationGroup$LogDeliveryConfigurations' => 'Returns the destination, format and type of the logs.
', ], ], 'LogDeliveryConfigurationRequest' => [ 'base' => 'Specifies the destination, format and type of the logs.
', 'refs' => [ 'LogDeliveryConfigurationRequestList$member' => NULL, ], ], 'LogDeliveryConfigurationRequestList' => [ 'base' => NULL, 'refs' => [ 'CreateCacheClusterMessage$LogDeliveryConfigurations' => 'Specifies the destination, format and type of the logs.
', 'CreateReplicationGroupMessage$LogDeliveryConfigurations' => 'Specifies the destination, format and type of the logs.
', 'ModifyCacheClusterMessage$LogDeliveryConfigurations' => 'Specifies the destination, format and type of the logs.
', 'ModifyReplicationGroupMessage$LogDeliveryConfigurations' => 'Specifies the destination, format and type of the logs.
', ], ], 'LogDeliveryConfigurationStatus' => [ 'base' => NULL, 'refs' => [ 'LogDeliveryConfiguration$Status' => 'Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error
Returns the log format, either JSON or TEXT.
', 'LogDeliveryConfigurationRequest$LogFormat' => 'Specifies either JSON or TEXT
', 'PendingLogDeliveryConfiguration$LogFormat' => 'Returns the log format, either JSON or TEXT
', ], ], 'LogType' => [ 'base' => NULL, 'refs' => [ 'LogDeliveryConfiguration$LogType' => 'Refers to slow-log or engine-log.
', 'LogDeliveryConfigurationRequest$LogType' => 'Refers to slow-log or engine-log..
', 'PendingLogDeliveryConfiguration$LogType' => 'Refers to slow-log or engine-log..
', ], ], 'ModifyCacheClusterMessage' => [ 'base' => 'Represents the input of a ModifyCacheCluster operation.
Represents the input of a ModifyCacheParameterGroup operation.
Represents the input of a ModifyCacheSubnetGroup operation.
Represents the input of a ModifyReplicationGroups operation.
Represents the input for a ModifyReplicationGroupShardConfiguration operation.
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
', ], ], 'NetworkType' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$NetworkType' => 'Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The operation was not performed because no changes were required.
', 'refs' => [], ], 'NodeGroup' => [ 'base' => 'Represents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
', 'refs' => [ 'NodeGroupList$member' => NULL, ], ], 'NodeGroupConfiguration' => [ 'base' => 'Node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
The configuration for the source node group (shard).
', ], ], 'NodeGroupConfigurationList' => [ 'base' => NULL, 'refs' => [ 'CreateReplicationGroupMessage$NodeGroupConfiguration' => 'A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.
If you\'re creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.
', ], ], 'NodeGroupList' => [ 'base' => NULL, 'refs' => [ 'ReplicationGroup$NodeGroups' => 'A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).
', ], ], 'NodeGroupMember' => [ 'base' => 'Represents a single node within a node group (shard).
', 'refs' => [ 'NodeGroupMemberList$member' => NULL, ], ], 'NodeGroupMemberList' => [ 'base' => NULL, 'refs' => [ 'NodeGroup$NodeGroupMembers' => 'A list containing information about individual nodes within the node group (shard).
', ], ], 'NodeGroupMemberUpdateStatus' => [ 'base' => 'The status of the service update on the node group member
', 'refs' => [ 'NodeGroupMemberUpdateStatusList$member' => NULL, ], ], 'NodeGroupMemberUpdateStatusList' => [ 'base' => NULL, 'refs' => [ 'NodeGroupUpdateStatus$NodeGroupMemberUpdateStatus' => 'The status of the service update on the node group member
', ], ], 'NodeGroupNotFoundFault' => [ 'base' => 'The node group specified by the NodeGroupId parameter could not be found. Please verify that the node group exists and that you spelled the NodeGroupId value correctly.
The status of the service update on the node group
', 'refs' => [ 'NodeGroupUpdateStatusList$member' => NULL, ], ], 'NodeGroupUpdateStatusList' => [ 'base' => NULL, 'refs' => [ 'UpdateAction$NodeGroupUpdateStatus' => 'The status of the service update on the node group
', ], ], 'NodeGroupsPerReplicationGroupQuotaExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90
', 'refs' => [], ], 'NodeGroupsToRemoveList' => [ 'base' => NULL, 'refs' => [ 'ModifyReplicationGroupShardConfigurationMessage$NodeGroupsToRemove' => 'If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.
ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.
If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.
ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.
The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.
', 'refs' => [], ], 'NodeQuotaForCustomerExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
', 'refs' => [], ], 'NodeSnapshot' => [ 'base' => 'Represents an individual cache node in a snapshot of a cluster.
', 'refs' => [ 'NodeSnapshotList$member' => NULL, ], ], 'NodeSnapshotList' => [ 'base' => NULL, 'refs' => [ 'Snapshot$NodeSnapshots' => 'A list of the cache nodes in the source cluster.
', ], ], 'NodeTypeList' => [ 'base' => NULL, 'refs' => [ 'AllowedNodeTypeModificationsMessage$ScaleUpModifications' => 'A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.
When scaling up a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
', ], ], 'NodeUpdateInitiatedBy' => [ 'base' => NULL, 'refs' => [ 'CacheNodeUpdateStatus$NodeUpdateInitiatedBy' => 'Reflects whether the update was initiated by the customer or automatically applied
', 'NodeGroupMemberUpdateStatus$NodeUpdateInitiatedBy' => 'Reflects whether the update was initiated by the customer or automatically applied
', ], ], 'NodeUpdateStatus' => [ 'base' => NULL, 'refs' => [ 'CacheNodeUpdateStatus$NodeUpdateStatus' => 'The update status of the node
', 'NodeGroupMemberUpdateStatus$NodeUpdateStatus' => 'The update status of the node
', ], ], 'NotificationConfiguration' => [ 'base' => 'Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
', 'refs' => [ 'CacheCluster$NotificationConfiguration' => 'Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
', ], ], 'OutpostArnsList' => [ 'base' => NULL, 'refs' => [ 'NodeGroupConfiguration$ReplicaOutpostArns' => 'The outpost ARN of the node replicas.
', ], ], 'OutpostMode' => [ 'base' => NULL, 'refs' => [ 'CreateCacheClusterMessage$OutpostMode' => 'Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
', ], ], 'Parameter' => [ 'base' => 'Describes an individual setting that controls some aspect of ElastiCache behavior.
', 'refs' => [ 'ParametersList$member' => NULL, ], ], 'ParameterNameValue' => [ 'base' => 'Describes a name-value pair that is used to update the value of a parameter.
', 'refs' => [ 'ParameterNameValueList$member' => NULL, ], ], 'ParameterNameValueList' => [ 'base' => NULL, 'refs' => [ 'ModifyCacheParameterGroupMessage$ParameterNameValues' => 'An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.
', 'ResetCacheParameterGroupMessage$ParameterNameValues' => 'An array of parameter names to reset to their default values. If ResetAllParameters is true, do not use ParameterNameValues. If ResetAllParameters is false, you must specify the name of at least one parameter to reset.
A list of Parameter instances.
', 'EngineDefaults$Parameters' => 'Contains a list of engine default parameters.
', ], ], 'PasswordListInput' => [ 'base' => NULL, 'refs' => [ 'AuthenticationMode$Passwords' => 'Specifies the passwords to use for authentication if Type is set to password.
Passwords used for this user. You can create up to two passwords for each user.
', 'ModifyUserMessage$Passwords' => 'The passwords belonging to the user. You are allowed up to two.
', ], ], 'PendingAutomaticFailoverStatus' => [ 'base' => NULL, 'refs' => [ 'ReplicationGroupPendingModifiedValues$AutomaticFailoverStatus' => 'Indicates the status of automatic failover for this Redis replication group.
', ], ], 'PendingLogDeliveryConfiguration' => [ 'base' => 'The log delivery configurations being modified
', 'refs' => [ 'PendingLogDeliveryConfigurationList$member' => NULL, ], ], 'PendingLogDeliveryConfigurationList' => [ 'base' => NULL, 'refs' => [ 'PendingModifiedValues$LogDeliveryConfigurations' => 'The log delivery configurations being modified
', 'ReplicationGroupPendingModifiedValues$LogDeliveryConfigurations' => 'The log delivery configurations being modified
', ], ], 'PendingModifiedValues' => [ 'base' => 'A group of settings that are applied to the cluster in the future, or that are currently being applied.
', 'refs' => [ 'CacheCluster$PendingModifiedValues' => NULL, ], ], 'PreferredAvailabilityZoneList' => [ 'base' => NULL, 'refs' => [ 'ConfigureShard$PreferredAvailabilityZones' => 'A list of PreferredAvailabilityZone strings that specify which availability zones the replication group\'s nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.
A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.
This option is only supported on Memcached.
If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of NumCacheNodes.
If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
', 'ModifyCacheClusterMessage$NewAvailabilityZones' => 'This option is only supported on Memcached clusters.
The list of Availability Zones where the new Memcached cache nodes are created.
This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.
Scenarios:
Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.
Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.
Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.
The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.
If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.
Impact of new add/remove requests upon pending requests
Scenario-1
Pending Action: Delete
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending delete.
Scenario-2
Pending Action: Delete
New Request: Create
Result: The new create, pending or immediate, replaces the pending delete.
Scenario-3
Pending Action: Create
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending create.
Scenario-4
Pending Action: Create
New Request: Create
Result: The new create is added to the pending create.
Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
The outpost ARNs in which the cache cluster is created.
', 'CreateCacheClusterMessage$PreferredOutpostArns' => 'The outpost ARNs in which the cache cluster is created.
', ], ], 'ProcessedUpdateAction' => [ 'base' => 'Update action that has been processed for the corresponding apply/stop request
', 'refs' => [ 'ProcessedUpdateActionList$member' => NULL, ], ], 'ProcessedUpdateActionList' => [ 'base' => NULL, 'refs' => [ 'UpdateActionResultsMessage$ProcessedUpdateActions' => 'Update actions that have been processed successfully
', ], ], 'PurchaseReservedCacheNodesOfferingMessage' => [ 'base' => 'Represents the input of a PurchaseReservedCacheNodesOffering operation.
Represents the input of a RebootCacheCluster operation.
Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.
', 'refs' => [ 'RecurringChargeList$member' => NULL, ], ], 'RecurringChargeList' => [ 'base' => NULL, 'refs' => [ 'ReservedCacheNode$RecurringCharges' => 'The recurring price charged to run this reserved cache node.
', 'ReservedCacheNodesOffering$RecurringCharges' => 'The recurring price charged to run this reserved cache node.
', ], ], 'RegionalConfiguration' => [ 'base' => 'A list of the replication groups
', 'refs' => [ 'RegionalConfigurationList$member' => NULL, ], ], 'RegionalConfigurationList' => [ 'base' => NULL, 'refs' => [ 'IncreaseNodeGroupsInGlobalReplicationGroupMessage$RegionalConfigurations' => 'Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore
', ], ], 'RemoveReplicasList' => [ 'base' => NULL, 'refs' => [ 'DecreaseReplicaCountMessage$ReplicasToRemove' => 'A list of the node ids to remove from the replication group or node group (shard).
', ], ], 'RemoveTagsFromResourceMessage' => [ 'base' => 'Represents the input of a RemoveTagsFromResource operation.
A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
Contains all of the attributes of a specific Redis replication group.
', 'refs' => [ 'CompleteMigrationResponse$ReplicationGroup' => NULL, 'CreateReplicationGroupResult$ReplicationGroup' => NULL, 'DecreaseReplicaCountResult$ReplicationGroup' => NULL, 'DeleteReplicationGroupResult$ReplicationGroup' => NULL, 'IncreaseReplicaCountResult$ReplicationGroup' => NULL, 'ModifyReplicationGroupResult$ReplicationGroup' => NULL, 'ModifyReplicationGroupShardConfigurationResult$ReplicationGroup' => NULL, 'ReplicationGroupList$member' => NULL, 'StartMigrationResponse$ReplicationGroup' => NULL, 'TestFailoverResult$ReplicationGroup' => NULL, 'TestMigrationResponse$ReplicationGroup' => NULL, ], ], 'ReplicationGroupAlreadyExistsFault' => [ 'base' => 'The specified replication group already exists.
', 'refs' => [], ], 'ReplicationGroupAlreadyUnderMigrationFault' => [ 'base' => 'The targeted replication group is not available.
', 'refs' => [], ], 'ReplicationGroupIdList' => [ 'base' => NULL, 'refs' => [ 'BatchApplyUpdateActionMessage$ReplicationGroupIds' => 'The replication group IDs
', 'BatchStopUpdateActionMessage$ReplicationGroupIds' => 'The replication group IDs
', 'DescribeUpdateActionsMessage$ReplicationGroupIds' => 'The replication group IDs
', ], ], 'ReplicationGroupList' => [ 'base' => NULL, 'refs' => [ 'ReplicationGroupMessage$ReplicationGroups' => 'A list of replication groups. Each item in the list contains detailed information about one replication group.
', ], ], 'ReplicationGroupMessage' => [ 'base' => 'Represents the output of a DescribeReplicationGroups operation.
The specified replication group does not exist.
', 'refs' => [], ], 'ReplicationGroupNotUnderMigrationFault' => [ 'base' => 'The designated replication group is not available for data migration.
', 'refs' => [], ], 'ReplicationGroupOutpostArnList' => [ 'base' => NULL, 'refs' => [ 'ReplicationGroup$MemberClustersOutpostArns' => 'The outpost ARNs of the replication group\'s member clusters.
', ], ], 'ReplicationGroupPendingModifiedValues' => [ 'base' => 'The settings to be applied to the Redis replication group, either immediately or during the next maintenance window.
', 'refs' => [ 'ReplicationGroup$PendingModifiedValues' => 'A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
', ], ], 'ReservedCacheNode' => [ 'base' => 'Represents the output of a PurchaseReservedCacheNodesOffering operation.
You already have a reservation with the given identifier.
', 'refs' => [], ], 'ReservedCacheNodeList' => [ 'base' => NULL, 'refs' => [ 'ReservedCacheNodeMessage$ReservedCacheNodes' => 'A list of reserved cache nodes. Each element in the list contains detailed information about one node.
', ], ], 'ReservedCacheNodeMessage' => [ 'base' => 'Represents the output of a DescribeReservedCacheNodes operation.
The requested reserved cache node was not found.
', 'refs' => [], ], 'ReservedCacheNodeQuotaExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the user\'s cache node quota.
', 'refs' => [], ], 'ReservedCacheNodesOffering' => [ 'base' => 'Describes all of the attributes of a reserved cache node offering.
', 'refs' => [ 'ReservedCacheNodesOfferingList$member' => NULL, ], ], 'ReservedCacheNodesOfferingList' => [ 'base' => NULL, 'refs' => [ 'ReservedCacheNodesOfferingMessage$ReservedCacheNodesOfferings' => 'A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.
', ], ], 'ReservedCacheNodesOfferingMessage' => [ 'base' => 'Represents the output of a DescribeReservedCacheNodesOfferings operation.
The requested cache node offering does not exist.
', 'refs' => [], ], 'ResetCacheParameterGroupMessage' => [ 'base' => 'Represents the input of a ResetCacheParameterGroup operation.
A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster\'s shards. If you omit this parameter ElastiCache selects availability zones for you.
You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).
A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
The status of an online resharding operation.
', 'refs' => [ 'ReplicationGroupPendingModifiedValues$Resharding' => 'The status of an online resharding operation.
', ], ], 'RevokeCacheSecurityGroupIngressMessage' => [ 'base' => 'Represents the input of a RevokeCacheSecurityGroupIngress operation.
One or more VPC security groups associated with the cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
', 'CreateReplicationGroupMessage$SecurityGroupIds' => 'One or more Amazon VPC security groups associated with this replication group.
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
', 'CreateServerlessCacheRequest$SecurityGroupIds' => 'A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.
', 'ModifyCacheClusterMessage$SecurityGroupIds' => 'Specifies the VPC Security Groups associated with the cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
', 'ModifyReplicationGroupMessage$SecurityGroupIds' => 'Specifies the VPC Security Groups associated with the clusters in the replication group.
This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).
', 'ModifyServerlessCacheRequest$SecurityGroupIds' => 'The new list of VPC security groups to be associated with the serverless cache. Populating this list means the current VPC security groups will be removed. This security group is used to authorize traffic access for the VPC end-point (private-link). Default = NULL - the existing list of VPC security groups is not removed.
', 'ServerlessCache$SecurityGroupIds' => 'The IDs of the EC2 security groups associated with the serverless cache.
', ], ], 'SecurityGroupMembership' => [ 'base' => 'Represents a single cache security group and its status.
', 'refs' => [ 'SecurityGroupMembershipList$member' => NULL, ], ], 'SecurityGroupMembershipList' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$SecurityGroups' => 'A list of VPC Security Groups associated with the cluster.
', ], ], 'ServerlessCache' => [ 'base' => 'The resource representing a serverless cache.
', 'refs' => [ 'CreateServerlessCacheResponse$ServerlessCache' => 'The response for the attempt to create the serverless cache.
', 'DeleteServerlessCacheResponse$ServerlessCache' => 'Provides the details of the specified serverless cache that is about to be deleted.
', 'ModifyServerlessCacheResponse$ServerlessCache' => 'The response for the attempt to modify the serverless cache.
', 'ServerlessCacheList$member' => NULL, ], ], 'ServerlessCacheAlreadyExistsFault' => [ 'base' => 'A serverless cache with this name already exists.
', 'refs' => [], ], 'ServerlessCacheConfiguration' => [ 'base' => 'The configuration settings for a specific serverless cache.
', 'refs' => [ 'ServerlessCacheSnapshot$ServerlessCacheConfiguration' => 'The configuration of the serverless cache, at the time the snapshot was taken. Available for Redis only.
', ], ], 'ServerlessCacheList' => [ 'base' => NULL, 'refs' => [ 'DescribeServerlessCachesResponse$ServerlessCaches' => 'The serverless caches associated with a given description request.
', ], ], 'ServerlessCacheNotFoundFault' => [ 'base' => 'The serverless cache was not found or does not exist.
', 'refs' => [], ], 'ServerlessCacheQuotaForCustomerExceededFault' => [ 'base' => 'The number of serverless caches exceeds the customer quota.
', 'refs' => [], ], 'ServerlessCacheSnapshot' => [ 'base' => 'The resource representing a serverless cache snapshot. Available for Redis only.
', 'refs' => [ 'CopyServerlessCacheSnapshotResponse$ServerlessCacheSnapshot' => 'The response for the attempt to copy the serverless cache snapshot. Available for Redis only.
', 'CreateServerlessCacheSnapshotResponse$ServerlessCacheSnapshot' => 'The state of a serverless cache snapshot at a specific point in time, to the millisecond. Available for Redis only.
', 'DeleteServerlessCacheSnapshotResponse$ServerlessCacheSnapshot' => 'The snapshot to be deleted. Available for Redis only.
', 'ExportServerlessCacheSnapshotResponse$ServerlessCacheSnapshot' => 'The state of a serverless cache at a specific point in time, to the millisecond. Available for Redis only.
', 'ServerlessCacheSnapshotList$member' => NULL, ], ], 'ServerlessCacheSnapshotAlreadyExistsFault' => [ 'base' => 'A serverless cache snapshot with this name already exists. Available for Redis only.
', 'refs' => [], ], 'ServerlessCacheSnapshotList' => [ 'base' => NULL, 'refs' => [ 'DescribeServerlessCacheSnapshotsResponse$ServerlessCacheSnapshots' => 'The serverless caches snapshots associated with a given description request. Available for Redis only.
', ], ], 'ServerlessCacheSnapshotNotFoundFault' => [ 'base' => 'This serverless cache snapshot could not be found or does not exist. Available for Redis only.
', 'refs' => [], ], 'ServerlessCacheSnapshotQuotaExceededFault' => [ 'base' => 'The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis only.
', 'refs' => [], ], 'ServiceLinkedRoleNotFoundFault' => [ 'base' => 'The specified service linked role (SLR) was not found.
', 'refs' => [], ], 'ServiceUpdate' => [ 'base' => 'An update that you can apply to your Redis clusters.
', 'refs' => [ 'ServiceUpdateList$member' => NULL, ], ], 'ServiceUpdateList' => [ 'base' => NULL, 'refs' => [ 'ServiceUpdatesMessage$ServiceUpdates' => 'A list of service updates
', ], ], 'ServiceUpdateNotFoundFault' => [ 'base' => 'The service update doesn\'t exist
', 'refs' => [], ], 'ServiceUpdateSeverity' => [ 'base' => NULL, 'refs' => [ 'ServiceUpdate$ServiceUpdateSeverity' => 'The severity of the service update
', 'UpdateAction$ServiceUpdateSeverity' => 'The severity of the service update
', ], ], 'ServiceUpdateStatus' => [ 'base' => NULL, 'refs' => [ 'ServiceUpdate$ServiceUpdateStatus' => 'The status of the service update
', 'ServiceUpdateStatusList$member' => NULL, 'UpdateAction$ServiceUpdateStatus' => 'The status of the service update
', ], ], 'ServiceUpdateStatusList' => [ 'base' => NULL, 'refs' => [ 'DescribeServiceUpdatesMessage$ServiceUpdateStatus' => 'The status of the service update
', 'DescribeUpdateActionsMessage$ServiceUpdateStatus' => 'The status of the service update
', ], ], 'ServiceUpdateType' => [ 'base' => NULL, 'refs' => [ 'ServiceUpdate$ServiceUpdateType' => 'Reflects the nature of the service update
', 'UpdateAction$ServiceUpdateType' => 'Reflects the nature of the service update
', ], ], 'ServiceUpdatesMessage' => [ 'base' => NULL, 'refs' => [], ], 'SlaMet' => [ 'base' => NULL, 'refs' => [ 'UpdateAction$SlaMet' => 'If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the recommended apply-by date.
', ], ], 'SlotMigration' => [ 'base' => 'Represents the progress of an online resharding operation.
', 'refs' => [ 'ReshardingStatus$SlotMigration' => 'Represents the progress of an online resharding operation.
', ], ], 'Snapshot' => [ 'base' => 'Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
', 'refs' => [ 'CopySnapshotResult$Snapshot' => NULL, 'CreateSnapshotResult$Snapshot' => NULL, 'DeleteSnapshotResult$Snapshot' => NULL, 'SnapshotList$member' => NULL, ], ], 'SnapshotAlreadyExistsFault' => [ 'base' => 'You already have a snapshot with the given name.
', 'refs' => [], ], 'SnapshotArnsList' => [ 'base' => NULL, 'refs' => [ 'CreateCacheClusterMessage$SnapshotArns' => 'A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.
This parameter is only valid if the Engine parameter is redis.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
', ], ], 'SnapshotFeatureNotSupportedFault' => [ 'base' => 'You attempted one of the following operations:
Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
', 'refs' => [], ], 'SnapshotList' => [ 'base' => NULL, 'refs' => [ 'DescribeSnapshotsListMessage$Snapshots' => 'A list of snapshots. Each item in the list contains detailed information about one snapshot.
', ], ], 'SnapshotNotFoundFault' => [ 'base' => 'The requested snapshot name does not refer to an existing snapshot.
', 'refs' => [], ], 'SnapshotQuotaExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the maximum number of snapshots.
', 'refs' => [], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'DescribeEventsMessage$SourceType' => 'The event source to retrieve events for. If no value is specified, all events are returned.
', 'Event$SourceType' => 'Specifies the origin of this event - a cluster, a parameter group, a security group, etc.
', ], ], 'StartMigrationMessage' => [ 'base' => NULL, 'refs' => [], ], 'StartMigrationResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AddTagsToResourceMessage$ResourceName' => 'The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache resources are cluster and snapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.
', 'AuthorizeCacheSecurityGroupIngressMessage$CacheSecurityGroupName' => 'The cache security group that allows network ingress.
', 'AuthorizeCacheSecurityGroupIngressMessage$EC2SecurityGroupName' => 'The Amazon EC2 security group to be authorized for ingress to the cache security group.
', 'AuthorizeCacheSecurityGroupIngressMessage$EC2SecurityGroupOwnerId' => 'The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter.
', 'AvailabilityZone$Name' => 'The name of the Availability Zone.
', 'AvailabilityZonesList$member' => NULL, 'BatchApplyUpdateActionMessage$ServiceUpdateName' => 'The unique ID of the service update
', 'BatchStopUpdateActionMessage$ServiceUpdateName' => 'The unique ID of the service update
', 'CacheCluster$CacheClusterId' => 'The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
', 'CacheCluster$ClientDownloadLandingPage' => 'The URL of the web page where you can download the latest ElastiCache client library.
', 'CacheCluster$CacheNodeType' => 'The name of the compute and memory capacity node type for the cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
The name of the cache engine (memcached or redis) to be used for this cluster.
The version of the cache engine that is used in this cluster.
', 'CacheCluster$CacheClusterStatus' => 'The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.
The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
', 'CacheCluster$PreferredOutpostArn' => 'The outpost ARN in which the cache cluster is created.
', 'CacheCluster$PreferredMaintenanceWindow' => 'Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
The name of the cache subnet group associated with the cluster.
', 'CacheCluster$ReplicationGroupId' => 'The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.
', 'CacheCluster$SnapshotWindow' => 'The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
Example: 05:00-09:00
The ARN (Amazon Resource Name) of the cache cluster.
', 'CacheClusterIdList$member' => NULL, 'CacheClusterMessage$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'CacheEngineVersion$Engine' => 'The name of the cache engine.
', 'CacheEngineVersion$EngineVersion' => 'The version number of the cache engine.
', 'CacheEngineVersion$CacheParameterGroupFamily' => 'The name of the cache parameter group family associated with this cache engine.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7
The description of the cache engine.
', 'CacheEngineVersion$CacheEngineVersionDescription' => 'The description of the cache engine version.
', 'CacheEngineVersionMessage$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'CacheNode$CacheNodeId' => 'The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer\'s Amazon account.
', 'CacheNode$CacheNodeStatus' => 'The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.
The status of the parameter group applied to this cache node.
', 'CacheNode$SourceCacheNodeId' => 'The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.
', 'CacheNode$CustomerAvailabilityZone' => 'The Availability Zone where this node was created and now resides.
', 'CacheNode$CustomerOutpostArn' => 'The customer outpost ARN of the cache node.
', 'CacheNodeIdsList$member' => NULL, 'CacheNodeTypeSpecificParameter$ParameterName' => 'The name of the parameter.
', 'CacheNodeTypeSpecificParameter$Description' => 'A description of the parameter.
', 'CacheNodeTypeSpecificParameter$Source' => 'The source of the parameter value.
', 'CacheNodeTypeSpecificParameter$DataType' => 'The valid data type for the parameter.
', 'CacheNodeTypeSpecificParameter$AllowedValues' => 'The valid range of values for the parameter.
', 'CacheNodeTypeSpecificParameter$MinimumEngineVersion' => 'The earliest cache engine version to which the parameter can apply.
', 'CacheNodeTypeSpecificValue$CacheNodeType' => 'The cache node type for which this value applies.
', 'CacheNodeTypeSpecificValue$Value' => 'The value for the cache node type.
', 'CacheNodeUpdateStatus$CacheNodeId' => 'The node ID of the cache cluster
', 'CacheParameterGroup$CacheParameterGroupName' => 'The name of the cache parameter group.
', 'CacheParameterGroup$CacheParameterGroupFamily' => 'The name of the cache parameter group family that this cache parameter group is compatible with.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7
The description for this cache parameter group.
', 'CacheParameterGroup$ARN' => 'The ARN (Amazon Resource Name) of the cache parameter group.
', 'CacheParameterGroupDetails$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'CacheParameterGroupNameMessage$CacheParameterGroupName' => 'The name of the cache parameter group.
', 'CacheParameterGroupStatus$CacheParameterGroupName' => 'The name of the cache parameter group.
', 'CacheParameterGroupStatus$ParameterApplyStatus' => 'The status of parameter updates.
', 'CacheParameterGroupsMessage$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'CacheSecurityGroup$OwnerId' => 'The Amazon account ID of the cache security group owner.
', 'CacheSecurityGroup$CacheSecurityGroupName' => 'The name of the cache security group.
', 'CacheSecurityGroup$Description' => 'The description of the cache security group.
', 'CacheSecurityGroup$ARN' => 'The ARN of the cache security group,
', 'CacheSecurityGroupMembership$CacheSecurityGroupName' => 'The name of the cache security group.
', 'CacheSecurityGroupMembership$Status' => 'The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cluster are modified.
', 'CacheSecurityGroupMessage$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'CacheSecurityGroupNameList$member' => NULL, 'CacheSubnetGroup$CacheSubnetGroupName' => 'The name of the cache subnet group.
', 'CacheSubnetGroup$CacheSubnetGroupDescription' => 'The description of the cache subnet group.
', 'CacheSubnetGroup$VpcId' => 'The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
', 'CacheSubnetGroup$ARN' => 'The ARN (Amazon Resource Name) of the cache subnet group.
', 'CacheSubnetGroupMessage$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'CloudWatchLogsDestinationDetails$LogGroup' => 'The name of the CloudWatch Logs log group.
', 'ClusterIdList$member' => NULL, 'CompleteMigrationMessage$ReplicationGroupId' => 'The ID of the replication group to which data is being migrated.
', 'CopyServerlessCacheSnapshotRequest$SourceServerlessCacheSnapshotName' => 'The identifier of the existing serverless cache’s snapshot to be copied. Available for Redis only.
', 'CopyServerlessCacheSnapshotRequest$TargetServerlessCacheSnapshotName' => 'The identifier for the snapshot to be created. Available for Redis only.
', 'CopyServerlessCacheSnapshotRequest$KmsKeyId' => 'The identifier of the KMS key used to encrypt the target snapshot. Available for Redis only.
', 'CopySnapshotMessage$SourceSnapshotName' => 'The name of an existing snapshot from which to make a copy.
', 'CopySnapshotMessage$TargetSnapshotName' => 'A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
', 'CopySnapshotMessage$TargetBucket' => 'The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.
When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.
For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.
', 'CopySnapshotMessage$KmsKeyId' => 'The ID of the KMS key used to encrypt the target snapshot.
', 'CreateCacheClusterMessage$CacheClusterId' => 'The node group (shard) identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 50 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.
The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.
If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.
This parameter is only valid if the Engine parameter is redis.
The EC2 Availability Zone in which the cluster is created.
All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.
Default: System chosen Availability Zone.
', 'CreateCacheClusterMessage$CacheNodeType' => 'The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
The name of the cache engine to be used for this cluster.
Valid values for this parameter are: memcached | redis
The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
', 'CreateCacheClusterMessage$CacheParameterGroupName' => 'The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled=\'yes\' when creating a cluster.
The name of the subnet group to be used for the cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
If you\'re going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.
This parameter is only valid if the Engine parameter is redis.
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
', 'CreateCacheClusterMessage$NotificationTopicArn' => 'The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
The Amazon SNS topic owner must be the same as the cluster owner.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
This parameter is only valid if the Engine parameter is redis.
Reserved parameter. The password used to access a password protected server.
Password constraints:
Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password at http://redis.io/commands/AUTH.
', 'CreateCacheClusterMessage$PreferredOutpostArn' => 'The outpost ARN in which the cache cluster is created.
', 'CreateCacheParameterGroupMessage$CacheParameterGroupName' => 'A user-specified name for the cache parameter group.
', 'CreateCacheParameterGroupMessage$CacheParameterGroupFamily' => 'The name of the cache parameter group family that the cache parameter group can be used with.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7
A user-specified description for the cache parameter group.
', 'CreateCacheSecurityGroupMessage$CacheSecurityGroupName' => 'A name for the cache security group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default".
Example: mysecuritygroup
A description for the cache security group.
', 'CreateCacheSubnetGroupMessage$CacheSubnetGroupName' => 'A name for the cache subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
A description for the cache subnet group.
', 'CreateGlobalReplicationGroupMessage$GlobalReplicationGroupIdSuffix' => 'The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with "dsdfu" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions.
For a full list of Amazon Regions and their respective Global datastore iD prefixes, see Using the Amazon CLI with Global datastores .
', 'CreateGlobalReplicationGroupMessage$GlobalReplicationGroupDescription' => 'Provides details of the Global datastore
', 'CreateGlobalReplicationGroupMessage$PrimaryReplicationGroupId' => 'The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
', 'CreateReplicationGroupMessage$ReplicationGroupId' => 'The replication group identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 40 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.
A user-created description for the replication group.
', 'CreateReplicationGroupMessage$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'CreateReplicationGroupMessage$PrimaryClusterId' => 'The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.
This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.
The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
The name of the cache engine to be used for the clusters in this replication group. The value must be set to Redis.
The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
', 'CreateReplicationGroupMessage$CacheParameterGroupName' => 'The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.
To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.
To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.
The name of the cache subnet group to be used for the replication group.
If you\'re going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
The Amazon SNS topic owner must be the same as the cluster owner.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
', 'CreateReplicationGroupMessage$AuthToken' => 'Reserved parameter. The password used to access a password protected server.
AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.
For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.
Password constraints:
Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password at http://redis.io/commands/AUTH.
', 'CreateReplicationGroupMessage$KmsKeyId' => 'The ID of the KMS key used to encrypt the disk in the cluster.
', 'CreateReplicationGroupMessage$ServerlessCacheSnapshotName' => 'The name of the snapshot used to create a replication group. Available for Redis only.
', 'CreateServerlessCacheRequest$ServerlessCacheName' => 'User-provided identifier for the serverless cache. This parameter is stored as a lowercase string.
', 'CreateServerlessCacheRequest$Description' => 'User-provided description for the serverless cache. The default is NULL, i.e. if no description is provided then an empty string will be returned. The maximum length is 255 characters.
', 'CreateServerlessCacheRequest$Engine' => 'The name of the cache engine to be used for creating the serverless cache.
', 'CreateServerlessCacheRequest$MajorEngineVersion' => 'The version of the cache engine that will be used to create the serverless cache.
', 'CreateServerlessCacheRequest$KmsKeyId' => 'ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
', 'CreateServerlessCacheRequest$UserGroupId' => 'The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.
', 'CreateServerlessCacheRequest$DailySnapshotTime' => 'The daily time that snapshots will be created from the new serverless cache. By default this number is populated with 0, i.e. no snapshots will be created on an automatic daily basis. Available for Redis only.
', 'CreateServerlessCacheSnapshotRequest$ServerlessCacheSnapshotName' => 'The name for the snapshot being created. Must be unique for the customer account. Available for Redis only. Must be between 1 and 255 characters.
', 'CreateServerlessCacheSnapshotRequest$ServerlessCacheName' => 'The name of an existing serverless cache. The snapshot is created from this cache. Available for Redis only.
', 'CreateServerlessCacheSnapshotRequest$KmsKeyId' => 'The ID of the KMS key used to encrypt the snapshot. Available for Redis only. Default: NULL
', 'CreateSnapshotMessage$ReplicationGroupId' => 'The identifier of an existing replication group. The snapshot is created from this replication group.
', 'CreateSnapshotMessage$CacheClusterId' => 'The identifier of an existing cluster. The snapshot is created from this cluster.
', 'CreateSnapshotMessage$SnapshotName' => 'A name for the snapshot being created.
', 'CreateSnapshotMessage$KmsKeyId' => 'The ID of the KMS key used to encrypt the snapshot.
', 'CreateUserGroupMessage$UserGroupId' => 'The ID of the user group.
', 'CustomerNodeEndpoint$Address' => 'The address of the node endpoint
', 'DecreaseNodeGroupsInGlobalReplicationGroupMessage$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'DecreaseReplicaCountMessage$ReplicationGroupId' => 'The id of the replication group from which you want to remove replica nodes.
', 'DeleteCacheClusterMessage$CacheClusterId' => 'The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.
', 'DeleteCacheClusterMessage$FinalSnapshotIdentifier' => 'The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.
', 'DeleteCacheParameterGroupMessage$CacheParameterGroupName' => 'The name of the cache parameter group to delete.
The specified cache security group must not be associated with any clusters.
The name of the cache security group to delete.
You cannot delete the default security group.
The name of the cache subnet group to delete.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
', 'DeleteGlobalReplicationGroupMessage$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'DeleteReplicationGroupMessage$ReplicationGroupId' => 'The identifier for the cluster to be deleted. This parameter is not case sensitive.
', 'DeleteReplicationGroupMessage$FinalSnapshotIdentifier' => 'The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.
', 'DeleteServerlessCacheRequest$ServerlessCacheName' => 'The identifier of the serverless cache to be deleted.
', 'DeleteServerlessCacheRequest$FinalSnapshotName' => 'Name of the final snapshot to be taken before the serverless cache is deleted. Available for Redis only. Default: NULL, i.e. a final snapshot is not taken.
', 'DeleteServerlessCacheSnapshotRequest$ServerlessCacheSnapshotName' => 'Idenfitier of the snapshot to be deleted. Available for Redis only.
', 'DeleteSnapshotMessage$SnapshotName' => 'The name of the snapshot to be deleted.
', 'DeleteUserGroupMessage$UserGroupId' => 'The ID of the user group.
', 'DescribeCacheClustersMessage$CacheClusterId' => 'The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn\'t case sensitive.
', 'DescribeCacheClustersMessage$Marker' => '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.
The cache engine to return. Valid values: memcached | redis
The cache engine version to return.
Example: 1.4.14
The name of a specific cache parameter group family to return details for.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
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.
The name of a specific cache parameter group to return details for.
', 'DescribeCacheParameterGroupsMessage$Marker' => '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.
The name of a specific cache parameter group to return details for.
', 'DescribeCacheParametersMessage$Source' => 'The parameter types to return.
Valid values: user | system | engine-default
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.
The name of the cache security group to return details for.
', 'DescribeCacheSecurityGroupsMessage$Marker' => '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.
The name of the cache subnet group to return details for.
', 'DescribeCacheSubnetGroupsMessage$Marker' => '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.
The name of the cache parameter group family.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7
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.
The identifier of the event source for which events are returned. If not specified, all sources are included in the response.
', 'DescribeEventsMessage$Marker' => '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.
The name of the Global datastore
', 'DescribeGlobalReplicationGroupsMessage$Marker' => '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.
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. >
', 'DescribeReplicationGroupsMessage$ReplicationGroupId' => 'The identifier for the replication group to be described. This parameter is not case sensitive.
If you do not specify this parameter, information about all replication groups is returned.
', 'DescribeReplicationGroupsMessage$Marker' => '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.
The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
', 'DescribeReservedCacheNodesMessage$ReservedCacheNodesOfferingId' => 'The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.
', 'DescribeReservedCacheNodesMessage$CacheNodeType' => 'The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Use this parameter to show only those reservations matching the specified product description.
', 'DescribeReservedCacheNodesMessage$OfferingType' => 'The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.
Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"
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.
The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Use this parameter to show only the available offerings matching the specified product description.
', 'DescribeReservedCacheNodesOfferingsMessage$OfferingType' => 'The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization" |"All Upfront"|"Partial Upfront"| "No Upfront"
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.
The identifier of serverless cache. If this parameter is specified, only snapshots associated with that specific serverless cache are described. Available for Redis only.
', 'DescribeServerlessCacheSnapshotsRequest$ServerlessCacheSnapshotName' => 'The identifier of the serverless cache’s snapshot. If this parameter is specified, only this snapshot is described. Available for Redis only.
', 'DescribeServerlessCacheSnapshotsRequest$SnapshotType' => 'The type of snapshot that is being described. Available for Redis only.
', 'DescribeServerlessCacheSnapshotsRequest$NextToken' => 'An optional marker returned from a prior request to support 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 max-results. Available for Redis only.
', 'DescribeServerlessCacheSnapshotsResponse$NextToken' => 'An optional marker returned from a prior request to support 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 max-results. Available for Redis only.
', 'DescribeServerlessCachesRequest$ServerlessCacheName' => 'The identifier for the serverless cache. If this parameter is specified, only information about that specific serverless cache is returned. Default: NULL
', 'DescribeServerlessCachesRequest$NextToken' => 'An optional marker returned from a prior request to support 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 MaxResults.
', 'DescribeServerlessCachesResponse$NextToken' => 'An optional marker returned from a prior request to support 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 MaxResults.
', 'DescribeServiceUpdatesMessage$ServiceUpdateName' => 'The unique ID of the service update
', 'DescribeServiceUpdatesMessage$Marker' => '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.
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.
A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.
', 'DescribeSnapshotsMessage$CacheClusterId' => 'A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
', 'DescribeSnapshotsMessage$SnapshotName' => 'A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
', 'DescribeSnapshotsMessage$SnapshotSource' => 'If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
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.
The unique ID of the service update
', 'DescribeUpdateActionsMessage$Engine' => 'The Elasticache engine to which the update applies. Either Redis or Memcached
', 'DescribeUpdateActionsMessage$Marker' => '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.
The ID of the user group.
', 'DescribeUserGroupsMessage$Marker' => '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. >
', 'DescribeUserGroupsResult$Marker' => '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. >
', 'DescribeUsersMessage$Marker' => '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. >
', 'DescribeUsersResult$Marker' => '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. >
', 'DisassociateGlobalReplicationGroupMessage$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'DisassociateGlobalReplicationGroupMessage$ReplicationGroupId' => 'The name of the secondary cluster you wish to remove from the Global datastore
', 'DisassociateGlobalReplicationGroupMessage$ReplicationGroupRegion' => 'The Amazon region of secondary cluster you wish to remove from the Global datastore
', 'EC2SecurityGroup$Status' => 'The status of the Amazon EC2 security group.
', 'EC2SecurityGroup$EC2SecurityGroupName' => 'The name of the Amazon EC2 security group.
', 'EC2SecurityGroup$EC2SecurityGroupOwnerId' => 'The Amazon account ID of the Amazon EC2 security group owner.
', 'Endpoint$Address' => 'The DNS hostname of the cache node.
', 'EngineDefaults$CacheParameterGroupFamily' => 'Specifies the name of the cache parameter group family to which the engine default parameters apply.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.0 | redis6.x | redis7
Provides an identifier to allow retrieval of paginated results.
', 'Event$SourceIdentifier' => 'The identifier for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.
', 'Event$Message' => 'The text of the event.
', 'EventsMessage$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'ExportServerlessCacheSnapshotRequest$ServerlessCacheSnapshotName' => 'The identifier of the serverless cache snapshot to be exported to S3. Available for Redis only.
', 'ExportServerlessCacheSnapshotRequest$S3BucketName' => 'Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3 bucket must also be in same region as the snapshot. Available for Redis only.
', 'FailoverGlobalReplicationGroupMessage$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'FailoverGlobalReplicationGroupMessage$PrimaryRegion' => 'The Amazon region of the primary cluster of the Global datastore
', 'FailoverGlobalReplicationGroupMessage$PrimaryReplicationGroupId' => 'The name of the primary replication group
', 'GlobalNodeGroup$GlobalNodeGroupId' => 'The name of the global node group
', 'GlobalNodeGroup$Slots' => 'The keyspace for this node group
', 'GlobalNodeGroupIdList$member' => NULL, 'GlobalReplicationGroup$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'GlobalReplicationGroup$GlobalReplicationGroupDescription' => 'The optional description of the Global datastore
', 'GlobalReplicationGroup$Status' => 'The status of the Global datastore
', 'GlobalReplicationGroup$CacheNodeType' => 'The cache node type of the Global datastore
', 'GlobalReplicationGroup$Engine' => 'The Elasticache engine. For Redis only.
', 'GlobalReplicationGroup$EngineVersion' => 'The Elasticache Redis engine version.
', 'GlobalReplicationGroup$ARN' => 'The ARN (Amazon Resource Name) of the global replication group.
', 'GlobalReplicationGroupInfo$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'GlobalReplicationGroupInfo$GlobalReplicationGroupMemberRole' => 'The role of the replication group in a Global datastore. Can be primary or secondary.
', 'GlobalReplicationGroupMember$ReplicationGroupId' => 'The replication group id of the Global datastore member.
', 'GlobalReplicationGroupMember$ReplicationGroupRegion' => 'The Amazon region of the Global datastore member.
', 'GlobalReplicationGroupMember$Role' => 'Indicates the role of the replication group, primary or secondary.
', 'GlobalReplicationGroupMember$Status' => 'The status of the membership of the replication group.
', 'IncreaseNodeGroupsInGlobalReplicationGroupMessage$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'IncreaseReplicaCountMessage$ReplicationGroupId' => 'The id of the replication group to which you want to add replica nodes.
', 'KeyList$member' => NULL, 'KinesisFirehoseDestinationDetails$DeliveryStream' => 'The name of the Kinesis Data Firehose delivery stream.
', 'ListAllowedNodeTypeModificationsMessage$CacheClusterId' => 'The name of the cluster you want to scale up to a larger node instanced type. ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.
You must provide a value for either the CacheClusterId or the ReplicationGroupId.
The name of the replication group want to scale up to a larger node type. ElastiCache uses the replication group id to identify the current node type being used by this replication group, and from that to create a list of node types you can scale up to.
You must provide a value for either the CacheClusterId or the ReplicationGroupId.
The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
', 'LogDeliveryConfiguration$Message' => 'Returns an error message for the log delivery configuration.
', 'ModifyCacheClusterMessage$CacheClusterId' => 'The cluster identifier. This value is stored as a lowercase string.
', 'ModifyCacheClusterMessage$PreferredMaintenanceWindow' => 'Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
The Amazon SNS topic owner must be same as the cluster owner.
The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.
Valid values: active | inactive
The upgraded version of the cache engine to be run on the cache nodes.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
', 'ModifyCacheClusterMessage$SnapshotWindow' => 'The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
', 'ModifyCacheClusterMessage$CacheNodeType' => 'A valid cache node type that you want to scale this cluster up to.
', 'ModifyCacheClusterMessage$AuthToken' => 'Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints:
Must be only printable ASCII characters
Must be at least 16 characters and no more than 128 characters in length
Cannot contain any of the following characters: \'/\', \'"\', or \'@\', \'%\'
For more information, see AUTH password at AUTH.
', 'ModifyCacheParameterGroupMessage$CacheParameterGroupName' => 'The name of the cache parameter group to modify.
', 'ModifyCacheSubnetGroupMessage$CacheSubnetGroupName' => 'The name for the cache subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
A description of the cache subnet group.
', 'ModifyGlobalReplicationGroupMessage$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'ModifyGlobalReplicationGroupMessage$CacheNodeType' => 'A valid cache node type that you want to scale this Global datastore to.
', 'ModifyGlobalReplicationGroupMessage$EngineVersion' => 'The upgraded version of the cache engine to be run on the clusters in the Global datastore.
', 'ModifyGlobalReplicationGroupMessage$CacheParameterGroupName' => 'The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.
', 'ModifyGlobalReplicationGroupMessage$GlobalReplicationGroupDescription' => 'A description of the Global datastore
', 'ModifyReplicationGroupMessage$ReplicationGroupId' => 'The identifier of the replication group to modify.
', 'ModifyReplicationGroupMessage$ReplicationGroupDescription' => 'A description for the replication group. Maximum length is 255 characters.
', 'ModifyReplicationGroupMessage$PrimaryClusterId' => 'For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.
', 'ModifyReplicationGroupMessage$SnapshottingClusterId' => 'The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.
', 'ModifyReplicationGroupMessage$NodeGroupId' => 'Deprecated. This parameter is not used.
', 'ModifyReplicationGroupMessage$PreferredMaintenanceWindow' => 'Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
The Amazon SNS topic owner must be same as the replication group owner.
The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.
Valid values: active | inactive
The upgraded version of the cache engine to be run on the clusters in the replication group.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.
', 'ModifyReplicationGroupMessage$SnapshotWindow' => 'The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
', 'ModifyReplicationGroupMessage$CacheNodeType' => 'A valid cache node type that you want to scale this replication group to.
', 'ModifyReplicationGroupMessage$AuthToken' => 'Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy parameter. Password constraints:
Must be only printable ASCII characters
Must be at least 16 characters and no more than 128 characters in length
Cannot contain any of the following characters: \'/\', \'"\', or \'@\', \'%\'
For more information, see AUTH password at AUTH.
', 'ModifyReplicationGroupShardConfigurationMessage$ReplicationGroupId' => 'The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
', 'ModifyServerlessCacheRequest$ServerlessCacheName' => 'User-provided identifier for the serverless cache to be modified.
', 'ModifyServerlessCacheRequest$Description' => 'User provided description for the serverless cache. Default = NULL, i.e. the existing description is not removed/modified. The description has a maximum length of 255 characters.
', 'ModifyServerlessCacheRequest$UserGroupId' => 'The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL - the existing UserGroup is not removed.
', 'ModifyServerlessCacheRequest$DailySnapshotTime' => 'The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Redis only. The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.
', 'ModifyUserGroupMessage$UserGroupId' => 'The ID of the user group.
', 'NodeGroup$NodeGroupId' => 'The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.
', 'NodeGroup$Status' => 'The current state of this replication group - creating, available, modifying, deleting.
The keyspace for this node group (shard).
', 'NodeGroupConfiguration$Slots' => 'A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.
Example: "0-3999"
The Availability Zone where the primary node of this node group (shard) is launched.
', 'NodeGroupConfiguration$PrimaryOutpostArn' => 'The outpost ARN of the primary node.
', 'NodeGroupMember$CacheClusterId' => 'The ID of the cluster to which the node belongs.
', 'NodeGroupMember$CacheNodeId' => 'The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
', 'NodeGroupMember$PreferredAvailabilityZone' => 'The name of the Availability Zone in which the node is located.
', 'NodeGroupMember$PreferredOutpostArn' => 'The outpost ARN of the node group member.
', 'NodeGroupMember$CurrentRole' => 'The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.
The cache cluster ID
', 'NodeGroupMemberUpdateStatus$CacheNodeId' => 'The node ID of the cache cluster
', 'NodeGroupUpdateStatus$NodeGroupId' => 'The ID of the node group
', 'NodeSnapshot$CacheClusterId' => 'A unique identifier for the source cluster.
', 'NodeSnapshot$NodeGroupId' => 'A unique identifier for the source node group (shard).
', 'NodeSnapshot$CacheNodeId' => 'The cache node identifier for the node in the source cluster.
', 'NodeSnapshot$CacheSize' => 'The size of the cache on the source cache node.
', 'NodeTypeList$member' => NULL, 'NotificationConfiguration$TopicArn' => 'The Amazon Resource Name (ARN) that identifies the topic.
', 'NotificationConfiguration$TopicStatus' => 'The current state of the topic.
', 'OutpostArnsList$member' => NULL, 'Parameter$ParameterName' => 'The name of the parameter.
', 'Parameter$ParameterValue' => 'The value of the parameter.
', 'Parameter$Description' => 'A description of the parameter.
', 'Parameter$Source' => 'The source of the parameter.
', 'Parameter$DataType' => 'The valid data type for the parameter.
', 'Parameter$AllowedValues' => 'The valid range of values for the parameter.
', 'Parameter$MinimumEngineVersion' => 'The earliest cache engine version to which the parameter can apply.
', 'ParameterNameValue$ParameterName' => 'The name of the parameter.
', 'ParameterNameValue$ParameterValue' => 'The value of the parameter.
', 'PasswordListInput$member' => NULL, 'PendingModifiedValues$EngineVersion' => 'The new cache engine version that the cluster runs.
', 'PendingModifiedValues$CacheNodeType' => 'The cache node type that this cluster or replication group is scaled to.
', 'PreferredAvailabilityZoneList$member' => NULL, 'PreferredOutpostArnList$member' => NULL, 'ProcessedUpdateAction$ReplicationGroupId' => 'The ID of the replication group
', 'ProcessedUpdateAction$CacheClusterId' => 'The ID of the cache cluster
', 'ProcessedUpdateAction$ServiceUpdateName' => 'The unique ID of the service update
', 'PurchaseReservedCacheNodesOfferingMessage$ReservedCacheNodesOfferingId' => 'The ID of the reserved cache node offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
A customer-specified identifier to track this reservation.
The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation.
Example: myreservationID
', 'RebalanceSlotsInGlobalReplicationGroupMessage$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'RebootCacheClusterMessage$CacheClusterId' => 'The cluster identifier. This parameter is stored as a lowercase string.
', 'RecurringCharge$RecurringChargeFrequency' => 'The frequency of the recurring charge.
', 'RegionalConfiguration$ReplicationGroupId' => 'The name of the secondary cluster
', 'RegionalConfiguration$ReplicationGroupRegion' => 'The Amazon region where the cluster is stored
', 'RemoveReplicasList$member' => NULL, 'RemoveTagsFromResourceMessage$ResourceName' => 'The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.
', 'ReplicationGroup$ReplicationGroupId' => 'The identifier for the replication group.
', 'ReplicationGroup$Description' => 'The user supplied description of the replication group.
', 'ReplicationGroup$Status' => 'The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
The cluster ID that is used as the daily snapshot source for the replication group.
', 'ReplicationGroup$SnapshotWindow' => 'The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
This parameter is only valid if the Engine parameter is redis.
The name of the compute and memory capacity node type for each node in the replication group.
', 'ReplicationGroup$KmsKeyId' => 'The ID of the KMS key used to encrypt the disk in the cluster.
', 'ReplicationGroup$ARN' => 'The ARN (Amazon Resource Name) of the replication group.
', 'ReplicationGroupIdList$member' => NULL, 'ReplicationGroupMessage$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'ReplicationGroupOutpostArnList$member' => NULL, 'ReplicationGroupPendingModifiedValues$PrimaryClusterId' => 'The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.
The unique identifier for the reservation.
', 'ReservedCacheNode$ReservedCacheNodesOfferingId' => 'The offering identifier.
', 'ReservedCacheNode$CacheNodeType' => 'The cache node type for the reserved cache nodes.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
The description of the reserved cache node.
', 'ReservedCacheNode$OfferingType' => 'The offering type of this reserved cache node.
', 'ReservedCacheNode$State' => 'The state of the reserved cache node.
', 'ReservedCacheNode$ReservationARN' => 'The Amazon Resource Name (ARN) of the reserved cache node.
Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582
Provides an identifier to allow retrieval of paginated results.
', 'ReservedCacheNodesOffering$ReservedCacheNodesOfferingId' => 'A unique identifier for the reserved cache node offering.
', 'ReservedCacheNodesOffering$CacheNodeType' => 'The cache node type for the reserved cache node.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
The cache engine used by the offering.
', 'ReservedCacheNodesOffering$OfferingType' => 'The offering type.
', 'ReservedCacheNodesOfferingMessage$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'ResetCacheParameterGroupMessage$CacheParameterGroupName' => 'The name of the cache parameter group to reset.
', 'RevokeCacheSecurityGroupIngressMessage$CacheSecurityGroupName' => 'The name of the cache security group to revoke ingress from.
', 'RevokeCacheSecurityGroupIngressMessage$EC2SecurityGroupName' => 'The name of the Amazon EC2 security group to revoke access from.
', 'RevokeCacheSecurityGroupIngressMessage$EC2SecurityGroupOwnerId' => 'The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter.
', 'SecurityGroupIdsList$member' => NULL, 'SecurityGroupMembership$SecurityGroupId' => 'The identifier of the cache security group.
', 'SecurityGroupMembership$Status' => 'The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cluster are modified.
', 'ServerlessCache$ServerlessCacheName' => 'The unique identifier of the serverless cache.
', 'ServerlessCache$Description' => 'A description of the serverless cache.
', 'ServerlessCache$Status' => 'The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
', 'ServerlessCache$Engine' => 'The engine the serverless cache is compatible with.
', 'ServerlessCache$MajorEngineVersion' => 'The version number of the engine the serverless cache is compatible with.
', 'ServerlessCache$FullEngineVersion' => 'The name and version number of the engine the serverless cache is compatible with.
', 'ServerlessCache$KmsKeyId' => 'The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
', 'ServerlessCache$ARN' => 'The Amazon Resource Name (ARN) of the serverless cache.
', 'ServerlessCache$UserGroupId' => 'The identifier of the user group associated with the serverless cache. Available for Redis only. Default is NULL.
', 'ServerlessCache$DailySnapshotTime' => 'The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Redis only.
', 'ServerlessCacheConfiguration$ServerlessCacheName' => 'The identifier of a serverless cache.
', 'ServerlessCacheConfiguration$Engine' => 'The engine that the serverless cache is configured with.
', 'ServerlessCacheConfiguration$MajorEngineVersion' => 'The engine version number that the serverless cache is configured with.
', 'ServerlessCacheSnapshot$ServerlessCacheSnapshotName' => 'The identifier of a serverless cache snapshot. Available for Redis only.
', 'ServerlessCacheSnapshot$ARN' => 'The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Redis only.
', 'ServerlessCacheSnapshot$KmsKeyId' => 'The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Redis only.
', 'ServerlessCacheSnapshot$SnapshotType' => 'The type of snapshot of serverless cache. Available for Redis only.
', 'ServerlessCacheSnapshot$Status' => 'The current status of the serverless cache. Available for Redis only.
', 'ServerlessCacheSnapshot$BytesUsedForCache' => 'The total size of a serverless cache snapshot, in bytes. Available for Redis only.
', 'ServiceUpdate$ServiceUpdateName' => 'The unique ID of the service update
', 'ServiceUpdate$ServiceUpdateDescription' => 'Provides details of the service update
', 'ServiceUpdate$Engine' => 'The Elasticache engine to which the update applies. Either Redis or Memcached
', 'ServiceUpdate$EngineVersion' => 'The Elasticache engine version to which the update applies. Either Redis or Memcached engine version
', 'ServiceUpdate$EstimatedUpdateTime' => 'The estimated length of time the service update will take
', 'ServiceUpdatesMessage$Marker' => '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.
The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
', 'Snapshot$ReplicationGroupId' => 'The unique identifier of the source replication group.
', 'Snapshot$ReplicationGroupDescription' => 'A description of the source replication group.
', 'Snapshot$CacheClusterId' => 'The user-supplied identifier of the source cluster.
', 'Snapshot$SnapshotStatus' => 'The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
The name of the compute and memory capacity node type for the source cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
The name of the cache engine (memcached or redis) used by the source cluster.
The version of the cache engine version that is used by the source cluster.
', 'Snapshot$PreferredAvailabilityZone' => 'The name of the Availability Zone in which the source cluster is located.
', 'Snapshot$PreferredOutpostArn' => 'The ARN (Amazon Resource Name) of the preferred outpost.
', 'Snapshot$PreferredMaintenanceWindow' => 'Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
', 'Snapshot$CacheParameterGroupName' => 'The cache parameter group that is associated with the source cluster.
', 'Snapshot$CacheSubnetGroupName' => 'The name of the cache subnet group associated with the source cluster.
', 'Snapshot$VpcId' => 'The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
', 'Snapshot$SnapshotWindow' => 'The daily time range during which ElastiCache takes daily snapshots of the source cluster.
', 'Snapshot$KmsKeyId' => 'The ID of the KMS key used to encrypt the snapshot.
', 'Snapshot$ARN' => 'The ARN (Amazon Resource Name) of the snapshot.
', 'SnapshotArnsList$member' => NULL, 'StartMigrationMessage$ReplicationGroupId' => 'The ID of the replication group to which data should be migrated.
', 'Subnet$SubnetIdentifier' => 'The unique identifier for the subnet.
', 'SubnetIdentifierList$member' => NULL, 'SubnetIdsList$member' => NULL, 'SubnetOutpost$SubnetOutpostArn' => 'The outpost ARN of the subnet.
', 'Tag$Key' => 'The key for the tag. May not be null.
', 'Tag$Value' => 'The tag\'s value. May be null.
', 'TestFailoverMessage$ReplicationGroupId' => 'The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.
', 'TestMigrationMessage$ReplicationGroupId' => 'The ID of the replication group to which data is to be migrated.
', 'UGReplicationGroupIdList$member' => NULL, 'UGServerlessCacheIdList$member' => NULL, 'UnprocessedUpdateAction$ReplicationGroupId' => 'The replication group ID
', 'UnprocessedUpdateAction$CacheClusterId' => 'The ID of the cache cluster
', 'UnprocessedUpdateAction$ServiceUpdateName' => 'The unique ID of the service update
', 'UnprocessedUpdateAction$ErrorType' => 'The error type for requests that are not processed
', 'UnprocessedUpdateAction$ErrorMessage' => 'The error message that describes the reason the request was not processed
', 'UpdateAction$ReplicationGroupId' => 'The ID of the replication group
', 'UpdateAction$CacheClusterId' => 'The ID of the cache cluster
', 'UpdateAction$ServiceUpdateName' => 'The unique ID of the service update
', 'UpdateAction$NodesUpdated' => 'The progress of the service update on the replication group
', 'UpdateAction$EstimatedUpdateTime' => 'The estimated length of time for the update to complete
', 'UpdateAction$Engine' => 'The Elasticache engine to which the update applies. Either Redis or Memcached
', 'UpdateActionsMessage$Marker' => '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.
The ID of the user.
', 'User$UserName' => 'The username of the user.
', 'User$Status' => 'Indicates the user status. Can be "active", "modifying" or "deleting".
', 'User$MinimumEngineVersion' => 'The minimum engine version required, which is Redis 6.0
', 'User$AccessString' => 'Access permissions string used for this user.
', 'User$ARN' => 'The Amazon Resource Name (ARN) of the user.
', 'UserGroup$UserGroupId' => 'The ID of the user group.
', 'UserGroup$Status' => 'Indicates user group status. Can be "creating", "active", "modifying", "deleting".
', 'UserGroup$MinimumEngineVersion' => 'The minimum engine version required, which is Redis 6.0
', 'UserGroup$ARN' => 'The Amazon Resource Name (ARN) of the user group.
', ], ], 'Subnet' => [ 'base' => 'Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
', 'refs' => [ 'SubnetList$member' => NULL, ], ], 'SubnetIdentifierList' => [ 'base' => NULL, 'refs' => [ 'CreateCacheSubnetGroupMessage$SubnetIds' => 'A list of VPC subnet IDs for the cache subnet group.
', 'ModifyCacheSubnetGroupMessage$SubnetIds' => 'The EC2 subnet IDs for the cache subnet group.
', ], ], 'SubnetIdsList' => [ 'base' => NULL, 'refs' => [ 'CreateServerlessCacheRequest$SubnetIds' => 'A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.
', 'ServerlessCache$SubnetIds' => 'If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.
', ], ], 'SubnetInUse' => [ 'base' => 'The requested subnet is being used by another cache subnet group.
', 'refs' => [], ], 'SubnetList' => [ 'base' => NULL, 'refs' => [ 'CacheSubnetGroup$Subnets' => 'A list of subnets associated with the cache subnet group.
', ], ], 'SubnetNotAllowedFault' => [ 'base' => 'At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.
', 'refs' => [], ], 'SubnetOutpost' => [ 'base' => 'The ID of the outpost subnet.
', 'refs' => [ 'Subnet$SubnetOutpost' => 'The outpost ARN of the subnet.
', ], ], 'TStamp' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$CacheClusterCreateTime' => 'The date and time when the cluster was created.
', 'CacheCluster$AuthTokenLastModifiedDate' => 'The date the auth token was last modified
', 'CacheNode$CacheNodeCreateTime' => 'The date and time when the cache node was created.
', 'CacheNodeUpdateStatus$NodeDeletionDate' => 'The deletion date of the node
', 'CacheNodeUpdateStatus$NodeUpdateStartDate' => 'The start date of the update for a node
', 'CacheNodeUpdateStatus$NodeUpdateEndDate' => 'The end date of the update for a node
', 'CacheNodeUpdateStatus$NodeUpdateInitiatedDate' => 'The date when the update is triggered
', 'CacheNodeUpdateStatus$NodeUpdateStatusModifiedDate' => 'The date when the NodeUpdateStatus was last modified>
', 'DescribeEventsMessage$StartTime' => 'The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Example: 2017-03-30T07:03:49.555Z
', 'DescribeEventsMessage$EndTime' => 'The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Example: 2017-03-30T07:03:49.555Z
', 'Event$Date' => 'The date and time when the event occurred.
', 'NodeGroupMemberUpdateStatus$NodeDeletionDate' => 'The deletion date of the node
', 'NodeGroupMemberUpdateStatus$NodeUpdateStartDate' => 'The start date of the update for a node
', 'NodeGroupMemberUpdateStatus$NodeUpdateEndDate' => 'The end date of the update for a node
', 'NodeGroupMemberUpdateStatus$NodeUpdateInitiatedDate' => 'The date when the update is triggered
', 'NodeGroupMemberUpdateStatus$NodeUpdateStatusModifiedDate' => 'The date when the NodeUpdateStatus was last modified
', 'NodeSnapshot$CacheNodeCreateTime' => 'The date and time when the cache node was created in the source cluster.
', 'NodeSnapshot$SnapshotCreateTime' => 'The date and time when the source node\'s metadata and cache data set was obtained for the snapshot.
', 'ReplicationGroup$AuthTokenLastModifiedDate' => 'The date the auth token was last modified
', 'ReplicationGroup$ReplicationGroupCreateTime' => 'The date and time when the cluster was created.
', 'ReservedCacheNode$StartTime' => 'The time the reservation started.
', 'ServerlessCache$CreateTime' => 'When the serverless cache was created.
', 'ServerlessCacheSnapshot$CreateTime' => 'The date and time that the source serverless cache\'s metadata and cache data set was obtained for the snapshot. Available for Redis only.
', 'ServerlessCacheSnapshot$ExpiryTime' => 'The time that the serverless cache snapshot will expire. Available for Redis only.
', 'ServiceUpdate$ServiceUpdateReleaseDate' => 'The date when the service update is initially available
', 'ServiceUpdate$ServiceUpdateEndDate' => 'The date after which the service update is no longer available
', 'ServiceUpdate$ServiceUpdateRecommendedApplyByDate' => 'The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
', 'Snapshot$CacheClusterCreateTime' => 'The date and time when the source cluster was created.
', 'TimeRangeFilter$StartTime' => 'The start time of the time range filter
', 'TimeRangeFilter$EndTime' => 'The end time of the time range filter
', 'UpdateAction$ServiceUpdateReleaseDate' => 'The date the update is first available
', 'UpdateAction$ServiceUpdateRecommendedApplyByDate' => 'The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
', 'UpdateAction$UpdateActionAvailableDate' => 'The date that the service update is available to a replication group
', 'UpdateAction$UpdateActionStatusModifiedDate' => 'The date when the UpdateActionStatus was last modified
', ], ], 'Tag' => [ 'base' => 'A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AddTagsToResourceMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
', 'CopyServerlessCacheSnapshotRequest$Tags' => 'A list of tags to be added to the target snapshot resource. A tag is a key-value pair. Available for Redis only. Default: NULL
', 'CopySnapshotMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
', 'CreateCacheClusterMessage$Tags' => 'A list of tags to be added to this resource.
', 'CreateCacheParameterGroupMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
', 'CreateCacheSecurityGroupMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
', 'CreateCacheSubnetGroupMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
', 'CreateReplicationGroupMessage$Tags' => 'A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue. Tags on replication groups will be replicated to all nodes.
The list of tags (key, value) pairs to be added to the serverless cache resource. Default is NULL.
', 'CreateServerlessCacheSnapshotRequest$Tags' => 'A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Redis only.
', 'CreateSnapshotMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
', 'CreateUserGroupMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. Available for Redis only.
', 'CreateUserMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
', 'PurchaseReservedCacheNodesOfferingMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
', 'TagListMessage$TagList' => 'A list of tags as key-value pairs.
', ], ], 'TagListMessage' => [ 'base' => 'Represents the output from the AddTagsToResource, ListTagsForResource, and RemoveTagsFromResource operations.
The requested tag was not found on this resource.
', 'refs' => [], ], 'TagQuotaPerResourceExceeded' => [ 'base' => 'The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.
', 'refs' => [], ], 'TestFailoverMessage' => [ 'base' => NULL, 'refs' => [], ], 'TestFailoverNotAvailableFault' => [ 'base' => 'The TestFailover action is not available.
Filters update actions from the service updates that are in available status during the time range.
', 'refs' => [ 'DescribeUpdateActionsMessage$ServiceUpdateTimeRange' => 'The range of time specified to search for service updates that are in available status
', ], ], 'TransitEncryptionMode' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$TransitEncryptionMode' => 'A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
', 'CreateReplicationGroupMessage$TransitEncryptionMode' => 'A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
When setting TransitEncryptionEnabled to true, you can set your TransitEncryptionMode to preferred in the same request, to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Redis clients to use encrypted connections you can modify the value to required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred, after that you can set TransitEncryptionMode to required.
This process will not trigger the replacement of the replication group.
', 'ModifyReplicationGroupMessage$TransitEncryptionMode' => 'A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
You must set TransitEncryptionEnabled to true, for your existing cluster, and set TransitEncryptionMode to preferred in the same request to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Redis clients to use encrypted connections you can set the value to required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred, after that you can set TransitEncryptionMode to required.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
', 'ReplicationGroup$TransitEncryptionMode' => 'A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
', 'ReplicationGroupPendingModifiedValues$TransitEncryptionMode' => 'A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
', ], ], 'UGReplicationGroupIdList' => [ 'base' => NULL, 'refs' => [ 'UserGroup$ReplicationGroups' => 'A list of replication groups that the user group can access.
', ], ], 'UGServerlessCacheIdList' => [ 'base' => NULL, 'refs' => [ 'UserGroup$ServerlessCaches' => 'Indicates which serverless caches the specified user group is associated with. Available for Redis only.
', ], ], 'UnprocessedUpdateAction' => [ 'base' => 'Update action that has failed to be processed for the corresponding apply/stop request
', 'refs' => [ 'UnprocessedUpdateActionList$member' => NULL, ], ], 'UnprocessedUpdateActionList' => [ 'base' => NULL, 'refs' => [ 'UpdateActionResultsMessage$UnprocessedUpdateActions' => 'Update actions that haven\'t been processed successfully
', ], ], 'UpdateAction' => [ 'base' => 'The status of the service update for a specific replication group
', 'refs' => [ 'UpdateActionList$member' => NULL, ], ], 'UpdateActionList' => [ 'base' => NULL, 'refs' => [ 'UpdateActionsMessage$UpdateActions' => 'Returns a list of update actions
', ], ], 'UpdateActionResultsMessage' => [ 'base' => NULL, 'refs' => [], ], 'UpdateActionStatus' => [ 'base' => NULL, 'refs' => [ 'ProcessedUpdateAction$UpdateActionStatus' => 'The status of the update action on the Redis cluster
', 'UpdateAction$UpdateActionStatus' => 'The status of the update action
', 'UpdateActionStatusList$member' => NULL, ], ], 'UpdateActionStatusList' => [ 'base' => NULL, 'refs' => [ 'DescribeUpdateActionsMessage$UpdateActionStatus' => 'The status of the update action.
', ], ], 'UpdateActionsMessage' => [ 'base' => NULL, 'refs' => [], ], 'User' => [ 'base' => NULL, 'refs' => [ 'UserList$member' => NULL, ], ], 'UserAlreadyExistsFault' => [ 'base' => 'A user with this ID already exists.
', 'refs' => [], ], 'UserGroup' => [ 'base' => NULL, 'refs' => [ 'UserGroupList$member' => NULL, ], ], 'UserGroupAlreadyExistsFault' => [ 'base' => 'The user group with this ID already exists.
', 'refs' => [], ], 'UserGroupId' => [ 'base' => NULL, 'refs' => [ 'UserGroupIdList$member' => NULL, 'UserGroupIdListInput$member' => NULL, ], ], 'UserGroupIdList' => [ 'base' => NULL, 'refs' => [ 'ModifyReplicationGroupMessage$UserGroupIdsToAdd' => 'The ID of the user group you are associating with the replication group.
', 'ModifyReplicationGroupMessage$UserGroupIdsToRemove' => 'The ID of the user group to disassociate from the replication group, meaning the users in the group no longer can access the replication group.
', 'ReplicationGroup$UserGroupIds' => 'The ID of the user group associated to the replication group.
', 'User$UserGroupIds' => 'Returns a list of the user group IDs the user belongs to.
', 'UserGroupsUpdateStatus$UserGroupIdsToAdd' => 'The ID of the user group to add.
', 'UserGroupsUpdateStatus$UserGroupIdsToRemove' => 'The ID of the user group to remove.
', ], ], 'UserGroupIdListInput' => [ 'base' => NULL, 'refs' => [ 'CreateReplicationGroupMessage$UserGroupIds' => 'The user group to associate with the replication group.
', ], ], 'UserGroupList' => [ 'base' => NULL, 'refs' => [ 'DescribeUserGroupsResult$UserGroups' => 'Returns a list of user groups.
', ], ], 'UserGroupNotFoundFault' => [ 'base' => 'The user group was not found or does not exist
', 'refs' => [], ], 'UserGroupPendingChanges' => [ 'base' => 'Returns the updates being applied to the user group.
', 'refs' => [ 'UserGroup$PendingChanges' => 'A list of updates being applied to the user group.
', ], ], 'UserGroupQuotaExceededFault' => [ 'base' => 'The number of users exceeds the user group limit.
', 'refs' => [], ], 'UserGroupsUpdateStatus' => [ 'base' => 'The status of the user group update.
', 'refs' => [ 'ReplicationGroupPendingModifiedValues$UserGroups' => 'The user group being modified.
', ], ], 'UserId' => [ 'base' => NULL, 'refs' => [ 'CreateUserMessage$UserId' => 'The ID of the user.
', 'DeleteUserMessage$UserId' => 'The ID of the user.
', 'DescribeUsersMessage$UserId' => 'The ID of the user.
', 'ModifyUserMessage$UserId' => 'The ID of the user.
', 'UserIdList$member' => NULL, 'UserIdListInput$member' => NULL, ], ], 'UserIdList' => [ 'base' => NULL, 'refs' => [ 'UserGroup$UserIds' => 'The list of user IDs that belong to the user group.
', 'UserGroupPendingChanges$UserIdsToRemove' => 'The list of user IDs to remove.
', 'UserGroupPendingChanges$UserIdsToAdd' => 'The list of user IDs to add.
', ], ], 'UserIdListInput' => [ 'base' => NULL, 'refs' => [ 'CreateUserGroupMessage$UserIds' => 'The list of user IDs that belong to the user group.
', 'ModifyUserGroupMessage$UserIdsToAdd' => 'The list of user IDs to add to the user group.
', 'ModifyUserGroupMessage$UserIdsToRemove' => 'The list of user IDs to remove from the user group.
', ], ], 'UserList' => [ 'base' => NULL, 'refs' => [ 'DescribeUsersResult$Users' => 'A list of users.
', ], ], 'UserName' => [ 'base' => NULL, 'refs' => [ 'CreateUserMessage$UserName' => 'The username of the user.
', ], ], 'UserNotFoundFault' => [ 'base' => 'The user does not exist or could not be found.
', 'refs' => [], ], 'UserQuotaExceededFault' => [ 'base' => 'The quota of users has been exceeded.
', 'refs' => [], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.
With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.
In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.
', 'operations' => [ 'AddTagsToResource' => 'A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
For example, you can use cost-allocation tags to your ElastiCache resources, Amazon generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services.
For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.
', 'AuthorizeCacheSecurityGroupIngress' => 'Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.
You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.
Apply the service update. For more information on service updates and applying them, see Applying Service Updates.
', 'BatchStopUpdateAction' => 'Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.
', 'CompleteMigration' => 'Complete the migration of data.
', 'CopyServerlessCacheSnapshot' => 'Creates a copy of an existing serverless cache’s snapshot. Available for Redis only.
', 'CopySnapshot' => 'Makes a copy of an existing snapshot.
This operation is valid for Redis only.
Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.
You could receive the following error messages.
Error Messages
Error Message: The S3 bucket %s is outside of the region.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s does not exist.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The S3 bucket %s is not owned by the authenticated user.
Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.
Solution: Contact your system administrator to get the needed permissions.
Error Message: The S3 bucket %s already contains an object with key %s.
Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.
Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.
Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.
Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.
Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.
Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis.
This operation is not supported for Redis (cluster mode enabled) clusters.
', 'CreateCacheParameterGroup' => 'Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.
A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:
ModifyCacheParameterGroup in the ElastiCache API Reference.
Parameters and Parameter Groups in the ElastiCache User Guide.
Creates a new cache security group. Use a cache security group to control access to one or more clusters.
Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.
', 'CreateCacheSubnetGroup' => 'Creates a new cache subnet group.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
', 'CreateGlobalReplicationGroup' => 'Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across regions. For more information, see Replication Across Regions Using Global Datastore.
The GlobalReplicationGroupIdSuffix is the name of the Global datastore.
The PrimaryReplicationGroupId represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.
A Redis (cluster mode disabled) replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.
The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.
To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.
When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis\' scaling. For more information, see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.
This operation is valid for Redis only.
Creates a serverless cache.
', 'CreateServerlessCacheSnapshot' => 'This API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Redis only.
', 'CreateSnapshot' => 'Creates a copy of an entire cluster or replication group at a specific moment in time.
This operation is valid for Redis only.
For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).
', 'CreateUserGroup' => 'For Redis engine version 6.0 onwards: Creates a Redis user group. For more information, see Using Role Based Access Control (RBAC)
', 'DecreaseNodeGroupsInGlobalReplicationGroup' => 'Decreases the number of node groups in a Global datastore
', 'DecreaseReplicaCount' => 'Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
', 'DeleteCacheCluster' => 'Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.
This operation is not valid for:
Redis (cluster mode enabled) clusters
Redis (cluster mode disabled) clusters
A cluster that is the last read replica of a replication group
A cluster that is the primary node of a replication group
A node group (shard) that has Multi-AZ mode enabled
A cluster from a Redis (cluster mode enabled) replication group
A cluster that is not in the available state
Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account.
', 'DeleteCacheSecurityGroup' => 'Deletes a cache security group.
You cannot delete a cache security group if it is associated with any clusters.
Deletes a cache subnet group.
You cannot delete a default cache subnet group or one that is associated with any clusters.
Deleting a Global datastore is a two-step process:
First, you must DisassociateGlobalReplicationGroup to remove the secondary clusters in the Global datastore.
Once the Global datastore contains only the primary cluster, you can use the DeleteGlobalReplicationGroup API to delete the Global datastore while retainining the primary cluster using RetainPrimaryReplicationGroup=true.
Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting RetainPrimaryReplicationGroup=true. The primary cluster is never deleted when deleting a Global Datastore. It can only be deleted when it no longer is associated with any Global Datastore.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
', 'DeleteReplicationGroup' => 'Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.
When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.
This operation is valid for Redis only.
Deletes a specified existing serverless cache.
', 'DeleteServerlessCacheSnapshot' => 'Deletes an existing serverless cache snapshot. Available for Redis only.
', 'DeleteSnapshot' => 'Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.
This operation is valid for Redis only.
For Redis engine version 6.0 onwards: Deletes a user. The user will be removed from all user groups and in turn removed from all replication groups. For more information, see Using Role Based Access Control (RBAC).
', 'DeleteUserGroup' => 'For Redis engine version 6.0 onwards: Deletes a user group. The user group must first be disassociated from the replication group before it can be deleted. For more information, see Using Role Based Access Control (RBAC).
', 'DescribeCacheClusters' => 'Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.
By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.
If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.
If the cluster is in the deleting state, only cluster-level information is displayed.
If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.
If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.
', 'DescribeCacheEngineVersions' => 'Returns a list of the available cache engines and their versions.
', 'DescribeCacheParameterGroups' => 'Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
', 'DescribeCacheParameters' => 'Returns the detailed parameter list for a particular cache parameter group.
', 'DescribeCacheSecurityGroups' => 'Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup
', 'DescribeCacheSubnetGroups' => 'Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.
', 'DescribeEngineDefaultParameters' => 'Returns the default engine and system parameter information for the specified cache engine.
', 'DescribeEvents' => 'Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.
By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days\' worth of events if necessary.
', 'DescribeGlobalReplicationGroups' => 'Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.
', 'DescribeReplicationGroups' => 'Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.
This operation is valid for Redis only.
Returns information about reserved cache nodes for this account, or about a specified reserved cache node.
', 'DescribeReservedCacheNodesOfferings' => 'Lists available reserved cache node offerings.
', 'DescribeServerlessCacheSnapshots' => 'Returns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Redis only.
', 'DescribeServerlessCaches' => 'Returns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account.
', 'DescribeServiceUpdates' => 'Returns details of the service updates
', 'DescribeSnapshots' => 'Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.
This operation is valid for Redis only.
Returns details of the update actions
', 'DescribeUserGroups' => 'Returns a list of user groups.
', 'DescribeUsers' => 'Returns a list of users.
', 'DisassociateGlobalReplicationGroup' => 'Remove a secondary cluster from the Global datastore using the Global datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that Amazon region.
', 'ExportServerlessCacheSnapshot' => 'Provides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Redis only.
', 'FailoverGlobalReplicationGroup' => 'Used to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.
', 'IncreaseNodeGroupsInGlobalReplicationGroup' => 'Increase the number of node groups in the Global datastore
', 'IncreaseReplicaCount' => 'Dynamically increases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.
', 'ListAllowedNodeTypeModifications' => 'Lists all available node types that you can scale your Redis cluster\'s or replication group\'s current node type.
When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.
Lists all tags currently on a named resource.
A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
If the cluster is not in the available state, ListTagsForResource returns an error.
Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.
', 'ModifyCacheParameterGroup' => 'Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
', 'ModifyCacheSubnetGroup' => 'Modifies an existing cache subnet group.
', 'ModifyGlobalReplicationGroup' => 'Modifies the settings for a Global datastore.
', 'ModifyReplicationGroup' => 'Modifies the settings for a replication group. This is limited to Redis 7 and newer.
Scaling for Amazon ElastiCache for Redis (cluster mode enabled) in the ElastiCache User Guide
ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference
This operation is valid for Redis only.
Modifies a replication group\'s shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.
', 'ModifyServerlessCache' => 'This API modifies the attributes of a serverless cache.
', 'ModifyUser' => 'Changes user password(s) and/or access string.
', 'ModifyUserGroup' => 'Changes the list of users that belong to the user group.
', 'PurchaseReservedCacheNodesOffering' => 'Allows you to purchase a reserved cache node offering. Reserved nodes are not eligible for cancellation and are non-refundable. For more information, see Managing Costs with Reserved Nodes for Redis or Managing Costs with Reserved Nodes for Memcached.
', 'RebalanceSlotsInGlobalReplicationGroup' => 'Redistribute slots to ensure uniform distribution across existing shards in the cluster.
', 'RebootCacheCluster' => 'Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.
The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.
When the reboot is complete, a cluster event is created.
Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters.
If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.
', 'RemoveTagsFromResource' => 'Removes the tags identified by the TagKeys list from the named resource. A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. For more information, see Resource-level permissions.
Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.
Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.
', 'StartMigration' => 'Start the migration of data.
', 'TestFailover' => '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' => 'Async API to test connection between source and target replication group.
', ], 'shapes' => [ 'APICallRateForCustomerExceededFault' => [ 'base' => 'The customer has exceeded the allowed rate of API calls.
', 'refs' => [], ], 'AZMode' => [ 'base' => NULL, 'refs' => [ 'CreateCacheClusterMessage$AZMode' => 'Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster\'s region.
This parameter is only supported for Memcached clusters.
If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.
Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.
Valid values: single-az | cross-az.
This option is only supported for Memcached clusters.
You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.
Only newly created nodes are located in different Availability Zones.
Access permissions string used for this user.
', 'ModifyUserMessage$AccessString' => 'Access permissions string used for this user.
', 'ModifyUserMessage$AppendAccessString' => 'Adds additional user permissions to the access string.
', ], ], 'AddTagsToResourceMessage' => [ 'base' => 'Represents the input of an AddTagsToResource operation.
', 'refs' => [], ], 'AllowedNodeGroupId' => [ 'base' => NULL, 'refs' => [ 'ConfigureShard$NodeGroupId' => 'The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)\'s node group\'s (shard\'s) id, see Finding a Shard\'s Id.
', 'NodeGroupConfiguration$NodeGroupId' => 'Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
', 'NodeGroupsToRemoveList$member' => NULL, 'NodeGroupsToRetainList$member' => NULL, 'ReshardingConfiguration$NodeGroupId' => 'Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
', 'TestFailoverMessage$NodeGroupId' => '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.
', ], ], 'AllowedNodeTypeModificationsMessage' => [ 'base' => 'Represents the allowed node types you can use to modify your cluster or replication group.
', 'refs' => [], ], 'AuthTokenUpdateStatus' => [ 'base' => NULL, 'refs' => [ 'PendingModifiedValues$AuthTokenStatus' => 'The auth token status
', 'ReplicationGroupPendingModifiedValues$AuthTokenStatus' => 'The auth token status
', ], ], 'AuthTokenUpdateStrategyType' => [ 'base' => NULL, 'refs' => [ 'ModifyCacheClusterMessage$AuthTokenUpdateStrategy' => '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
', 'ModifyReplicationGroupMessage$AuthTokenUpdateStrategy' => '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
', ], ], 'Authentication' => [ 'base' => 'Indicates whether the user requires a password to authenticate.
', 'refs' => [ 'User$Authentication' => 'Denotes whether the user requires a password to authenticate.
', ], ], 'AuthenticationMode' => [ 'base' => 'Specifies the authentication mode to use.
', 'refs' => [ 'CreateUserMessage$AuthenticationMode' => 'Specifies how to authenticate the user.
', 'ModifyUserMessage$AuthenticationMode' => 'Specifies how to authenticate the user.
', ], ], 'AuthenticationType' => [ 'base' => NULL, 'refs' => [ 'Authentication$Type' => 'Indicates whether the user requires a password to authenticate.
', ], ], 'AuthorizationAlreadyExistsFault' => [ 'base' => 'The specified Amazon EC2 security group is already authorized for the specified cache security group.
', 'refs' => [], ], 'AuthorizationNotFoundFault' => [ 'base' => 'The specified Amazon EC2 security group is not authorized for the specified cache security group.
', 'refs' => [], ], 'AuthorizeCacheSecurityGroupIngressMessage' => [ 'base' => 'Represents the input of an AuthorizeCacheSecurityGroupIngress operation.
', 'refs' => [], ], 'AuthorizeCacheSecurityGroupIngressResult' => [ 'base' => NULL, 'refs' => [], ], 'AutomaticFailoverStatus' => [ 'base' => NULL, 'refs' => [ 'GlobalReplicationGroupMember$AutomaticFailover' => 'Indicates whether automatic failover is enabled for the replication group.
', 'ReplicationGroup$AutomaticFailover' => 'Indicates the status of automatic failover for this Redis replication group.
', 'Snapshot$AutomaticFailover' => 'Indicates the status of automatic failover for the source Redis replication group.
', ], ], 'AvailabilityZone' => [ 'base' => 'Describes an Availability Zone in which the cluster is launched.
', 'refs' => [ 'Subnet$SubnetAvailabilityZone' => 'The Availability Zone associated with the subnet.
', ], ], 'AvailabilityZonesList' => [ 'base' => NULL, 'refs' => [ 'CreateReplicationGroupMessage$PreferredCacheClusterAZs' => 'A list of EC2 Availability Zones in which the replication group\'s clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.
This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.
If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of NumCacheClusters.
Default: system chosen Availability Zones.
', 'NodeGroupConfiguration$ReplicaAvailabilityZones' => 'A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.
A list of preferred availability zones for the nodes in this cluster.
', ], ], 'AwsQueryErrorMessage' => [ 'base' => NULL, 'refs' => [ 'InvalidParameterCombinationException$message' => 'Two or more parameters that must not be used together were used together.
', 'InvalidParameterValueException$message' => 'A parameter value is invalid.
', ], ], 'BatchApplyUpdateActionMessage' => [ 'base' => NULL, 'refs' => [], ], 'BatchStopUpdateActionMessage' => [ 'base' => NULL, 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$AutoMinorVersionUpgrade' => 'If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
', 'CacheCluster$ReplicationGroupLogDeliveryEnabled' => 'A boolean value indicating whether log delivery is enabled for the replication group.
', 'CacheNodeTypeSpecificParameter$IsModifiable' => 'Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
Indicates whether the parameter group is associated with a Global datastore
', 'CompleteMigrationMessage$Force' => 'Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.
', 'DecreaseNodeGroupsInGlobalReplicationGroupMessage$ApplyImmediately' => 'Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.
', 'DecreaseReplicaCountMessage$ApplyImmediately' => 'If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.
The primary replication group is retained as a standalone replication group.
', 'DescribeCacheEngineVersionsMessage$DefaultOnly' => 'If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.
Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.
', 'IncreaseReplicaCountMessage$ApplyImmediately' => 'If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported.
If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster.
If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.
If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.
Valid values: true | false
Default: false
This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.
', 'ModifyReplicationGroupMessage$ApplyImmediately' => 'If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.
If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.
Valid values: true | false
Default: false
Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.
Value: true
', 'Parameter$IsModifiable' => 'Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
If True, redistribution is applied immediately.
If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
', 'ResetCacheParameterGroupMessage$ResetAllParameters' => 'If true, all parameters in the cache parameter group are reset to their default values. If false, only the parameters listed by ParameterNameValues are reset to their default values.
Valid values: true | false
If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
', ], ], 'BooleanOptional' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$AuthTokenEnabled' => 'A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false
A flag that enables in-transit encryption when set to true.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
A flag that enables encryption at-rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
', 'CreateCacheClusterMessage$TransitEncryptionEnabled' => 'A flag that enables in-transit encryption when set to true.
', 'CreateReplicationGroupMessage$AutomaticFailoverEnabled' => 'Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
', 'CreateReplicationGroupMessage$MultiAZEnabled' => 'A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
', 'CreateReplicationGroupMessage$AutoMinorVersionUpgrade' => 'If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
', 'CreateReplicationGroupMessage$TransitEncryptionEnabled' => 'A flag that enables in-transit encryption when set to true.
This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC.
If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.
A flag that enables encryption at rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.
', 'CreateUserMessage$NoPasswordRequired' => 'Indicates a password is not required for this user.
', 'DeleteReplicationGroupMessage$RetainPrimaryCluster' => 'If set to true, all of the read replicas are deleted, but the primary node is retained.
An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.
Returns the list of members that comprise the Global datastore.
', 'DescribeSnapshotsMessage$ShowNodeGroupConfig' => 'A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
', 'DescribeUpdateActionsMessage$ShowNodeLevelUpdateStatus' => 'Dictates whether to include node level update status in the response
', 'GlobalReplicationGroup$ClusterEnabled' => 'A flag that indicates whether the Global datastore is cluster enabled.
', 'GlobalReplicationGroup$AuthTokenEnabled' => 'A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false
A flag that enables in-transit encryption when set to true.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
A flag that enables encryption at rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Specify if log delivery is enabled. Default true.
If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
', 'ModifyGlobalReplicationGroupMessage$AutomaticFailoverEnabled' => 'Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
', 'ModifyReplicationGroupMessage$AutomaticFailoverEnabled' => 'Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
Valid values: true | false
A flag to indicate MultiAZ is enabled.
', 'ModifyReplicationGroupMessage$AutoMinorVersionUpgrade' => 'If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
', 'ModifyReplicationGroupMessage$RemoveUserGroups' => 'Removes the user group associated with this replication group.
', 'ModifyReplicationGroupMessage$TransitEncryptionEnabled' => 'A flag that enables in-transit encryption when set to true. If you are enabling in-transit encryption for an existing cluster, you must also set TransitEncryptionMode to preferred.
The identifier of the UserGroup to be removed from association with the Redis serverless cache. Available for Redis only. Default is NULL.
', 'ModifyUserMessage$NoPasswordRequired' => 'Indicates no password is required for the user.
', 'PendingModifiedValues$TransitEncryptionEnabled' => 'A flag that enables in-transit encryption when set to true.
', 'ReplicationGroup$ClusterEnabled' => 'A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).
Valid values: true | false
A flag that enables using an AuthToken (password) when issuing Redis commands.
Default: false
A flag that enables in-transit encryption when set to true.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
A flag that enables encryption at-rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.
Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
A flag that enables in-transit encryption when set to true.
', 'ServiceUpdate$AutoUpdateAfterRecommendedApplyByDate' => 'Indicates whether the service update will be automatically applied once the recommended apply-by date has expired.
', ], ], 'CacheCluster' => [ 'base' => 'Contains all of the attributes of a specific cluster.
', 'refs' => [ 'CacheClusterList$member' => NULL, 'CreateCacheClusterResult$CacheCluster' => NULL, 'DeleteCacheClusterResult$CacheCluster' => NULL, 'ModifyCacheClusterResult$CacheCluster' => NULL, 'RebootCacheClusterResult$CacheCluster' => NULL, ], ], 'CacheClusterAlreadyExistsFault' => [ 'base' => 'You already have a cluster with the given identifier.
', 'refs' => [], ], 'CacheClusterIdList' => [ 'base' => NULL, 'refs' => [ 'BatchApplyUpdateActionMessage$CacheClusterIds' => 'The cache cluster IDs
', 'BatchStopUpdateActionMessage$CacheClusterIds' => 'The cache cluster IDs
', 'DescribeUpdateActionsMessage$CacheClusterIds' => 'The cache cluster IDs
', ], ], 'CacheClusterList' => [ 'base' => NULL, 'refs' => [ 'CacheClusterMessage$CacheClusters' => 'A list of clusters. Each item in the list contains detailed information about one cluster.
', ], ], 'CacheClusterMessage' => [ 'base' => 'Represents the output of a DescribeCacheClusters operation.
The requested cluster ID does not refer to an existing cluster.
', 'refs' => [], ], 'CacheEngineVersion' => [ 'base' => 'Provides all of the details about a particular cache engine version.
', 'refs' => [ 'CacheEngineVersionList$member' => NULL, ], ], 'CacheEngineVersionList' => [ 'base' => NULL, 'refs' => [ 'CacheEngineVersionMessage$CacheEngineVersions' => 'A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.
', ], ], 'CacheEngineVersionMessage' => [ 'base' => 'Represents the output of a DescribeCacheEngineVersions operation.
', 'refs' => [], ], 'CacheNode' => [ 'base' => 'Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster\'s protocol-compliant caching software - either Memcached or Redis.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).
', 'ModifyCacheClusterMessage$CacheNodeIdsToRemove' => 'A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.
For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.
A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).
', 'RebootCacheClusterMessage$CacheNodeIdsToReboot' => 'A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.
', ], ], 'CacheNodeList' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$CacheNodes' => 'A list of cache nodes that are members of the cluster.
', ], ], 'CacheNodeTypeSpecificParameter' => [ 'base' => 'A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.
A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
', 'EngineDefaults$CacheNodeTypeSpecificParameters' => 'A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
', ], ], 'CacheNodeTypeSpecificValue' => [ 'base' => 'A value that applies only to a certain cache node type.
', 'refs' => [ 'CacheNodeTypeSpecificValueList$member' => NULL, ], ], 'CacheNodeTypeSpecificValueList' => [ 'base' => NULL, 'refs' => [ 'CacheNodeTypeSpecificParameter$CacheNodeTypeSpecificValues' => 'A list of cache node types and their corresponding values for this parameter.
', ], ], 'CacheNodeUpdateStatus' => [ 'base' => 'The status of the service update on the cache node
', 'refs' => [ 'CacheNodeUpdateStatusList$member' => NULL, ], ], 'CacheNodeUpdateStatusList' => [ 'base' => NULL, 'refs' => [ 'UpdateAction$CacheNodeUpdateStatus' => 'The status of the service update on the cache node
', ], ], 'CacheParameterGroup' => [ 'base' => 'Represents the output of a CreateCacheParameterGroup operation.
A cache parameter group with the requested name already exists.
', 'refs' => [], ], 'CacheParameterGroupDetails' => [ 'base' => 'Represents the output of a DescribeCacheParameters operation.
A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.
', ], ], 'CacheParameterGroupNameMessage' => [ 'base' => 'Represents the output of one of the following operations:
ModifyCacheParameterGroup
ResetCacheParameterGroup
The requested cache parameter group name does not refer to an existing cache parameter group.
', 'refs' => [], ], 'CacheParameterGroupQuotaExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the maximum number of cache security groups.
', 'refs' => [], ], 'CacheParameterGroupStatus' => [ 'base' => 'Status of the cache parameter group.
', 'refs' => [ 'CacheCluster$CacheParameterGroup' => 'Status of the cache parameter group.
', ], ], 'CacheParameterGroupsMessage' => [ 'base' => 'Represents the output of a DescribeCacheParameterGroups operation.
Represents the output of one of the following operations:
AuthorizeCacheSecurityGroupIngress
CreateCacheSecurityGroup
RevokeCacheSecurityGroupIngress
A cache security group with the specified name already exists.
', 'refs' => [], ], 'CacheSecurityGroupMembership' => [ 'base' => 'Represents a cluster\'s status within a particular cache security group.
', 'refs' => [ 'CacheSecurityGroupMembershipList$member' => NULL, ], ], 'CacheSecurityGroupMembershipList' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$CacheSecurityGroups' => 'A list of cache security group elements, composed of name and status sub-elements.
', ], ], 'CacheSecurityGroupMessage' => [ 'base' => 'Represents the output of a DescribeCacheSecurityGroups operation.
A list of security group names to associate with this cluster.
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
', 'CreateReplicationGroupMessage$CacheSecurityGroupNames' => 'A list of cache security group names to associate with this replication group.
', 'ModifyCacheClusterMessage$CacheSecurityGroupNames' => 'A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.
You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
', 'ModifyReplicationGroupMessage$CacheSecurityGroupNames' => 'A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.
This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.
The requested cache security group name does not refer to an existing cache security group.
', 'refs' => [], ], 'CacheSecurityGroupQuotaExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the allowed number of cache security groups.
', 'refs' => [], ], 'CacheSecurityGroups' => [ 'base' => NULL, 'refs' => [ 'CacheSecurityGroupMessage$CacheSecurityGroups' => 'A list of cache security groups. Each element in the list contains detailed information about one group.
', ], ], 'CacheSubnetGroup' => [ 'base' => 'Represents the output of one of the following operations:
CreateCacheSubnetGroup
ModifyCacheSubnetGroup
The requested cache subnet group name is already in use by an existing cache subnet group.
', 'refs' => [], ], 'CacheSubnetGroupInUse' => [ 'base' => 'The requested cache subnet group is currently in use.
', 'refs' => [], ], 'CacheSubnetGroupMessage' => [ 'base' => 'Represents the output of a DescribeCacheSubnetGroups operation.
The requested cache subnet group name does not refer to an existing cache subnet group.
', 'refs' => [], ], 'CacheSubnetGroupQuotaExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the allowed number of cache subnet groups.
', 'refs' => [], ], 'CacheSubnetGroups' => [ 'base' => NULL, 'refs' => [ 'CacheSubnetGroupMessage$CacheSubnetGroups' => 'A list of cache subnet groups. Each element in the list contains detailed information about one group.
', ], ], 'CacheSubnetQuotaExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.
', 'refs' => [], ], 'CacheUsageLimits' => [ 'base' => 'The usage limits for storage and ElastiCache Processing Units for the cache.
', 'refs' => [ 'CreateServerlessCacheRequest$CacheUsageLimits' => 'Sets the cache usage limits for storage and ElastiCache Processing Units for the cache.
', 'ModifyServerlessCacheRequest$CacheUsageLimits' => 'Modify the cache usage limit for the serverless cache.
', 'ServerlessCache$CacheUsageLimits' => 'The cache usage limit for the serverless cache.
', ], ], 'ChangeType' => [ 'base' => NULL, 'refs' => [ 'CacheNodeTypeSpecificParameter$ChangeType' => 'Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window\'s reboot. For more information, see Rebooting a Cluster.
', 'Parameter$ChangeType' => 'Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window\'s reboot. For more information, see Rebooting a Cluster.
', ], ], 'CloudWatchLogsDestinationDetails' => [ 'base' => 'The configuration details of the CloudWatch Logs destination.
', 'refs' => [ 'DestinationDetails$CloudWatchLogsDetails' => 'The configuration details of the CloudWatch Logs destination.
', ], ], 'ClusterIdList' => [ 'base' => NULL, 'refs' => [ 'ReplicationGroup$MemberClusters' => 'The names of all the cache clusters that are part of this replication group.
', ], ], 'ClusterMode' => [ 'base' => NULL, 'refs' => [ 'CreateReplicationGroupMessage$ClusterMode' => 'Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
', 'ModifyReplicationGroupMessage$ClusterMode' => 'Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
', 'ReplicationGroup$ClusterMode' => 'Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
', 'ReplicationGroupPendingModifiedValues$ClusterMode' => 'Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.
', ], ], 'ClusterQuotaForCustomerExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the allowed number of clusters per customer.
', 'refs' => [], ], 'CompleteMigrationMessage' => [ 'base' => NULL, 'refs' => [], ], 'CompleteMigrationResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConfigureShard' => [ 'base' => 'Node group (shard) configuration options when adding or removing replicas. Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.
', 'refs' => [ 'ReplicaConfigurationList$member' => NULL, ], ], 'CopyServerlessCacheSnapshotRequest' => [ 'base' => NULL, 'refs' => [], ], 'CopyServerlessCacheSnapshotResponse' => [ 'base' => NULL, 'refs' => [], ], 'CopySnapshotMessage' => [ 'base' => 'Represents the input of a CopySnapshotMessage operation.
Represents the input of a CreateCacheCluster operation.
', 'refs' => [], ], 'CreateCacheClusterResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateCacheParameterGroupMessage' => [ 'base' => 'Represents the input of a CreateCacheParameterGroup operation.
Represents the input of a CreateCacheSecurityGroup operation.
Represents the input of a CreateCacheSubnetGroup operation.
Represents the input of a CreateReplicationGroup operation.
Represents the input of a CreateSnapshot operation.
The endpoint from which data should be migrated.
', 'refs' => [ 'CustomerNodeEndpointList$member' => NULL, ], ], 'CustomerNodeEndpointList' => [ 'base' => NULL, 'refs' => [ 'StartMigrationMessage$CustomerNodeEndpointList' => 'List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only one element.
', 'TestMigrationMessage$CustomerNodeEndpointList' => 'List of endpoints from which data should be migrated. List should have only one element.
', ], ], 'DataStorage' => [ 'base' => 'The data storage limit.
', 'refs' => [ 'CacheUsageLimits$DataStorage' => 'The maximum data storage limit in the cache, expressed in Gigabytes.
', ], ], 'DataStorageUnit' => [ 'base' => NULL, 'refs' => [ 'DataStorage$Unit' => 'The unit that the storage is measured in, in GB.
', ], ], 'DataTieringStatus' => [ 'base' => NULL, 'refs' => [ 'ReplicationGroup$DataTiering' => 'Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.
', 'Snapshot$DataTiering' => 'Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.
', ], ], 'DecreaseNodeGroupsInGlobalReplicationGroupMessage' => [ 'base' => NULL, 'refs' => [], ], 'DecreaseNodeGroupsInGlobalReplicationGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'DecreaseReplicaCountMessage' => [ 'base' => NULL, 'refs' => [], ], 'DecreaseReplicaCountResult' => [ 'base' => NULL, 'refs' => [], ], 'DefaultUserAssociatedToUserGroupFault' => [ 'base' => 'The default user assigned to the user group.
', 'refs' => [], ], 'DefaultUserRequired' => [ 'base' => 'You must add default user to a user group.
', 'refs' => [], ], 'DeleteCacheClusterMessage' => [ 'base' => 'Represents the input of a DeleteCacheCluster operation.
Represents the input of a DeleteCacheParameterGroup operation.
Represents the input of a DeleteCacheSecurityGroup operation.
Represents the input of a DeleteCacheSubnetGroup operation.
Represents the input of a DeleteReplicationGroup operation.
Represents the input of a DeleteSnapshot operation.
Represents the input of a DescribeCacheClusters operation.
Represents the input of a DescribeCacheEngineVersions operation.
Represents the input of a DescribeCacheParameterGroups operation.
Represents the input of a DescribeCacheParameters operation.
Represents the input of a DescribeCacheSecurityGroups operation.
Represents the input of a DescribeCacheSubnetGroups operation.
Represents the input of a DescribeEngineDefaultParameters operation.
Represents the input of a DescribeEvents operation.
Represents the input of a DescribeReplicationGroups operation.
Represents the input of a DescribeReservedCacheNodes operation.
Represents the input of a DescribeReservedCacheNodesOfferings operation.
Represents the output of a DescribeSnapshots operation.
Represents the input of a DescribeSnapshotsMessage operation.
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
', 'refs' => [ 'LogDeliveryConfiguration$DestinationDetails' => 'Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
', 'LogDeliveryConfigurationRequest$DestinationDetails' => 'Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
', 'PendingLogDeliveryConfiguration$DestinationDetails' => 'Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
', ], ], 'DestinationType' => [ 'base' => NULL, 'refs' => [ 'LogDeliveryConfiguration$DestinationType' => 'Returns the destination type, either cloudwatch-logs or kinesis-firehose.
Specify either cloudwatch-logs or kinesis-firehose as the destination type.
Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.
', ], ], 'DisassociateGlobalReplicationGroupMessage' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateGlobalReplicationGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'RecurringCharge$RecurringChargeAmount' => 'The monetary amount of the recurring charge.
', 'ReservedCacheNode$FixedPrice' => 'The fixed price charged for this reserved cache node.
', 'ReservedCacheNode$UsagePrice' => 'The hourly price charged for this reserved cache node.
', 'ReservedCacheNodesOffering$FixedPrice' => 'The fixed price charged for this offering.
', 'ReservedCacheNodesOffering$UsagePrice' => 'The hourly price charged for this offering.
', 'SlotMigration$ProgressPercentage' => 'The percentage of the slot migration that is complete.
', ], ], 'DuplicateUserNameFault' => [ 'base' => 'A user with this username already exists.
', 'refs' => [], ], 'EC2SecurityGroup' => [ 'base' => 'Provides ownership and status information for an Amazon EC2 security group.
', 'refs' => [ 'EC2SecurityGroupList$member' => NULL, ], ], 'EC2SecurityGroupList' => [ 'base' => NULL, 'refs' => [ 'CacheSecurityGroup$EC2SecurityGroups' => 'A list of Amazon EC2 security groups that are associated with this cache security group.
', ], ], 'ECPUPerSecond' => [ 'base' => 'The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.
', 'refs' => [ 'CacheUsageLimits$ECPUPerSecond' => NULL, ], ], 'Endpoint' => [ 'base' => 'Represents the information required for client programs to connect to a cache node. This value is read-only.
', 'refs' => [ 'CacheCluster$ConfigurationEndpoint' => 'Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.
Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
The hostname for connecting to this cache node.
', 'NodeGroup$PrimaryEndpoint' => 'The endpoint of the primary node in this node group (shard).
', 'NodeGroup$ReaderEndpoint' => 'The endpoint of the replica nodes in this node group (shard). This value is read-only.
', 'NodeGroupMember$ReadEndpoint' => 'The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.
', 'ReplicationGroup$ConfigurationEndpoint' => 'The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.
', 'ServerlessCache$Endpoint' => NULL, 'ServerlessCache$ReaderEndpoint' => NULL, ], ], 'EngineDefaults' => [ 'base' => 'Represents the output of a DescribeEngineDefaultParameters operation.
The current supported value is Redis.
', 'CreateUserMessage$Engine' => 'The current supported value is Redis.
', 'DescribeUsersMessage$Engine' => 'The Redis engine.
', 'User$Engine' => 'The current supported value is Redis.
', 'UserGroup$Engine' => 'The current supported value is Redis.
', ], ], 'Event' => [ 'base' => 'Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.
', 'refs' => [ 'EventList$member' => NULL, ], ], 'EventList' => [ 'base' => NULL, 'refs' => [ 'EventsMessage$Events' => 'A list of events. Each element in the list contains detailed information about one event.
', ], ], 'EventsMessage' => [ 'base' => 'Represents the output of a DescribeEvents operation.
Used to streamline results of a search based on the property being filtered.
', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeUsersMessage$Filters' => 'Filter to determine the list of User IDs to return.
', ], ], 'FilterName' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => 'The property being filtered. For example, UserId.
', ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'FilterValueList$member' => NULL, ], ], 'FilterValueList' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => 'The property values to filter on. For example, "user-123".
', ], ], 'GlobalNodeGroup' => [ 'base' => 'Indicates the slot configuration and global identifier for a slice group.
', 'refs' => [ 'GlobalNodeGroupList$member' => NULL, ], ], 'GlobalNodeGroupIdList' => [ 'base' => NULL, 'refs' => [ 'DecreaseNodeGroupsInGlobalReplicationGroupMessage$GlobalNodeGroupsToRemove' => 'If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.
', 'DecreaseNodeGroupsInGlobalReplicationGroupMessage$GlobalNodeGroupsToRetain' => 'If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache for Redis will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster.
', ], ], 'GlobalNodeGroupList' => [ 'base' => NULL, 'refs' => [ 'GlobalReplicationGroup$GlobalNodeGroups' => 'Indicates the slot configuration and global identifier for each slice group.
', ], ], 'GlobalReplicationGroup' => [ 'base' => 'Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.
The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.
The Global datastore name already exists.
', 'refs' => [], ], 'GlobalReplicationGroupInfo' => [ 'base' => 'The name of the Global datastore and role of this replication group in the Global datastore.
', 'refs' => [ 'ReplicationGroup$GlobalReplicationGroupInfo' => 'The name of the Global datastore and role of this replication group in the Global datastore.
', ], ], 'GlobalReplicationGroupList' => [ 'base' => NULL, 'refs' => [ 'DescribeGlobalReplicationGroupsResult$GlobalReplicationGroups' => 'Indicates the slot configuration and global identifier for each slice group.
', ], ], 'GlobalReplicationGroupMember' => [ 'base' => 'A member of a Global datastore. It contains the Replication Group Id, the Amazon region and the role of the replication group.
', 'refs' => [ 'GlobalReplicationGroupMemberList$member' => NULL, ], ], 'GlobalReplicationGroupMemberList' => [ 'base' => NULL, 'refs' => [ 'GlobalReplicationGroup$Members' => 'The replication groups that comprise the Global datastore.
', ], ], 'GlobalReplicationGroupNotFoundFault' => [ 'base' => 'The Global datastore does not exist
', 'refs' => [], ], 'IncreaseNodeGroupsInGlobalReplicationGroupMessage' => [ 'base' => NULL, 'refs' => [], ], 'IncreaseNodeGroupsInGlobalReplicationGroupResult' => [ 'base' => NULL, 'refs' => [], ], 'IncreaseReplicaCountMessage' => [ 'base' => NULL, 'refs' => [], ], 'IncreaseReplicaCountResult' => [ 'base' => NULL, 'refs' => [], ], 'InputAuthenticationType' => [ 'base' => NULL, 'refs' => [ 'AuthenticationMode$Type' => 'Specifies the authentication type. Possible options are IAM authentication, password and no password.
', ], ], 'InsufficientCacheClusterCapacityFault' => [ 'base' => 'The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
', 'refs' => [], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ConfigureShard$NewReplicaCount' => 'The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with.
The minimum number of replicas in a shard or replication group is:
Redis (cluster mode disabled)
If Multi-AZ: 1
If Multi-AZ: 0
Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
The number of node groups (shards) that results from the modification of the shard configuration
', 'Endpoint$Port' => 'The port number that the cache engine is listening on.
', 'IncreaseNodeGroupsInGlobalReplicationGroupMessage$NodeGroupCount' => 'Total number of node groups you want
', 'ModifyReplicationGroupShardConfigurationMessage$NodeGroupCount' => 'The number of node groups (shards) that results from the modification of the shard configuration.
', 'ReservedCacheNode$Duration' => 'The duration of the reservation in seconds.
', 'ReservedCacheNode$CacheNodeCount' => 'The number of cache nodes that have been reserved.
', 'ReservedCacheNodesOffering$Duration' => 'The duration of the offering. in seconds.
', ], ], 'IntegerOptional' => [ 'base' => NULL, 'refs' => [ 'Authentication$PasswordCount' => 'The number of passwords belonging to the user. The maximum is two.
', 'CacheCluster$NumCacheNodes' => 'The number of cache nodes in the cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
', 'CacheCluster$SnapshotRetentionLimit' => 'The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The initial number of cache nodes that the cluster has.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
', 'CreateCacheClusterMessage$Port' => 'The port number on which each of the cache nodes accepts connections.
', 'CreateCacheClusterMessage$SnapshotRetentionLimit' => 'The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted.
This parameter is only valid if the Engine parameter is redis.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
', 'CreateReplicationGroupMessage$NumCacheClusters' => 'The number of clusters this replication group initially has.
This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.
If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.
The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).
An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.
Default: 1
', 'CreateReplicationGroupMessage$ReplicasPerNodeGroup' => 'An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
', 'CreateReplicationGroupMessage$Port' => 'The port number on which each member of the replication group accepts connections.
', 'CreateReplicationGroupMessage$SnapshotRetentionLimit' => 'The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
Default: 0 (i.e., automatic backups are disabled for this cluster).
', 'CreateServerlessCacheRequest$SnapshotRetentionLimit' => 'The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.
', 'CustomerNodeEndpoint$Port' => 'The port of the node endpoint
', 'DataStorage$Maximum' => 'The upper limit for data storage the cache is set to use.
', 'DataStorage$Minimum' => 'The lower limit for data storage the cache is set to use.
', 'DecreaseReplicaCountMessage$NewReplicaCount' => 'The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group\'s node groups.
The minimum number of replicas in a shard or replication group is:
Redis (cluster mode disabled)
If Multi-AZ is enabled: 1
If Multi-AZ is not enabled: 0
Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeCacheEngineVersionsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeCacheParameterGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeCacheParametersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeCacheSecurityGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeCacheSubnetGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeEngineDefaultParametersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeEventsMessage$Duration' => 'The number of minutes worth of events to retrieve.
', 'DescribeEventsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeGlobalReplicationGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
', 'DescribeReplicationGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeReservedCacheNodesMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeReservedCacheNodesOfferingsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
', 'DescribeServerlessCacheSnapshotsRequest$MaxResults' => 'The maximum number of records to include in the response. If more records exist than the specified max-results value, a market is included in the response so that remaining results can be retrieved. Available for Redis only.The default is 50. The Validation Constraints are a maximum of 50.
', 'DescribeServerlessCachesRequest$MaxResults' => 'The maximum number of records in the response. If more records exist than the specified max-records value, the next token is included in the response so that remaining results can be retrieved. The default is 50.
', 'DescribeServiceUpdatesMessage$MaxRecords' => 'The maximum number of records to include in the response
', 'DescribeSnapshotsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
Default: 50
Constraints: minimum 20; maximum 50.
', 'DescribeUpdateActionsMessage$MaxRecords' => 'The maximum number of records to include in the response
', 'DescribeUserGroupsMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
', 'DescribeUsersMessage$MaxRecords' => 'The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.
', 'ECPUPerSecond$Maximum' => 'The configuration for the maximum number of ECPUs the cache can consume per second.
', 'ECPUPerSecond$Minimum' => 'The configuration for the minimum number of ECPUs the cache should be able consume per second.
', 'IncreaseReplicaCountMessage$NewReplicaCount' => 'The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group\'s node groups.
', 'ModifyCacheClusterMessage$NumCacheNodes' => 'The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).
A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer\'s latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
', 'ModifyServerlessCacheRequest$SnapshotRetentionLimit' => 'The number of days for which Elasticache retains automatic snapshots before deleting them. Available for Redis only. Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. The maximum value allowed is 35 days.
', 'NodeGroupConfiguration$ReplicaCount' => 'The number of read replica nodes in this node group (shard).
', 'PendingModifiedValues$NumCacheNodes' => 'The new number of cache nodes for the cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
', 'PurchaseReservedCacheNodesOfferingMessage$CacheNodeCount' => 'The number of cache node instances to reserve.
Default: 1
The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The current setting for the number of serverless cache snapshots the system will retain. Available for Redis only.
', 'Snapshot$NumCacheNodes' => 'The number of cache nodes in the source cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
', 'Snapshot$Port' => 'The port number used by each cache nodes in the source cluster.
', 'Snapshot$SnapshotRetentionLimit' => 'For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
', 'Snapshot$NumNodeGroups' => 'The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.
', ], ], 'InvalidARNFault' => [ 'base' => 'The requested Amazon Resource Name (ARN) does not refer to an existing resource.
', 'refs' => [], ], 'InvalidCacheClusterStateFault' => [ 'base' => 'The requested cluster is not in the available state.
The current state of the cache parameter group does not allow the requested operation to occur.
', 'refs' => [], ], 'InvalidCacheSecurityGroupStateFault' => [ 'base' => 'The current state of the cache security group does not allow deletion.
', 'refs' => [], ], 'InvalidCredentialsException' => [ 'base' => 'You must enter valid credentials.
', 'refs' => [], ], 'InvalidGlobalReplicationGroupStateFault' => [ 'base' => 'The Global datastore is not available or in primary-only state.
', 'refs' => [], ], 'InvalidKMSKeyFault' => [ 'base' => 'The KMS key supplied is not valid.
', 'refs' => [], ], 'InvalidParameterCombinationException' => [ 'base' => 'Two or more incompatible parameters were specified.
', 'refs' => [], ], 'InvalidParameterValueException' => [ 'base' => 'The value for a parameter is invalid.
', 'refs' => [], ], 'InvalidReplicationGroupStateFault' => [ 'base' => 'The requested replication group is not in the available state.
The state of the serverless cache snapshot was not received. Available for Redis only.
', 'refs' => [], ], 'InvalidServerlessCacheStateFault' => [ 'base' => 'The account for these credentials is not currently active.
', 'refs' => [], ], 'InvalidSnapshotStateFault' => [ 'base' => 'The current state of the snapshot does not allow the requested operation to occur.
', 'refs' => [], ], 'InvalidSubnet' => [ 'base' => 'An invalid subnet identifier was specified.
', 'refs' => [], ], 'InvalidUserGroupStateFault' => [ 'base' => 'The user group is not in an active state.
', 'refs' => [], ], 'InvalidUserStateFault' => [ 'base' => 'The user is not in active state.
', 'refs' => [], ], 'InvalidVPCNetworkStateFault' => [ 'base' => 'The VPC network is in an invalid state.
', 'refs' => [], ], 'IpDiscovery' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$IpDiscovery' => 'The network type associated with the cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The network type you choose when creating a replication group, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
A list of TagKeys identifying the tags you want removed from the named resource.
The configuration details of the Kinesis Data Firehose destination.
', 'refs' => [ 'DestinationDetails$KinesisFirehoseDetails' => 'The configuration details of the Kinesis Data Firehose destination.
', ], ], 'ListAllowedNodeTypeModificationsMessage' => [ 'base' => 'The input parameters for the ListAllowedNodeTypeModifications operation.
The input parameters for the ListTagsForResource operation.
Returns the destination, format and type of the logs.
', 'refs' => [ 'LogDeliveryConfigurationList$member' => NULL, ], ], 'LogDeliveryConfigurationList' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$LogDeliveryConfigurations' => 'Returns the destination, format and type of the logs.
', 'ReplicationGroup$LogDeliveryConfigurations' => 'Returns the destination, format and type of the logs.
', ], ], 'LogDeliveryConfigurationRequest' => [ 'base' => 'Specifies the destination, format and type of the logs.
', 'refs' => [ 'LogDeliveryConfigurationRequestList$member' => NULL, ], ], 'LogDeliveryConfigurationRequestList' => [ 'base' => NULL, 'refs' => [ 'CreateCacheClusterMessage$LogDeliveryConfigurations' => 'Specifies the destination, format and type of the logs.
', 'CreateReplicationGroupMessage$LogDeliveryConfigurations' => 'Specifies the destination, format and type of the logs.
', 'ModifyCacheClusterMessage$LogDeliveryConfigurations' => 'Specifies the destination, format and type of the logs.
', 'ModifyReplicationGroupMessage$LogDeliveryConfigurations' => 'Specifies the destination, format and type of the logs.
', ], ], 'LogDeliveryConfigurationStatus' => [ 'base' => NULL, 'refs' => [ 'LogDeliveryConfiguration$Status' => 'Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error
Returns the log format, either JSON or TEXT.
', 'LogDeliveryConfigurationRequest$LogFormat' => 'Specifies either JSON or TEXT
', 'PendingLogDeliveryConfiguration$LogFormat' => 'Returns the log format, either JSON or TEXT
', ], ], 'LogType' => [ 'base' => NULL, 'refs' => [ 'LogDeliveryConfiguration$LogType' => 'Refers to slow-log or engine-log.
', 'LogDeliveryConfigurationRequest$LogType' => 'Refers to slow-log or engine-log..
', 'PendingLogDeliveryConfiguration$LogType' => 'Refers to slow-log or engine-log..
', ], ], 'ModifyCacheClusterMessage' => [ 'base' => 'Represents the input of a ModifyCacheCluster operation.
Represents the input of a ModifyCacheParameterGroup operation.
Represents the input of a ModifyCacheSubnetGroup operation.
Represents the input of a ModifyReplicationGroups operation.
Represents the input for a ModifyReplicationGroupShardConfiguration operation.
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ
', ], ], 'NetworkType' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$NetworkType' => 'Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
Either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
The operation was not performed because no changes were required.
', 'refs' => [], ], 'NodeGroup' => [ 'base' => 'Represents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
', 'refs' => [ 'NodeGroupList$member' => NULL, ], ], 'NodeGroupConfiguration' => [ 'base' => 'Node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
The configuration for the source node group (shard).
', ], ], 'NodeGroupConfigurationList' => [ 'base' => NULL, 'refs' => [ 'CreateReplicationGroupMessage$NodeGroupConfiguration' => 'A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.
If you\'re creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.
', ], ], 'NodeGroupList' => [ 'base' => NULL, 'refs' => [ 'ReplicationGroup$NodeGroups' => 'A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).
', ], ], 'NodeGroupMember' => [ 'base' => 'Represents a single node within a node group (shard).
', 'refs' => [ 'NodeGroupMemberList$member' => NULL, ], ], 'NodeGroupMemberList' => [ 'base' => NULL, 'refs' => [ 'NodeGroup$NodeGroupMembers' => 'A list containing information about individual nodes within the node group (shard).
', ], ], 'NodeGroupMemberUpdateStatus' => [ 'base' => 'The status of the service update on the node group member
', 'refs' => [ 'NodeGroupMemberUpdateStatusList$member' => NULL, ], ], 'NodeGroupMemberUpdateStatusList' => [ 'base' => NULL, 'refs' => [ 'NodeGroupUpdateStatus$NodeGroupMemberUpdateStatus' => 'The status of the service update on the node group member
', ], ], 'NodeGroupNotFoundFault' => [ 'base' => 'The node group specified by the NodeGroupId parameter could not be found. Please verify that the node group exists and that you spelled the NodeGroupId value correctly.
The status of the service update on the node group
', 'refs' => [ 'NodeGroupUpdateStatusList$member' => NULL, ], ], 'NodeGroupUpdateStatusList' => [ 'base' => NULL, 'refs' => [ 'UpdateAction$NodeGroupUpdateStatus' => 'The status of the service update on the node group
', ], ], 'NodeGroupsPerReplicationGroupQuotaExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90
', 'refs' => [], ], 'NodeGroupsToRemoveList' => [ 'base' => NULL, 'refs' => [ 'ModifyReplicationGroupShardConfigurationMessage$NodeGroupsToRemove' => 'If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.
ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.
If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.
ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.
The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.
', 'refs' => [], ], 'NodeQuotaForCustomerExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
', 'refs' => [], ], 'NodeSnapshot' => [ 'base' => 'Represents an individual cache node in a snapshot of a cluster.
', 'refs' => [ 'NodeSnapshotList$member' => NULL, ], ], 'NodeSnapshotList' => [ 'base' => NULL, 'refs' => [ 'Snapshot$NodeSnapshots' => 'A list of the cache nodes in the source cluster.
', ], ], 'NodeTypeList' => [ 'base' => NULL, 'refs' => [ 'AllowedNodeTypeModificationsMessage$ScaleUpModifications' => 'A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.
When scaling up a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
', ], ], 'NodeUpdateInitiatedBy' => [ 'base' => NULL, 'refs' => [ 'CacheNodeUpdateStatus$NodeUpdateInitiatedBy' => 'Reflects whether the update was initiated by the customer or automatically applied
', 'NodeGroupMemberUpdateStatus$NodeUpdateInitiatedBy' => 'Reflects whether the update was initiated by the customer or automatically applied
', ], ], 'NodeUpdateStatus' => [ 'base' => NULL, 'refs' => [ 'CacheNodeUpdateStatus$NodeUpdateStatus' => 'The update status of the node
', 'NodeGroupMemberUpdateStatus$NodeUpdateStatus' => 'The update status of the node
', ], ], 'NotificationConfiguration' => [ 'base' => 'Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
', 'refs' => [ 'CacheCluster$NotificationConfiguration' => 'Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
', ], ], 'OutpostArnsList' => [ 'base' => NULL, 'refs' => [ 'NodeGroupConfiguration$ReplicaOutpostArns' => 'The outpost ARN of the node replicas.
', ], ], 'OutpostMode' => [ 'base' => NULL, 'refs' => [ 'CreateCacheClusterMessage$OutpostMode' => 'Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.
', ], ], 'Parameter' => [ 'base' => 'Describes an individual setting that controls some aspect of ElastiCache behavior.
', 'refs' => [ 'ParametersList$member' => NULL, ], ], 'ParameterNameValue' => [ 'base' => 'Describes a name-value pair that is used to update the value of a parameter.
', 'refs' => [ 'ParameterNameValueList$member' => NULL, ], ], 'ParameterNameValueList' => [ 'base' => NULL, 'refs' => [ 'ModifyCacheParameterGroupMessage$ParameterNameValues' => 'An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.
', 'ResetCacheParameterGroupMessage$ParameterNameValues' => 'An array of parameter names to reset to their default values. If ResetAllParameters is true, do not use ParameterNameValues. If ResetAllParameters is false, you must specify the name of at least one parameter to reset.
A list of Parameter instances.
', 'EngineDefaults$Parameters' => 'Contains a list of engine default parameters.
', ], ], 'PasswordListInput' => [ 'base' => NULL, 'refs' => [ 'AuthenticationMode$Passwords' => 'Specifies the passwords to use for authentication if Type is set to password.
Passwords used for this user. You can create up to two passwords for each user.
', 'ModifyUserMessage$Passwords' => 'The passwords belonging to the user. You are allowed up to two.
', ], ], 'PendingAutomaticFailoverStatus' => [ 'base' => NULL, 'refs' => [ 'ReplicationGroupPendingModifiedValues$AutomaticFailoverStatus' => 'Indicates the status of automatic failover for this Redis replication group.
', ], ], 'PendingLogDeliveryConfiguration' => [ 'base' => 'The log delivery configurations being modified
', 'refs' => [ 'PendingLogDeliveryConfigurationList$member' => NULL, ], ], 'PendingLogDeliveryConfigurationList' => [ 'base' => NULL, 'refs' => [ 'PendingModifiedValues$LogDeliveryConfigurations' => 'The log delivery configurations being modified
', 'ReplicationGroupPendingModifiedValues$LogDeliveryConfigurations' => 'The log delivery configurations being modified
', ], ], 'PendingModifiedValues' => [ 'base' => 'A group of settings that are applied to the cluster in the future, or that are currently being applied.
', 'refs' => [ 'CacheCluster$PendingModifiedValues' => NULL, ], ], 'PreferredAvailabilityZoneList' => [ 'base' => NULL, 'refs' => [ 'ConfigureShard$PreferredAvailabilityZones' => 'A list of PreferredAvailabilityZone strings that specify which availability zones the replication group\'s nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.
A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.
This option is only supported on Memcached.
If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of NumCacheNodes.
If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
', 'ModifyCacheClusterMessage$NewAvailabilityZones' => 'This option is only supported on Memcached clusters.
The list of Availability Zones where the new Memcached cache nodes are created.
This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.
Scenarios:
Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.
Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.
Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.
The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.
If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.
Impact of new add/remove requests upon pending requests
Scenario-1
Pending Action: Delete
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending delete.
Scenario-2
Pending Action: Delete
New Request: Create
Result: The new create, pending or immediate, replaces the pending delete.
Scenario-3
Pending Action: Create
New Request: Delete
Result: The new delete, pending or immediate, replaces the pending create.
Scenario-4
Pending Action: Create
New Request: Create
Result: The new create is added to the pending create.
Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
The outpost ARNs in which the cache cluster is created.
', 'CreateCacheClusterMessage$PreferredOutpostArns' => 'The outpost ARNs in which the cache cluster is created.
', ], ], 'ProcessedUpdateAction' => [ 'base' => 'Update action that has been processed for the corresponding apply/stop request
', 'refs' => [ 'ProcessedUpdateActionList$member' => NULL, ], ], 'ProcessedUpdateActionList' => [ 'base' => NULL, 'refs' => [ 'UpdateActionResultsMessage$ProcessedUpdateActions' => 'Update actions that have been processed successfully
', ], ], 'PurchaseReservedCacheNodesOfferingMessage' => [ 'base' => 'Represents the input of a PurchaseReservedCacheNodesOffering operation.
Represents the input of a RebootCacheCluster operation.
Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.
', 'refs' => [ 'RecurringChargeList$member' => NULL, ], ], 'RecurringChargeList' => [ 'base' => NULL, 'refs' => [ 'ReservedCacheNode$RecurringCharges' => 'The recurring price charged to run this reserved cache node.
', 'ReservedCacheNodesOffering$RecurringCharges' => 'The recurring price charged to run this reserved cache node.
', ], ], 'RegionalConfiguration' => [ 'base' => 'A list of the replication groups
', 'refs' => [ 'RegionalConfigurationList$member' => NULL, ], ], 'RegionalConfigurationList' => [ 'base' => NULL, 'refs' => [ 'IncreaseNodeGroupsInGlobalReplicationGroupMessage$RegionalConfigurations' => 'Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore
', ], ], 'RemoveReplicasList' => [ 'base' => NULL, 'refs' => [ 'DecreaseReplicaCountMessage$ReplicasToRemove' => 'A list of the node ids to remove from the replication group or node group (shard).
', ], ], 'RemoveTagsFromResourceMessage' => [ 'base' => 'Represents the input of a RemoveTagsFromResource operation.
A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.
Contains all of the attributes of a specific Redis replication group.
', 'refs' => [ 'CompleteMigrationResponse$ReplicationGroup' => NULL, 'CreateReplicationGroupResult$ReplicationGroup' => NULL, 'DecreaseReplicaCountResult$ReplicationGroup' => NULL, 'DeleteReplicationGroupResult$ReplicationGroup' => NULL, 'IncreaseReplicaCountResult$ReplicationGroup' => NULL, 'ModifyReplicationGroupResult$ReplicationGroup' => NULL, 'ModifyReplicationGroupShardConfigurationResult$ReplicationGroup' => NULL, 'ReplicationGroupList$member' => NULL, 'StartMigrationResponse$ReplicationGroup' => NULL, 'TestFailoverResult$ReplicationGroup' => NULL, 'TestMigrationResponse$ReplicationGroup' => NULL, ], ], 'ReplicationGroupAlreadyExistsFault' => [ 'base' => 'The specified replication group already exists.
', 'refs' => [], ], 'ReplicationGroupAlreadyUnderMigrationFault' => [ 'base' => 'The targeted replication group is not available.
', 'refs' => [], ], 'ReplicationGroupIdList' => [ 'base' => NULL, 'refs' => [ 'BatchApplyUpdateActionMessage$ReplicationGroupIds' => 'The replication group IDs
', 'BatchStopUpdateActionMessage$ReplicationGroupIds' => 'The replication group IDs
', 'DescribeUpdateActionsMessage$ReplicationGroupIds' => 'The replication group IDs
', ], ], 'ReplicationGroupList' => [ 'base' => NULL, 'refs' => [ 'ReplicationGroupMessage$ReplicationGroups' => 'A list of replication groups. Each item in the list contains detailed information about one replication group.
', ], ], 'ReplicationGroupMessage' => [ 'base' => 'Represents the output of a DescribeReplicationGroups operation.
The specified replication group does not exist.
', 'refs' => [], ], 'ReplicationGroupNotUnderMigrationFault' => [ 'base' => 'The designated replication group is not available for data migration.
', 'refs' => [], ], 'ReplicationGroupOutpostArnList' => [ 'base' => NULL, 'refs' => [ 'ReplicationGroup$MemberClustersOutpostArns' => 'The outpost ARNs of the replication group\'s member clusters.
', ], ], 'ReplicationGroupPendingModifiedValues' => [ 'base' => 'The settings to be applied to the Redis replication group, either immediately or during the next maintenance window.
', 'refs' => [ 'ReplicationGroup$PendingModifiedValues' => 'A group of settings to be applied to the replication group, either immediately or during the next maintenance window.
', ], ], 'ReservedCacheNode' => [ 'base' => 'Represents the output of a PurchaseReservedCacheNodesOffering operation.
You already have a reservation with the given identifier.
', 'refs' => [], ], 'ReservedCacheNodeList' => [ 'base' => NULL, 'refs' => [ 'ReservedCacheNodeMessage$ReservedCacheNodes' => 'A list of reserved cache nodes. Each element in the list contains detailed information about one node.
', ], ], 'ReservedCacheNodeMessage' => [ 'base' => 'Represents the output of a DescribeReservedCacheNodes operation.
The requested reserved cache node was not found.
', 'refs' => [], ], 'ReservedCacheNodeQuotaExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the user\'s cache node quota.
', 'refs' => [], ], 'ReservedCacheNodesOffering' => [ 'base' => 'Describes all of the attributes of a reserved cache node offering.
', 'refs' => [ 'ReservedCacheNodesOfferingList$member' => NULL, ], ], 'ReservedCacheNodesOfferingList' => [ 'base' => NULL, 'refs' => [ 'ReservedCacheNodesOfferingMessage$ReservedCacheNodesOfferings' => 'A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.
', ], ], 'ReservedCacheNodesOfferingMessage' => [ 'base' => 'Represents the output of a DescribeReservedCacheNodesOfferings operation.
The requested cache node offering does not exist.
', 'refs' => [], ], 'ResetCacheParameterGroupMessage' => [ 'base' => 'Represents the input of a ResetCacheParameterGroup operation.
A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster\'s shards. If you omit this parameter ElastiCache selects availability zones for you.
You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).
A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
The status of an online resharding operation.
', 'refs' => [ 'ReplicationGroupPendingModifiedValues$Resharding' => 'The status of an online resharding operation.
', ], ], 'RevokeCacheSecurityGroupIngressMessage' => [ 'base' => 'Represents the input of a RevokeCacheSecurityGroupIngress operation.
One or more VPC security groups associated with the cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
', 'CreateReplicationGroupMessage$SecurityGroupIds' => 'One or more Amazon VPC security groups associated with this replication group.
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
', 'CreateServerlessCacheRequest$SecurityGroupIds' => 'A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.
', 'ModifyCacheClusterMessage$SecurityGroupIds' => 'Specifies the VPC Security Groups associated with the cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
', 'ModifyReplicationGroupMessage$SecurityGroupIds' => 'Specifies the VPC Security Groups associated with the clusters in the replication group.
This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).
', 'ModifyServerlessCacheRequest$SecurityGroupIds' => 'The new list of VPC security groups to be associated with the serverless cache. Populating this list means the current VPC security groups will be removed. This security group is used to authorize traffic access for the VPC end-point (private-link). Default = NULL - the existing list of VPC security groups is not removed.
', 'ServerlessCache$SecurityGroupIds' => 'The IDs of the EC2 security groups associated with the serverless cache.
', ], ], 'SecurityGroupMembership' => [ 'base' => 'Represents a single cache security group and its status.
', 'refs' => [ 'SecurityGroupMembershipList$member' => NULL, ], ], 'SecurityGroupMembershipList' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$SecurityGroups' => 'A list of VPC Security Groups associated with the cluster.
', ], ], 'ServerlessCache' => [ 'base' => 'The resource representing a serverless cache.
', 'refs' => [ 'CreateServerlessCacheResponse$ServerlessCache' => 'The response for the attempt to create the serverless cache.
', 'DeleteServerlessCacheResponse$ServerlessCache' => 'Provides the details of the specified serverless cache that is about to be deleted.
', 'ModifyServerlessCacheResponse$ServerlessCache' => 'The response for the attempt to modify the serverless cache.
', 'ServerlessCacheList$member' => NULL, ], ], 'ServerlessCacheAlreadyExistsFault' => [ 'base' => 'A serverless cache with this name already exists.
', 'refs' => [], ], 'ServerlessCacheConfiguration' => [ 'base' => 'The configuration settings for a specific serverless cache.
', 'refs' => [ 'ServerlessCacheSnapshot$ServerlessCacheConfiguration' => 'The configuration of the serverless cache, at the time the snapshot was taken. Available for Redis only.
', ], ], 'ServerlessCacheList' => [ 'base' => NULL, 'refs' => [ 'DescribeServerlessCachesResponse$ServerlessCaches' => 'The serverless caches associated with a given description request.
', ], ], 'ServerlessCacheNotFoundFault' => [ 'base' => 'The serverless cache was not found or does not exist.
', 'refs' => [], ], 'ServerlessCacheQuotaForCustomerExceededFault' => [ 'base' => 'The number of serverless caches exceeds the customer quota.
', 'refs' => [], ], 'ServerlessCacheSnapshot' => [ 'base' => 'The resource representing a serverless cache snapshot. Available for Redis only.
', 'refs' => [ 'CopyServerlessCacheSnapshotResponse$ServerlessCacheSnapshot' => 'The response for the attempt to copy the serverless cache snapshot. Available for Redis only.
', 'CreateServerlessCacheSnapshotResponse$ServerlessCacheSnapshot' => 'The state of a serverless cache snapshot at a specific point in time, to the millisecond. Available for Redis only.
', 'DeleteServerlessCacheSnapshotResponse$ServerlessCacheSnapshot' => 'The snapshot to be deleted. Available for Redis only.
', 'ExportServerlessCacheSnapshotResponse$ServerlessCacheSnapshot' => 'The state of a serverless cache at a specific point in time, to the millisecond. Available for Redis only.
', 'ServerlessCacheSnapshotList$member' => NULL, ], ], 'ServerlessCacheSnapshotAlreadyExistsFault' => [ 'base' => 'A serverless cache snapshot with this name already exists. Available for Redis only.
', 'refs' => [], ], 'ServerlessCacheSnapshotList' => [ 'base' => NULL, 'refs' => [ 'DescribeServerlessCacheSnapshotsResponse$ServerlessCacheSnapshots' => 'The serverless caches snapshots associated with a given description request. Available for Redis only.
', ], ], 'ServerlessCacheSnapshotNotFoundFault' => [ 'base' => 'This serverless cache snapshot could not be found or does not exist. Available for Redis only.
', 'refs' => [], ], 'ServerlessCacheSnapshotQuotaExceededFault' => [ 'base' => 'The number of serverless cache snapshots exceeds the customer snapshot quota. Available for Redis only.
', 'refs' => [], ], 'ServiceLinkedRoleNotFoundFault' => [ 'base' => 'The specified service linked role (SLR) was not found.
', 'refs' => [], ], 'ServiceUpdate' => [ 'base' => 'An update that you can apply to your Redis clusters.
', 'refs' => [ 'ServiceUpdateList$member' => NULL, ], ], 'ServiceUpdateList' => [ 'base' => NULL, 'refs' => [ 'ServiceUpdatesMessage$ServiceUpdates' => 'A list of service updates
', ], ], 'ServiceUpdateNotFoundFault' => [ 'base' => 'The service update doesn\'t exist
', 'refs' => [], ], 'ServiceUpdateSeverity' => [ 'base' => NULL, 'refs' => [ 'ServiceUpdate$ServiceUpdateSeverity' => 'The severity of the service update
', 'UpdateAction$ServiceUpdateSeverity' => 'The severity of the service update
', ], ], 'ServiceUpdateStatus' => [ 'base' => NULL, 'refs' => [ 'ServiceUpdate$ServiceUpdateStatus' => 'The status of the service update
', 'ServiceUpdateStatusList$member' => NULL, 'UpdateAction$ServiceUpdateStatus' => 'The status of the service update
', ], ], 'ServiceUpdateStatusList' => [ 'base' => NULL, 'refs' => [ 'DescribeServiceUpdatesMessage$ServiceUpdateStatus' => 'The status of the service update
', 'DescribeUpdateActionsMessage$ServiceUpdateStatus' => 'The status of the service update
', ], ], 'ServiceUpdateType' => [ 'base' => NULL, 'refs' => [ 'ServiceUpdate$ServiceUpdateType' => 'Reflects the nature of the service update
', 'UpdateAction$ServiceUpdateType' => 'Reflects the nature of the service update
', ], ], 'ServiceUpdatesMessage' => [ 'base' => NULL, 'refs' => [], ], 'SlaMet' => [ 'base' => NULL, 'refs' => [ 'UpdateAction$SlaMet' => 'If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the recommended apply-by date.
', ], ], 'SlotMigration' => [ 'base' => 'Represents the progress of an online resharding operation.
', 'refs' => [ 'ReshardingStatus$SlotMigration' => 'Represents the progress of an online resharding operation.
', ], ], 'Snapshot' => [ 'base' => 'Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
', 'refs' => [ 'CopySnapshotResult$Snapshot' => NULL, 'CreateSnapshotResult$Snapshot' => NULL, 'DeleteSnapshotResult$Snapshot' => NULL, 'SnapshotList$member' => NULL, ], ], 'SnapshotAlreadyExistsFault' => [ 'base' => 'You already have a snapshot with the given name.
', 'refs' => [], ], 'SnapshotArnsList' => [ 'base' => NULL, 'refs' => [ 'CreateCacheClusterMessage$SnapshotArns' => 'A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.
This parameter is only valid if the Engine parameter is redis.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.
', ], ], 'SnapshotFeatureNotSupportedFault' => [ 'base' => 'You attempted one of the following operations:
Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.
Creating a snapshot of a cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
', 'refs' => [], ], 'SnapshotList' => [ 'base' => NULL, 'refs' => [ 'DescribeSnapshotsListMessage$Snapshots' => 'A list of snapshots. Each item in the list contains detailed information about one snapshot.
', ], ], 'SnapshotNotFoundFault' => [ 'base' => 'The requested snapshot name does not refer to an existing snapshot.
', 'refs' => [], ], 'SnapshotQuotaExceededFault' => [ 'base' => 'The request cannot be processed because it would exceed the maximum number of snapshots.
', 'refs' => [], ], 'SourceType' => [ 'base' => NULL, 'refs' => [ 'DescribeEventsMessage$SourceType' => 'The event source to retrieve events for. If no value is specified, all events are returned.
', 'Event$SourceType' => 'Specifies the origin of this event - a cluster, a parameter group, a security group, etc.
', ], ], 'StartMigrationMessage' => [ 'base' => NULL, 'refs' => [], ], 'StartMigrationResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AddTagsToResourceMessage$ResourceName' => 'The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache resources are cluster and snapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.
', 'AuthorizeCacheSecurityGroupIngressMessage$CacheSecurityGroupName' => 'The cache security group that allows network ingress.
', 'AuthorizeCacheSecurityGroupIngressMessage$EC2SecurityGroupName' => 'The Amazon EC2 security group to be authorized for ingress to the cache security group.
', 'AuthorizeCacheSecurityGroupIngressMessage$EC2SecurityGroupOwnerId' => 'The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter.
', 'AvailabilityZone$Name' => 'The name of the Availability Zone.
', 'AvailabilityZonesList$member' => NULL, 'BatchApplyUpdateActionMessage$ServiceUpdateName' => 'The unique ID of the service update
', 'BatchStopUpdateActionMessage$ServiceUpdateName' => 'The unique ID of the service update
', 'CacheCluster$CacheClusterId' => 'The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.
', 'CacheCluster$ClientDownloadLandingPage' => 'The URL of the web page where you can download the latest ElastiCache client library.
', 'CacheCluster$CacheNodeType' => 'The name of the compute and memory capacity node type for the cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
The name of the cache engine (memcached or redis) to be used for this cluster.
The version of the cache engine that is used in this cluster.
', 'CacheCluster$CacheClusterStatus' => 'The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.
The name of the Availability Zone in which the cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.
', 'CacheCluster$PreferredOutpostArn' => 'The outpost ARN in which the cache cluster is created.
', 'CacheCluster$PreferredMaintenanceWindow' => 'Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
The name of the cache subnet group associated with the cluster.
', 'CacheCluster$ReplicationGroupId' => 'The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.
', 'CacheCluster$SnapshotWindow' => 'The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
Example: 05:00-09:00
The ARN (Amazon Resource Name) of the cache cluster.
', 'CacheClusterIdList$member' => NULL, 'CacheClusterMessage$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'CacheEngineVersion$Engine' => 'The name of the cache engine.
', 'CacheEngineVersion$EngineVersion' => 'The version number of the cache engine.
', 'CacheEngineVersion$CacheParameterGroupFamily' => 'The name of the cache parameter group family associated with this cache engine.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7
The description of the cache engine.
', 'CacheEngineVersion$CacheEngineVersionDescription' => 'The description of the cache engine version.
', 'CacheEngineVersionMessage$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'CacheNode$CacheNodeId' => 'The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer\'s Amazon account.
', 'CacheNode$CacheNodeStatus' => 'The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.
The status of the parameter group applied to this cache node.
', 'CacheNode$SourceCacheNodeId' => 'The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.
', 'CacheNode$CustomerAvailabilityZone' => 'The Availability Zone where this node was created and now resides.
', 'CacheNode$CustomerOutpostArn' => 'The customer outpost ARN of the cache node.
', 'CacheNodeIdsList$member' => NULL, 'CacheNodeTypeSpecificParameter$ParameterName' => 'The name of the parameter.
', 'CacheNodeTypeSpecificParameter$Description' => 'A description of the parameter.
', 'CacheNodeTypeSpecificParameter$Source' => 'The source of the parameter value.
', 'CacheNodeTypeSpecificParameter$DataType' => 'The valid data type for the parameter.
', 'CacheNodeTypeSpecificParameter$AllowedValues' => 'The valid range of values for the parameter.
', 'CacheNodeTypeSpecificParameter$MinimumEngineVersion' => 'The earliest cache engine version to which the parameter can apply.
', 'CacheNodeTypeSpecificValue$CacheNodeType' => 'The cache node type for which this value applies.
', 'CacheNodeTypeSpecificValue$Value' => 'The value for the cache node type.
', 'CacheNodeUpdateStatus$CacheNodeId' => 'The node ID of the cache cluster
', 'CacheParameterGroup$CacheParameterGroupName' => 'The name of the cache parameter group.
', 'CacheParameterGroup$CacheParameterGroupFamily' => 'The name of the cache parameter group family that this cache parameter group is compatible with.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7
The description for this cache parameter group.
', 'CacheParameterGroup$ARN' => 'The ARN (Amazon Resource Name) of the cache parameter group.
', 'CacheParameterGroupDetails$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'CacheParameterGroupNameMessage$CacheParameterGroupName' => 'The name of the cache parameter group.
', 'CacheParameterGroupStatus$CacheParameterGroupName' => 'The name of the cache parameter group.
', 'CacheParameterGroupStatus$ParameterApplyStatus' => 'The status of parameter updates.
', 'CacheParameterGroupsMessage$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'CacheSecurityGroup$OwnerId' => 'The Amazon account ID of the cache security group owner.
', 'CacheSecurityGroup$CacheSecurityGroupName' => 'The name of the cache security group.
', 'CacheSecurityGroup$Description' => 'The description of the cache security group.
', 'CacheSecurityGroup$ARN' => 'The ARN of the cache security group,
', 'CacheSecurityGroupMembership$CacheSecurityGroupName' => 'The name of the cache security group.
', 'CacheSecurityGroupMembership$Status' => 'The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cluster are modified.
', 'CacheSecurityGroupMessage$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'CacheSecurityGroupNameList$member' => NULL, 'CacheSubnetGroup$CacheSubnetGroupName' => 'The name of the cache subnet group.
', 'CacheSubnetGroup$CacheSubnetGroupDescription' => 'The description of the cache subnet group.
', 'CacheSubnetGroup$VpcId' => 'The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
', 'CacheSubnetGroup$ARN' => 'The ARN (Amazon Resource Name) of the cache subnet group.
', 'CacheSubnetGroupMessage$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'CloudWatchLogsDestinationDetails$LogGroup' => 'The name of the CloudWatch Logs log group.
', 'ClusterIdList$member' => NULL, 'CompleteMigrationMessage$ReplicationGroupId' => 'The ID of the replication group to which data is being migrated.
', 'CopyServerlessCacheSnapshotRequest$SourceServerlessCacheSnapshotName' => 'The identifier of the existing serverless cache’s snapshot to be copied. Available for Redis only.
', 'CopyServerlessCacheSnapshotRequest$TargetServerlessCacheSnapshotName' => 'The identifier for the snapshot to be created. Available for Redis only.
', 'CopyServerlessCacheSnapshotRequest$KmsKeyId' => 'The identifier of the KMS key used to encrypt the target snapshot. Available for Redis only.
', 'CopySnapshotMessage$SourceSnapshotName' => 'The name of an existing snapshot from which to make a copy.
', 'CopySnapshotMessage$TargetSnapshotName' => 'A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
', 'CopySnapshotMessage$TargetBucket' => 'The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.
When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.
For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.
', 'CopySnapshotMessage$KmsKeyId' => 'The ID of the KMS key used to encrypt the target snapshot.
', 'CreateCacheClusterMessage$CacheClusterId' => 'The node group (shard) identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 50 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.
The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.
If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.
This parameter is only valid if the Engine parameter is redis.
The EC2 Availability Zone in which the cluster is created.
All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.
Default: System chosen Availability Zone.
', 'CreateCacheClusterMessage$CacheNodeType' => 'The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
The name of the cache engine to be used for this cluster.
Valid values for this parameter are: memcached | redis
The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
', 'CreateCacheClusterMessage$CacheParameterGroupName' => 'The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled=\'yes\' when creating a cluster.
The name of the subnet group to be used for the cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
If you\'re going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.
This parameter is only valid if the Engine parameter is redis.
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
', 'CreateCacheClusterMessage$NotificationTopicArn' => 'The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
The Amazon SNS topic owner must be the same as the cluster owner.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
This parameter is only valid if the Engine parameter is redis.
Reserved parameter. The password used to access a password protected server.
Password constraints:
Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password at http://redis.io/commands/AUTH.
', 'CreateCacheClusterMessage$PreferredOutpostArn' => 'The outpost ARN in which the cache cluster is created.
', 'CreateCacheParameterGroupMessage$CacheParameterGroupName' => 'A user-specified name for the cache parameter group.
', 'CreateCacheParameterGroupMessage$CacheParameterGroupFamily' => 'The name of the cache parameter group family that the cache parameter group can be used with.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7
A user-specified description for the cache parameter group.
', 'CreateCacheSecurityGroupMessage$CacheSecurityGroupName' => 'A name for the cache security group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default".
Example: mysecuritygroup
A description for the cache security group.
', 'CreateCacheSubnetGroupMessage$CacheSubnetGroupName' => 'A name for the cache subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
A description for the cache subnet group.
', 'CreateGlobalReplicationGroupMessage$GlobalReplicationGroupIdSuffix' => 'The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with "dsdfu" along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions.
For a full list of Amazon Regions and their respective Global datastore iD prefixes, see Using the Amazon CLI with Global datastores .
', 'CreateGlobalReplicationGroupMessage$GlobalReplicationGroupDescription' => 'Provides details of the Global datastore
', 'CreateGlobalReplicationGroupMessage$PrimaryReplicationGroupId' => 'The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.
', 'CreateReplicationGroupMessage$ReplicationGroupId' => 'The replication group identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 40 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.
A user-created description for the replication group.
', 'CreateReplicationGroupMessage$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'CreateReplicationGroupMessage$PrimaryClusterId' => 'The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.
This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.
The compute and memory capacity of the nodes in the node group (shard).
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
The name of the cache engine to be used for the clusters in this replication group. The value must be set to Redis.
The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
', 'CreateReplicationGroupMessage$CacheParameterGroupName' => 'The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.
To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.
To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.
The name of the cache subnet group to be used for the replication group.
If you\'re going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
The Amazon SNS topic owner must be the same as the cluster owner.
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
', 'CreateReplicationGroupMessage$AuthToken' => 'Reserved parameter. The password used to access a password protected server.
AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.
For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.
Password constraints:
Must be only printable ASCII characters.
Must be at least 16 characters and no more than 128 characters in length.
The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password at http://redis.io/commands/AUTH.
', 'CreateReplicationGroupMessage$KmsKeyId' => 'The ID of the KMS key used to encrypt the disk in the cluster.
', 'CreateReplicationGroupMessage$ServerlessCacheSnapshotName' => 'The name of the snapshot used to create a replication group. Available for Redis only.
', 'CreateServerlessCacheRequest$ServerlessCacheName' => 'User-provided identifier for the serverless cache. This parameter is stored as a lowercase string.
', 'CreateServerlessCacheRequest$Description' => 'User-provided description for the serverless cache. The default is NULL, i.e. if no description is provided then an empty string will be returned. The maximum length is 255 characters.
', 'CreateServerlessCacheRequest$Engine' => 'The name of the cache engine to be used for creating the serverless cache.
', 'CreateServerlessCacheRequest$MajorEngineVersion' => 'The version of the cache engine that will be used to create the serverless cache.
', 'CreateServerlessCacheRequest$KmsKeyId' => 'ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.
', 'CreateServerlessCacheRequest$UserGroupId' => 'The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.
', 'CreateServerlessCacheRequest$DailySnapshotTime' => 'The daily time that snapshots will be created from the new serverless cache. By default this number is populated with 0, i.e. no snapshots will be created on an automatic daily basis. Available for Redis only.
', 'CreateServerlessCacheSnapshotRequest$ServerlessCacheSnapshotName' => 'The name for the snapshot being created. Must be unique for the customer account. Available for Redis only. Must be between 1 and 255 characters.
', 'CreateServerlessCacheSnapshotRequest$ServerlessCacheName' => 'The name of an existing serverless cache. The snapshot is created from this cache. Available for Redis only.
', 'CreateServerlessCacheSnapshotRequest$KmsKeyId' => 'The ID of the KMS key used to encrypt the snapshot. Available for Redis only. Default: NULL
', 'CreateSnapshotMessage$ReplicationGroupId' => 'The identifier of an existing replication group. The snapshot is created from this replication group.
', 'CreateSnapshotMessage$CacheClusterId' => 'The identifier of an existing cluster. The snapshot is created from this cluster.
', 'CreateSnapshotMessage$SnapshotName' => 'A name for the snapshot being created.
', 'CreateSnapshotMessage$KmsKeyId' => 'The ID of the KMS key used to encrypt the snapshot.
', 'CreateUserGroupMessage$UserGroupId' => 'The ID of the user group.
', 'CustomerNodeEndpoint$Address' => 'The address of the node endpoint
', 'DecreaseNodeGroupsInGlobalReplicationGroupMessage$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'DecreaseReplicaCountMessage$ReplicationGroupId' => 'The id of the replication group from which you want to remove replica nodes.
', 'DeleteCacheClusterMessage$CacheClusterId' => 'The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.
', 'DeleteCacheClusterMessage$FinalSnapshotIdentifier' => 'The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.
', 'DeleteCacheParameterGroupMessage$CacheParameterGroupName' => 'The name of the cache parameter group to delete.
The specified cache security group must not be associated with any clusters.
The name of the cache security group to delete.
You cannot delete the default security group.
The name of the cache subnet group to delete.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
', 'DeleteGlobalReplicationGroupMessage$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'DeleteReplicationGroupMessage$ReplicationGroupId' => 'The identifier for the cluster to be deleted. This parameter is not case sensitive.
', 'DeleteReplicationGroupMessage$FinalSnapshotIdentifier' => 'The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.
', 'DeleteServerlessCacheRequest$ServerlessCacheName' => 'The identifier of the serverless cache to be deleted.
', 'DeleteServerlessCacheRequest$FinalSnapshotName' => 'Name of the final snapshot to be taken before the serverless cache is deleted. Available for Redis only. Default: NULL, i.e. a final snapshot is not taken.
', 'DeleteServerlessCacheSnapshotRequest$ServerlessCacheSnapshotName' => 'Idenfitier of the snapshot to be deleted. Available for Redis only.
', 'DeleteSnapshotMessage$SnapshotName' => 'The name of the snapshot to be deleted.
', 'DeleteUserGroupMessage$UserGroupId' => 'The ID of the user group.
', 'DescribeCacheClustersMessage$CacheClusterId' => 'The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn\'t case sensitive.
', 'DescribeCacheClustersMessage$Marker' => '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.
The cache engine to return. Valid values: memcached | redis
The cache engine version to return.
Example: 1.4.14
The name of a specific cache parameter group family to return details for.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
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.
The name of a specific cache parameter group to return details for.
', 'DescribeCacheParameterGroupsMessage$Marker' => '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.
The name of a specific cache parameter group to return details for.
', 'DescribeCacheParametersMessage$Source' => 'The parameter types to return.
Valid values: user | system | engine-default
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.
The name of the cache security group to return details for.
', 'DescribeCacheSecurityGroupsMessage$Marker' => '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.
The name of the cache subnet group to return details for.
', 'DescribeCacheSubnetGroupsMessage$Marker' => '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.
The name of the cache parameter group family.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7
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.
The identifier of the event source for which events are returned. If not specified, all sources are included in the response.
', 'DescribeEventsMessage$Marker' => '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.
The name of the Global datastore
', 'DescribeGlobalReplicationGroupsMessage$Marker' => '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.
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. >
', 'DescribeReplicationGroupsMessage$ReplicationGroupId' => 'The identifier for the replication group to be described. This parameter is not case sensitive.
If you do not specify this parameter, information about all replication groups is returned.
', 'DescribeReplicationGroupsMessage$Marker' => '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.
The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
', 'DescribeReservedCacheNodesMessage$ReservedCacheNodesOfferingId' => 'The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.
', 'DescribeReservedCacheNodesMessage$CacheNodeType' => 'The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Use this parameter to show only those reservations matching the specified product description.
', 'DescribeReservedCacheNodesMessage$OfferingType' => 'The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.
Valid values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"
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.
The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Use this parameter to show only the available offerings matching the specified product description.
', 'DescribeReservedCacheNodesOfferingsMessage$OfferingType' => 'The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Light Utilization"|"Medium Utilization"|"Heavy Utilization" |"All Upfront"|"Partial Upfront"| "No Upfront"
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.
The identifier of serverless cache. If this parameter is specified, only snapshots associated with that specific serverless cache are described. Available for Redis only.
', 'DescribeServerlessCacheSnapshotsRequest$ServerlessCacheSnapshotName' => 'The identifier of the serverless cache’s snapshot. If this parameter is specified, only this snapshot is described. Available for Redis only.
', 'DescribeServerlessCacheSnapshotsRequest$SnapshotType' => 'The type of snapshot that is being described. Available for Redis only.
', 'DescribeServerlessCacheSnapshotsRequest$NextToken' => 'An optional marker returned from a prior request to support 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 max-results. Available for Redis only.
', 'DescribeServerlessCacheSnapshotsResponse$NextToken' => 'An optional marker returned from a prior request to support 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 max-results. Available for Redis only.
', 'DescribeServerlessCachesRequest$ServerlessCacheName' => 'The identifier for the serverless cache. If this parameter is specified, only information about that specific serverless cache is returned. Default: NULL
', 'DescribeServerlessCachesRequest$NextToken' => 'An optional marker returned from a prior request to support 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 MaxResults.
', 'DescribeServerlessCachesResponse$NextToken' => 'An optional marker returned from a prior request to support 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 MaxResults.
', 'DescribeServiceUpdatesMessage$ServiceUpdateName' => 'The unique ID of the service update
', 'DescribeServiceUpdatesMessage$Marker' => '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.
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.
A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.
', 'DescribeSnapshotsMessage$CacheClusterId' => 'A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
', 'DescribeSnapshotsMessage$SnapshotName' => 'A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
', 'DescribeSnapshotsMessage$SnapshotSource' => 'If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
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.
The unique ID of the service update
', 'DescribeUpdateActionsMessage$Engine' => 'The Elasticache engine to which the update applies. Either Redis or Memcached
', 'DescribeUpdateActionsMessage$Marker' => '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.
The ID of the user group.
', 'DescribeUserGroupsMessage$Marker' => '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. >
', 'DescribeUserGroupsResult$Marker' => '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.>
', 'DescribeUsersMessage$Marker' => '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. >
', 'DescribeUsersResult$Marker' => '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. >
', 'DisassociateGlobalReplicationGroupMessage$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'DisassociateGlobalReplicationGroupMessage$ReplicationGroupId' => 'The name of the secondary cluster you wish to remove from the Global datastore
', 'DisassociateGlobalReplicationGroupMessage$ReplicationGroupRegion' => 'The Amazon region of secondary cluster you wish to remove from the Global datastore
', 'EC2SecurityGroup$Status' => 'The status of the Amazon EC2 security group.
', 'EC2SecurityGroup$EC2SecurityGroupName' => 'The name of the Amazon EC2 security group.
', 'EC2SecurityGroup$EC2SecurityGroupOwnerId' => 'The Amazon account ID of the Amazon EC2 security group owner.
', 'Endpoint$Address' => 'The DNS hostname of the cache node.
', 'EngineDefaults$CacheParameterGroupFamily' => 'Specifies the name of the cache parameter group family to which the engine default parameters apply.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.0 | redis6.x | redis7
Provides an identifier to allow retrieval of paginated results.
', 'Event$SourceIdentifier' => 'The identifier for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.
', 'Event$Message' => 'The text of the event.
', 'EventsMessage$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'ExportServerlessCacheSnapshotRequest$ServerlessCacheSnapshotName' => 'The identifier of the serverless cache snapshot to be exported to S3. Available for Redis only.
', 'ExportServerlessCacheSnapshotRequest$S3BucketName' => 'Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3 bucket must also be in same region as the snapshot. Available for Redis only.
', 'FailoverGlobalReplicationGroupMessage$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'FailoverGlobalReplicationGroupMessage$PrimaryRegion' => 'The Amazon region of the primary cluster of the Global datastore
', 'FailoverGlobalReplicationGroupMessage$PrimaryReplicationGroupId' => 'The name of the primary replication group
', 'GlobalNodeGroup$GlobalNodeGroupId' => 'The name of the global node group
', 'GlobalNodeGroup$Slots' => 'The keyspace for this node group
', 'GlobalNodeGroupIdList$member' => NULL, 'GlobalReplicationGroup$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'GlobalReplicationGroup$GlobalReplicationGroupDescription' => 'The optional description of the Global datastore
', 'GlobalReplicationGroup$Status' => 'The status of the Global datastore
', 'GlobalReplicationGroup$CacheNodeType' => 'The cache node type of the Global datastore
', 'GlobalReplicationGroup$Engine' => 'The Elasticache engine. For Redis only.
', 'GlobalReplicationGroup$EngineVersion' => 'The Elasticache Redis engine version.
', 'GlobalReplicationGroup$ARN' => 'The ARN (Amazon Resource Name) of the global replication group.
', 'GlobalReplicationGroupInfo$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'GlobalReplicationGroupInfo$GlobalReplicationGroupMemberRole' => 'The role of the replication group in a Global datastore. Can be primary or secondary.
', 'GlobalReplicationGroupMember$ReplicationGroupId' => 'The replication group id of the Global datastore member.
', 'GlobalReplicationGroupMember$ReplicationGroupRegion' => 'The Amazon region of the Global datastore member.
', 'GlobalReplicationGroupMember$Role' => 'Indicates the role of the replication group, primary or secondary.
', 'GlobalReplicationGroupMember$Status' => 'The status of the membership of the replication group.
', 'IncreaseNodeGroupsInGlobalReplicationGroupMessage$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'IncreaseReplicaCountMessage$ReplicationGroupId' => 'The id of the replication group to which you want to add replica nodes.
', 'KeyList$member' => NULL, 'KinesisFirehoseDestinationDetails$DeliveryStream' => 'The name of the Kinesis Data Firehose delivery stream.
', 'ListAllowedNodeTypeModificationsMessage$CacheClusterId' => 'The name of the cluster you want to scale up to a larger node instanced type. ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.
You must provide a value for either the CacheClusterId or the ReplicationGroupId.
The name of the replication group want to scale up to a larger node type. ElastiCache uses the replication group id to identify the current node type being used by this replication group, and from that to create a list of node types you can scale up to.
You must provide a value for either the CacheClusterId or the ReplicationGroupId.
The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
', 'LogDeliveryConfiguration$Message' => 'Returns an error message for the log delivery configuration.
', 'ModifyCacheClusterMessage$CacheClusterId' => 'The cluster identifier. This value is stored as a lowercase string.
', 'ModifyCacheClusterMessage$PreferredMaintenanceWindow' => 'Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
The Amazon SNS topic owner must be same as the cluster owner.
The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.
Valid values: active | inactive
The upgraded version of the cache engine to be run on the cache nodes.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
', 'ModifyCacheClusterMessage$SnapshotWindow' => 'The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.
', 'ModifyCacheClusterMessage$CacheNodeType' => 'A valid cache node type that you want to scale this cluster up to.
', 'ModifyCacheClusterMessage$AuthToken' => 'Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints:
Must be only printable ASCII characters
Must be at least 16 characters and no more than 128 characters in length
Cannot contain any of the following characters: \'/\', \'"\', or \'@\', \'%\'
For more information, see AUTH password at AUTH.
', 'ModifyCacheParameterGroupMessage$CacheParameterGroupName' => 'The name of the cache parameter group to modify.
', 'ModifyCacheSubnetGroupMessage$CacheSubnetGroupName' => 'The name for the cache subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
A description of the cache subnet group.
', 'ModifyGlobalReplicationGroupMessage$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'ModifyGlobalReplicationGroupMessage$CacheNodeType' => 'A valid cache node type that you want to scale this Global datastore to.
', 'ModifyGlobalReplicationGroupMessage$EngineVersion' => 'The upgraded version of the cache engine to be run on the clusters in the Global datastore.
', 'ModifyGlobalReplicationGroupMessage$CacheParameterGroupName' => 'The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.
', 'ModifyGlobalReplicationGroupMessage$GlobalReplicationGroupDescription' => 'A description of the Global datastore
', 'ModifyReplicationGroupMessage$ReplicationGroupId' => 'The identifier of the replication group to modify.
', 'ModifyReplicationGroupMessage$ReplicationGroupDescription' => 'A description for the replication group. Maximum length is 255 characters.
', 'ModifyReplicationGroupMessage$PrimaryClusterId' => 'For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.
', 'ModifyReplicationGroupMessage$SnapshottingClusterId' => 'The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.
', 'ModifyReplicationGroupMessage$NodeGroupId' => 'Deprecated. This parameter is not used.
', 'ModifyReplicationGroupMessage$PreferredMaintenanceWindow' => 'Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
The Amazon SNS topic owner must be same as the replication group owner.
The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.
Valid values: active | inactive
The upgraded version of the cache engine to be run on the clusters in the replication group.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.
', 'ModifyReplicationGroupMessage$SnapshotWindow' => 'The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
', 'ModifyReplicationGroupMessage$CacheNodeType' => 'A valid cache node type that you want to scale this replication group to.
', 'ModifyReplicationGroupMessage$AuthToken' => 'Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy parameter. Password constraints:
Must be only printable ASCII characters
Must be at least 16 characters and no more than 128 characters in length
Cannot contain any of the following characters: \'/\', \'"\', or \'@\', \'%\'
For more information, see AUTH password at AUTH.
', 'ModifyReplicationGroupShardConfigurationMessage$ReplicationGroupId' => 'The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.
', 'ModifyServerlessCacheRequest$ServerlessCacheName' => 'User-provided identifier for the serverless cache to be modified.
', 'ModifyServerlessCacheRequest$Description' => 'User provided description for the serverless cache. Default = NULL, i.e. the existing description is not removed/modified. The description has a maximum length of 255 characters.
', 'ModifyServerlessCacheRequest$UserGroupId' => 'The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL - the existing UserGroup is not removed.
', 'ModifyServerlessCacheRequest$DailySnapshotTime' => 'The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Redis only. The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.
', 'ModifyUserGroupMessage$UserGroupId' => 'The ID of the user group.
', 'NodeGroup$NodeGroupId' => 'The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.
', 'NodeGroup$Status' => 'The current state of this replication group - creating, available, modifying, deleting.
The keyspace for this node group (shard).
', 'NodeGroupConfiguration$Slots' => 'A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.
Example: "0-3999"
The Availability Zone where the primary node of this node group (shard) is launched.
', 'NodeGroupConfiguration$PrimaryOutpostArn' => 'The outpost ARN of the primary node.
', 'NodeGroupMember$CacheClusterId' => 'The ID of the cluster to which the node belongs.
', 'NodeGroupMember$CacheNodeId' => 'The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
', 'NodeGroupMember$PreferredAvailabilityZone' => 'The name of the Availability Zone in which the node is located.
', 'NodeGroupMember$PreferredOutpostArn' => 'The outpost ARN of the node group member.
', 'NodeGroupMember$CurrentRole' => 'The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.
The cache cluster ID
', 'NodeGroupMemberUpdateStatus$CacheNodeId' => 'The node ID of the cache cluster
', 'NodeGroupUpdateStatus$NodeGroupId' => 'The ID of the node group
', 'NodeSnapshot$CacheClusterId' => 'A unique identifier for the source cluster.
', 'NodeSnapshot$NodeGroupId' => 'A unique identifier for the source node group (shard).
', 'NodeSnapshot$CacheNodeId' => 'The cache node identifier for the node in the source cluster.
', 'NodeSnapshot$CacheSize' => 'The size of the cache on the source cache node.
', 'NodeTypeList$member' => NULL, 'NotificationConfiguration$TopicArn' => 'The Amazon Resource Name (ARN) that identifies the topic.
', 'NotificationConfiguration$TopicStatus' => 'The current state of the topic.
', 'OutpostArnsList$member' => NULL, 'Parameter$ParameterName' => 'The name of the parameter.
', 'Parameter$ParameterValue' => 'The value of the parameter.
', 'Parameter$Description' => 'A description of the parameter.
', 'Parameter$Source' => 'The source of the parameter.
', 'Parameter$DataType' => 'The valid data type for the parameter.
', 'Parameter$AllowedValues' => 'The valid range of values for the parameter.
', 'Parameter$MinimumEngineVersion' => 'The earliest cache engine version to which the parameter can apply.
', 'ParameterNameValue$ParameterName' => 'The name of the parameter.
', 'ParameterNameValue$ParameterValue' => 'The value of the parameter.
', 'PasswordListInput$member' => NULL, 'PendingModifiedValues$EngineVersion' => 'The new cache engine version that the cluster runs.
', 'PendingModifiedValues$CacheNodeType' => 'The cache node type that this cluster or replication group is scaled to.
', 'PreferredAvailabilityZoneList$member' => NULL, 'PreferredOutpostArnList$member' => NULL, 'ProcessedUpdateAction$ReplicationGroupId' => 'The ID of the replication group
', 'ProcessedUpdateAction$CacheClusterId' => 'The ID of the cache cluster
', 'ProcessedUpdateAction$ServiceUpdateName' => 'The unique ID of the service update
', 'PurchaseReservedCacheNodesOfferingMessage$ReservedCacheNodesOfferingId' => 'The ID of the reserved cache node offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
A customer-specified identifier to track this reservation.
The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation.
Example: myreservationID
', 'RebalanceSlotsInGlobalReplicationGroupMessage$GlobalReplicationGroupId' => 'The name of the Global datastore
', 'RebootCacheClusterMessage$CacheClusterId' => 'The cluster identifier. This parameter is stored as a lowercase string.
', 'RecurringCharge$RecurringChargeFrequency' => 'The frequency of the recurring charge.
', 'RegionalConfiguration$ReplicationGroupId' => 'The name of the secondary cluster
', 'RegionalConfiguration$ReplicationGroupRegion' => 'The Amazon region where the cluster is stored
', 'RemoveReplicasList$member' => NULL, 'RemoveTagsFromResourceMessage$ResourceName' => 'The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.
', 'ReplicationGroup$ReplicationGroupId' => 'The identifier for the replication group.
', 'ReplicationGroup$Description' => 'The user supplied description of the replication group.
', 'ReplicationGroup$Status' => 'The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.
The cluster ID that is used as the daily snapshot source for the replication group.
', 'ReplicationGroup$SnapshotWindow' => 'The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
This parameter is only valid if the Engine parameter is redis.
The name of the compute and memory capacity node type for each node in the replication group.
', 'ReplicationGroup$KmsKeyId' => 'The ID of the KMS key used to encrypt the disk in the cluster.
', 'ReplicationGroup$ARN' => 'The ARN (Amazon Resource Name) of the replication group.
', 'ReplicationGroupIdList$member' => NULL, 'ReplicationGroupMessage$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'ReplicationGroupOutpostArnList$member' => NULL, 'ReplicationGroupPendingModifiedValues$PrimaryClusterId' => 'The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.
The unique identifier for the reservation.
', 'ReservedCacheNode$ReservedCacheNodesOfferingId' => 'The offering identifier.
', 'ReservedCacheNode$CacheNodeType' => 'The cache node type for the reserved cache nodes.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
The description of the reserved cache node.
', 'ReservedCacheNode$OfferingType' => 'The offering type of this reserved cache node.
', 'ReservedCacheNode$State' => 'The state of the reserved cache node.
', 'ReservedCacheNode$ReservationARN' => 'The Amazon Resource Name (ARN) of the reserved cache node.
Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582
Provides an identifier to allow retrieval of paginated results.
', 'ReservedCacheNodesOffering$ReservedCacheNodesOfferingId' => 'A unique identifier for the reserved cache node offering.
', 'ReservedCacheNodesOffering$CacheNodeType' => 'The cache node type for the reserved cache node.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
The cache engine used by the offering.
', 'ReservedCacheNodesOffering$OfferingType' => 'The offering type.
', 'ReservedCacheNodesOfferingMessage$Marker' => 'Provides an identifier to allow retrieval of paginated results.
', 'ResetCacheParameterGroupMessage$CacheParameterGroupName' => 'The name of the cache parameter group to reset.
', 'RevokeCacheSecurityGroupIngressMessage$CacheSecurityGroupName' => 'The name of the cache security group to revoke ingress from.
', 'RevokeCacheSecurityGroupIngressMessage$EC2SecurityGroupName' => 'The name of the Amazon EC2 security group to revoke access from.
', 'RevokeCacheSecurityGroupIngressMessage$EC2SecurityGroupOwnerId' => 'The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter.
', 'SecurityGroupIdsList$member' => NULL, 'SecurityGroupMembership$SecurityGroupId' => 'The identifier of the cache security group.
', 'SecurityGroupMembership$Status' => 'The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cluster are modified.
', 'ServerlessCache$ServerlessCacheName' => 'The unique identifier of the serverless cache.
', 'ServerlessCache$Description' => 'A description of the serverless cache.
', 'ServerlessCache$Status' => 'The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.
', 'ServerlessCache$Engine' => 'The engine the serverless cache is compatible with.
', 'ServerlessCache$MajorEngineVersion' => 'The version number of the engine the serverless cache is compatible with.
', 'ServerlessCache$FullEngineVersion' => 'The name and version number of the engine the serverless cache is compatible with.
', 'ServerlessCache$KmsKeyId' => 'The ID of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.
', 'ServerlessCache$ARN' => 'The Amazon Resource Name (ARN) of the serverless cache.
', 'ServerlessCache$UserGroupId' => 'The identifier of the user group associated with the serverless cache. Available for Redis only. Default is NULL.
', 'ServerlessCache$DailySnapshotTime' => 'The daily time that a cache snapshot will be created. Default is NULL, i.e. snapshots will not be created at a specific time on a daily basis. Available for Redis only.
', 'ServerlessCacheConfiguration$ServerlessCacheName' => 'The identifier of a serverless cache.
', 'ServerlessCacheConfiguration$Engine' => 'The engine that the serverless cache is configured with.
', 'ServerlessCacheConfiguration$MajorEngineVersion' => 'The engine version number that the serverless cache is configured with.
', 'ServerlessCacheSnapshot$ServerlessCacheSnapshotName' => 'The identifier of a serverless cache snapshot. Available for Redis only.
', 'ServerlessCacheSnapshot$ARN' => 'The Amazon Resource Name (ARN) of a serverless cache snapshot. Available for Redis only.
', 'ServerlessCacheSnapshot$KmsKeyId' => 'The ID of the Amazon Web Services Key Management Service (KMS) key of a serverless cache snapshot. Available for Redis only.
', 'ServerlessCacheSnapshot$SnapshotType' => 'The type of snapshot of serverless cache. Available for Redis only.
', 'ServerlessCacheSnapshot$Status' => 'The current status of the serverless cache. Available for Redis only.
', 'ServerlessCacheSnapshot$BytesUsedForCache' => 'The total size of a serverless cache snapshot, in bytes. Available for Redis only.
', 'ServiceUpdate$ServiceUpdateName' => 'The unique ID of the service update
', 'ServiceUpdate$ServiceUpdateDescription' => 'Provides details of the service update
', 'ServiceUpdate$Engine' => 'The Elasticache engine to which the update applies. Either Redis or Memcached
', 'ServiceUpdate$EngineVersion' => 'The Elasticache engine version to which the update applies. Either Redis or Memcached engine version
', 'ServiceUpdate$EstimatedUpdateTime' => 'The estimated length of time the service update will take
', 'ServiceUpdatesMessage$Marker' => '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.
The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
', 'Snapshot$ReplicationGroupId' => 'The unique identifier of the source replication group.
', 'Snapshot$ReplicationGroupDescription' => 'A description of the source replication group.
', 'Snapshot$CacheClusterId' => 'The user-supplied identifier of the source cluster.
', 'Snapshot$SnapshotStatus' => 'The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
The name of the compute and memory capacity node type for the source cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
Current generation:
M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge
For region availability, see Supported Node Types
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge
M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge
T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium
T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium
T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge
For region availability, see Supported Node Types
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge
R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
Additional node type info
All current generation instance types are created in Amazon VPC by default.
Redis append-only files (AOF) are not supported for T1 or T2 instances.
Redis Multi-AZ with automatic failover is not supported on T1 instances.
Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.
The name of the cache engine (memcached or redis) used by the source cluster.
The version of the cache engine version that is used by the source cluster.
', 'Snapshot$PreferredAvailabilityZone' => 'The name of the Availability Zone in which the source cluster is located.
', 'Snapshot$PreferredOutpostArn' => 'The ARN (Amazon Resource Name) of the preferred outpost.
', 'Snapshot$PreferredMaintenanceWindow' => 'Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
', 'Snapshot$CacheParameterGroupName' => 'The cache parameter group that is associated with the source cluster.
', 'Snapshot$CacheSubnetGroupName' => 'The name of the cache subnet group associated with the source cluster.
', 'Snapshot$VpcId' => 'The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
', 'Snapshot$SnapshotWindow' => 'The daily time range during which ElastiCache takes daily snapshots of the source cluster.
', 'Snapshot$KmsKeyId' => 'The ID of the KMS key used to encrypt the snapshot.
', 'Snapshot$ARN' => 'The ARN (Amazon Resource Name) of the snapshot.
', 'SnapshotArnsList$member' => NULL, 'StartMigrationMessage$ReplicationGroupId' => 'The ID of the replication group to which data should be migrated.
', 'Subnet$SubnetIdentifier' => 'The unique identifier for the subnet.
', 'SubnetIdentifierList$member' => NULL, 'SubnetIdsList$member' => NULL, 'SubnetOutpost$SubnetOutpostArn' => 'The outpost ARN of the subnet.
', 'Tag$Key' => 'The key for the tag. May not be null.
', 'Tag$Value' => 'The tag\'s value. May be null.
', 'TestFailoverMessage$ReplicationGroupId' => 'The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.
', 'TestMigrationMessage$ReplicationGroupId' => 'The ID of the replication group to which data is to be migrated.
', 'UGReplicationGroupIdList$member' => NULL, 'UGServerlessCacheIdList$member' => NULL, 'UnprocessedUpdateAction$ReplicationGroupId' => 'The replication group ID
', 'UnprocessedUpdateAction$CacheClusterId' => 'The ID of the cache cluster
', 'UnprocessedUpdateAction$ServiceUpdateName' => 'The unique ID of the service update
', 'UnprocessedUpdateAction$ErrorType' => 'The error type for requests that are not processed
', 'UnprocessedUpdateAction$ErrorMessage' => 'The error message that describes the reason the request was not processed
', 'UpdateAction$ReplicationGroupId' => 'The ID of the replication group
', 'UpdateAction$CacheClusterId' => 'The ID of the cache cluster
', 'UpdateAction$ServiceUpdateName' => 'The unique ID of the service update
', 'UpdateAction$NodesUpdated' => 'The progress of the service update on the replication group
', 'UpdateAction$EstimatedUpdateTime' => 'The estimated length of time for the update to complete
', 'UpdateAction$Engine' => 'The Elasticache engine to which the update applies. Either Redis or Memcached
', 'UpdateActionsMessage$Marker' => '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.
The ID of the user.
', 'User$UserName' => 'The username of the user.
', 'User$Status' => 'Indicates the user status. Can be "active", "modifying" or "deleting".
', 'User$MinimumEngineVersion' => 'The minimum engine version required, which is Redis 6.0
', 'User$AccessString' => 'Access permissions string used for this user.
', 'User$ARN' => 'The Amazon Resource Name (ARN) of the user.
', 'UserGroup$UserGroupId' => 'The ID of the user group.
', 'UserGroup$Status' => 'Indicates user group status. Can be "creating", "active", "modifying", "deleting".
', 'UserGroup$MinimumEngineVersion' => 'The minimum engine version required, which is Redis 6.0
', 'UserGroup$ARN' => 'The Amazon Resource Name (ARN) of the user group.
', ], ], 'Subnet' => [ 'base' => 'Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
', 'refs' => [ 'SubnetList$member' => NULL, ], ], 'SubnetIdentifierList' => [ 'base' => NULL, 'refs' => [ 'CreateCacheSubnetGroupMessage$SubnetIds' => 'A list of VPC subnet IDs for the cache subnet group.
', 'ModifyCacheSubnetGroupMessage$SubnetIds' => 'The EC2 subnet IDs for the cache subnet group.
', ], ], 'SubnetIdsList' => [ 'base' => NULL, 'refs' => [ 'CreateServerlessCacheRequest$SubnetIds' => 'A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.
', 'ServerlessCache$SubnetIds' => 'If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC. For all other Regions, if no subnet IDs are given then ElastiCache will select 3 default subnets across AZs in your default VPC.
', ], ], 'SubnetInUse' => [ 'base' => 'The requested subnet is being used by another cache subnet group.
', 'refs' => [], ], 'SubnetList' => [ 'base' => NULL, 'refs' => [ 'CacheSubnetGroup$Subnets' => 'A list of subnets associated with the cache subnet group.
', ], ], 'SubnetNotAllowedFault' => [ 'base' => 'At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.
', 'refs' => [], ], 'SubnetOutpost' => [ 'base' => 'The ID of the outpost subnet.
', 'refs' => [ 'Subnet$SubnetOutpost' => 'The outpost ARN of the subnet.
', ], ], 'TStamp' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$CacheClusterCreateTime' => 'The date and time when the cluster was created.
', 'CacheCluster$AuthTokenLastModifiedDate' => 'The date the auth token was last modified
', 'CacheNode$CacheNodeCreateTime' => 'The date and time when the cache node was created.
', 'CacheNodeUpdateStatus$NodeDeletionDate' => 'The deletion date of the node
', 'CacheNodeUpdateStatus$NodeUpdateStartDate' => 'The start date of the update for a node
', 'CacheNodeUpdateStatus$NodeUpdateEndDate' => 'The end date of the update for a node
', 'CacheNodeUpdateStatus$NodeUpdateInitiatedDate' => 'The date when the update is triggered
', 'CacheNodeUpdateStatus$NodeUpdateStatusModifiedDate' => 'The date when the NodeUpdateStatus was last modified>
', 'DescribeEventsMessage$StartTime' => 'The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Example: 2017-03-30T07:03:49.555Z
', 'DescribeEventsMessage$EndTime' => 'The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Example: 2017-03-30T07:03:49.555Z
', 'Event$Date' => 'The date and time when the event occurred.
', 'NodeGroupMemberUpdateStatus$NodeDeletionDate' => 'The deletion date of the node
', 'NodeGroupMemberUpdateStatus$NodeUpdateStartDate' => 'The start date of the update for a node
', 'NodeGroupMemberUpdateStatus$NodeUpdateEndDate' => 'The end date of the update for a node
', 'NodeGroupMemberUpdateStatus$NodeUpdateInitiatedDate' => 'The date when the update is triggered
', 'NodeGroupMemberUpdateStatus$NodeUpdateStatusModifiedDate' => 'The date when the NodeUpdateStatus was last modified
', 'NodeSnapshot$CacheNodeCreateTime' => 'The date and time when the cache node was created in the source cluster.
', 'NodeSnapshot$SnapshotCreateTime' => 'The date and time when the source node\'s metadata and cache data set was obtained for the snapshot.
', 'ReplicationGroup$AuthTokenLastModifiedDate' => 'The date the auth token was last modified
', 'ReplicationGroup$ReplicationGroupCreateTime' => 'The date and time when the cluster was created.
', 'ReservedCacheNode$StartTime' => 'The time the reservation started.
', 'ServerlessCache$CreateTime' => 'When the serverless cache was created.
', 'ServerlessCacheSnapshot$CreateTime' => 'The date and time that the source serverless cache\'s metadata and cache data set was obtained for the snapshot. Available for Redis only.
', 'ServerlessCacheSnapshot$ExpiryTime' => 'The time that the serverless cache snapshot will expire. Available for Redis only.
', 'ServiceUpdate$ServiceUpdateReleaseDate' => 'The date when the service update is initially available
', 'ServiceUpdate$ServiceUpdateEndDate' => 'The date after which the service update is no longer available
', 'ServiceUpdate$ServiceUpdateRecommendedApplyByDate' => 'The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
', 'Snapshot$CacheClusterCreateTime' => 'The date and time when the source cluster was created.
', 'TimeRangeFilter$StartTime' => 'The start time of the time range filter
', 'TimeRangeFilter$EndTime' => 'The end time of the time range filter
', 'UpdateAction$ServiceUpdateReleaseDate' => 'The date the update is first available
', 'UpdateAction$ServiceUpdateRecommendedApplyByDate' => 'The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
', 'UpdateAction$UpdateActionAvailableDate' => 'The date that the service update is available to a replication group
', 'UpdateAction$UpdateActionStatusModifiedDate' => 'The date when the UpdateActionStatus was last modified
', ], ], 'Tag' => [ 'base' => 'A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AddTagsToResourceMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
', 'CopyServerlessCacheSnapshotRequest$Tags' => 'A list of tags to be added to the target snapshot resource. A tag is a key-value pair. Available for Redis only. Default: NULL
', 'CopySnapshotMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
', 'CreateCacheClusterMessage$Tags' => 'A list of tags to be added to this resource.
', 'CreateCacheParameterGroupMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
', 'CreateCacheSecurityGroupMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
', 'CreateCacheSubnetGroupMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
', 'CreateReplicationGroupMessage$Tags' => 'A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue. Tags on replication groups will be replicated to all nodes.
The list of tags (key, value) pairs to be added to the serverless cache resource. Default is NULL.
', 'CreateServerlessCacheSnapshotRequest$Tags' => 'A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Redis only.
', 'CreateSnapshotMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
', 'CreateUserGroupMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. Available for Redis only.
', 'CreateUserMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
', 'PurchaseReservedCacheNodesOfferingMessage$Tags' => 'A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
', 'TagListMessage$TagList' => 'A list of tags as key-value pairs.
', ], ], 'TagListMessage' => [ 'base' => 'Represents the output from the AddTagsToResource, ListTagsForResource, and RemoveTagsFromResource operations.
The requested tag was not found on this resource.
', 'refs' => [], ], 'TagQuotaPerResourceExceeded' => [ 'base' => 'The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.
', 'refs' => [], ], 'TestFailoverMessage' => [ 'base' => NULL, 'refs' => [], ], 'TestFailoverNotAvailableFault' => [ 'base' => 'The TestFailover action is not available.
Filters update actions from the service updates that are in available status during the time range.
', 'refs' => [ 'DescribeUpdateActionsMessage$ServiceUpdateTimeRange' => 'The range of time specified to search for service updates that are in available status
', ], ], 'TransitEncryptionMode' => [ 'base' => NULL, 'refs' => [ 'CacheCluster$TransitEncryptionMode' => 'A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
', 'CreateReplicationGroupMessage$TransitEncryptionMode' => 'A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
When setting TransitEncryptionEnabled to true, you can set your TransitEncryptionMode to preferred in the same request, to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Redis clients to use encrypted connections you can modify the value to required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred, after that you can set TransitEncryptionMode to required.
This process will not trigger the replacement of the replication group.
', 'ModifyReplicationGroupMessage$TransitEncryptionMode' => 'A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
You must set TransitEncryptionEnabled to true, for your existing cluster, and set TransitEncryptionMode to preferred in the same request to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Redis clients to use encrypted connections you can set the value to required to allow encrypted connections only.
Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred, after that you can set TransitEncryptionMode to required.
A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
', 'ReplicationGroup$TransitEncryptionMode' => 'A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
', 'ReplicationGroupPendingModifiedValues$TransitEncryptionMode' => 'A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.
', ], ], 'UGReplicationGroupIdList' => [ 'base' => NULL, 'refs' => [ 'UserGroup$ReplicationGroups' => 'A list of replication groups that the user group can access.
', ], ], 'UGServerlessCacheIdList' => [ 'base' => NULL, 'refs' => [ 'UserGroup$ServerlessCaches' => 'Indicates which serverless caches the specified user group is associated with. Available for Redis only.
', ], ], 'UnprocessedUpdateAction' => [ 'base' => 'Update action that has failed to be processed for the corresponding apply/stop request
', 'refs' => [ 'UnprocessedUpdateActionList$member' => NULL, ], ], 'UnprocessedUpdateActionList' => [ 'base' => NULL, 'refs' => [ 'UpdateActionResultsMessage$UnprocessedUpdateActions' => 'Update actions that haven\'t been processed successfully
', ], ], 'UpdateAction' => [ 'base' => 'The status of the service update for a specific replication group
', 'refs' => [ 'UpdateActionList$member' => NULL, ], ], 'UpdateActionList' => [ 'base' => NULL, 'refs' => [ 'UpdateActionsMessage$UpdateActions' => 'Returns a list of update actions
', ], ], 'UpdateActionResultsMessage' => [ 'base' => NULL, 'refs' => [], ], 'UpdateActionStatus' => [ 'base' => NULL, 'refs' => [ 'ProcessedUpdateAction$UpdateActionStatus' => 'The status of the update action on the Redis cluster
', 'UpdateAction$UpdateActionStatus' => 'The status of the update action
', 'UpdateActionStatusList$member' => NULL, ], ], 'UpdateActionStatusList' => [ 'base' => NULL, 'refs' => [ 'DescribeUpdateActionsMessage$UpdateActionStatus' => 'The status of the update action.
', ], ], 'UpdateActionsMessage' => [ 'base' => NULL, 'refs' => [], ], 'User' => [ 'base' => NULL, 'refs' => [ 'UserList$member' => NULL, ], ], 'UserAlreadyExistsFault' => [ 'base' => 'A user with this ID already exists.
', 'refs' => [], ], 'UserGroup' => [ 'base' => NULL, 'refs' => [ 'UserGroupList$member' => NULL, ], ], 'UserGroupAlreadyExistsFault' => [ 'base' => 'The user group with this ID already exists.
', 'refs' => [], ], 'UserGroupId' => [ 'base' => NULL, 'refs' => [ 'UserGroupIdList$member' => NULL, 'UserGroupIdListInput$member' => NULL, ], ], 'UserGroupIdList' => [ 'base' => NULL, 'refs' => [ 'ModifyReplicationGroupMessage$UserGroupIdsToAdd' => 'The ID of the user group you are associating with the replication group.
', 'ModifyReplicationGroupMessage$UserGroupIdsToRemove' => 'The ID of the user group to disassociate from the replication group, meaning the users in the group no longer can access the replication group.
', 'ReplicationGroup$UserGroupIds' => 'The ID of the user group associated to the replication group.
', 'User$UserGroupIds' => 'Returns a list of the user group IDs the user belongs to.
', 'UserGroupsUpdateStatus$UserGroupIdsToAdd' => 'The ID of the user group to add.
', 'UserGroupsUpdateStatus$UserGroupIdsToRemove' => 'The ID of the user group to remove.
', ], ], 'UserGroupIdListInput' => [ 'base' => NULL, 'refs' => [ 'CreateReplicationGroupMessage$UserGroupIds' => 'The user group to associate with the replication group.
', ], ], 'UserGroupList' => [ 'base' => NULL, 'refs' => [ 'DescribeUserGroupsResult$UserGroups' => 'Returns a list of user groups.
', ], ], 'UserGroupNotFoundFault' => [ 'base' => 'The user group was not found or does not exist
', 'refs' => [], ], 'UserGroupPendingChanges' => [ 'base' => 'Returns the updates being applied to the user group.
', 'refs' => [ 'UserGroup$PendingChanges' => 'A list of updates being applied to the user group.
', ], ], 'UserGroupQuotaExceededFault' => [ 'base' => 'The number of users exceeds the user group limit.
', 'refs' => [], ], 'UserGroupsUpdateStatus' => [ 'base' => 'The status of the user group update.
', 'refs' => [ 'ReplicationGroupPendingModifiedValues$UserGroups' => 'The user group being modified.
', ], ], 'UserId' => [ 'base' => NULL, 'refs' => [ 'CreateUserMessage$UserId' => 'The ID of the user.
', 'DeleteUserMessage$UserId' => 'The ID of the user.
', 'DescribeUsersMessage$UserId' => 'The ID of the user.
', 'ModifyUserMessage$UserId' => 'The ID of the user.
', 'UserIdList$member' => NULL, 'UserIdListInput$member' => NULL, ], ], 'UserIdList' => [ 'base' => NULL, 'refs' => [ 'UserGroup$UserIds' => 'The list of user IDs that belong to the user group.
', 'UserGroupPendingChanges$UserIdsToRemove' => 'The list of user IDs to remove.
', 'UserGroupPendingChanges$UserIdsToAdd' => 'The list of user IDs to add.
', ], ], 'UserIdListInput' => [ 'base' => NULL, 'refs' => [ 'CreateUserGroupMessage$UserIds' => 'The list of user IDs that belong to the user group.
', 'ModifyUserGroupMessage$UserIdsToAdd' => 'The list of user IDs to add to the user group.
', 'ModifyUserGroupMessage$UserIdsToRemove' => 'The list of user IDs to remove from the user group.
', ], ], 'UserList' => [ 'base' => NULL, 'refs' => [ 'DescribeUsersResult$Users' => 'A list of users.
', ], ], 'UserName' => [ 'base' => NULL, 'refs' => [ 'CreateUserMessage$UserName' => 'The username of the user.
', ], ], 'UserNotFoundFault' => [ 'base' => 'The user does not exist or could not be found.
', 'refs' => [], ], 'UserQuotaExceededFault' => [ 'base' => 'The quota of users has been exceeded.
', 'refs' => [], ], ],]; diff --git a/src/data/launch-wizard/2018-05-10/api-2.json b/src/data/launch-wizard/2018-05-10/api-2.json index 40d88df9d0..9c6db00a5b 100644 --- a/src/data/launch-wizard/2018-05-10/api-2.json +++ b/src/data/launch-wizard/2018-05-10/api-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", @@ -38,6 +39,7 @@ "input":{"shape":"DeleteDeploymentInput"}, "output":{"shape":"DeleteDeploymentOutput"}, "errors":[ + {"shape":"ResourceLimitException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} @@ -74,6 +76,21 @@ {"shape":"ResourceNotFoundException"} ] }, + "GetWorkloadDeploymentPattern":{ + "name":"GetWorkloadDeploymentPattern", + "http":{ + "method":"POST", + "requestUri":"/getWorkloadDeploymentPattern", + "responseCode":200 + }, + "input":{"shape":"GetWorkloadDeploymentPatternInput"}, + "output":{"shape":"GetWorkloadDeploymentPatternOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "ListDeploymentEvents":{ "name":"ListDeploymentEvents", "http":{ @@ -103,6 +120,21 @@ {"shape":"ValidationException"} ] }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "ListWorkloadDeploymentPatterns":{ "name":"ListWorkloadDeploymentPatterns", "http":{ @@ -131,9 +163,44 @@ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ] + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true } }, "shapes":{ + "AllowedValues":{ + "type":"list", + "member":{"shape":"ValueString"} + }, "Boolean":{ "type":"boolean", "box":true @@ -151,6 +218,7 @@ "dryRun":{"shape":"Boolean"}, "name":{"shape":"DeploymentName"}, "specifications":{"shape":"DeploymentSpecifications"}, + "tags":{"shape":"Tags"}, "workloadName":{"shape":"WorkloadName"} } }, @@ -174,17 +242,27 @@ "statusReason":{"shape":"String"} } }, + "DeploymentConditionalField":{ + "type":"structure", + "members":{ + "comparator":{"shape":"String"}, + "name":{"shape":"String"}, + "value":{"shape":"String"} + } + }, "DeploymentData":{ "type":"structure", "members":{ "createdAt":{"shape":"Timestamp"}, "deletedAt":{"shape":"Timestamp"}, + "deploymentArn":{"shape":"String"}, "id":{"shape":"DeploymentId"}, "name":{"shape":"String"}, "patternName":{"shape":"DeploymentPatternName"}, "resourceGroup":{"shape":"String"}, "specifications":{"shape":"DeploymentSpecifications"}, "status":{"shape":"DeploymentStatus"}, + "tags":{"shape":"Tags"}, "workloadName":{"shape":"WorkloadName"} } }, @@ -253,15 +331,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", @@ -271,6 +349,22 @@ "min":1, "sensitive":true }, + "DeploymentSpecificationsData":{ + "type":"list", + "member":{"shape":"DeploymentSpecificationsField"}, + "max":100, + "min":1 + }, + "DeploymentSpecificationsField":{ + "type":"structure", + "members":{ + "allowedValues":{"shape":"AllowedValues"}, + "conditionals":{"shape":"SpecificationsConditionalData"}, + "description":{"shape":"String"}, + "name":{"shape":"String"}, + "required":{"shape":"String"} + } + }, "DeploymentStatus":{ "type":"string", "enum":[ @@ -311,6 +405,23 @@ "deployment":{"shape":"DeploymentData"} } }, + "GetWorkloadDeploymentPatternInput":{ + "type":"structure", + "required":[ + "deploymentPatternName", + "workloadName" + ], + "members":{ + "deploymentPatternName":{"shape":"DeploymentPatternName"}, + "workloadName":{"shape":"WorkloadName"} + } + }, + "GetWorkloadDeploymentPatternOutput":{ + "type":"structure", + "members":{ + "workloadDeploymentPattern":{"shape":"WorkloadDeploymentPatternData"} + } + }, "GetWorkloadInput":{ "type":"structure", "required":["workloadName"], @@ -370,6 +481,23 @@ "nextToken":{"shape":"NextToken"} } }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"String", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "tags":{"shape":"Tags"} + } + }, "ListWorkloadDeploymentPatternsInput":{ "type":"structure", "required":["workloadName"], @@ -451,8 +579,82 @@ }, "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", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{"shape":"Tags"} + } + }, + "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", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, "ValidationException":{ "type":"structure", "members":{ @@ -492,6 +694,19 @@ "type":"list", "member":{"shape":"WorkloadDataSummary"} }, + "WorkloadDeploymentPatternData":{ + "type":"structure", + "members":{ + "deploymentPatternName":{"shape":"DeploymentPatternName"}, + "description":{"shape":"String"}, + "displayName":{"shape":"String"}, + "specifications":{"shape":"DeploymentSpecificationsData"}, + "status":{"shape":"WorkloadDeploymentPatternStatus"}, + "statusMessage":{"shape":"String"}, + "workloadName":{"shape":"WorkloadName"}, + "workloadVersionName":{"shape":"WorkloadVersionName"} + } + }, "WorkloadDeploymentPatternDataSummary":{ "type":"structure", "members":{ @@ -519,9 +734,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", @@ -536,7 +751,7 @@ "type":"string", "max":30, "min":5, - "pattern":"^[a-zA-Z0-9-]+$" + "pattern":"^[A-Za-z0-9][a-zA-Z0-9-]*$" } } } diff --git a/src/data/launch-wizard/2018-05-10/api-2.json.php b/src/data/launch-wizard/2018-05-10/api-2.json.php index f5f0f8ffd0..d21bdb01cb 100644 --- a/src/data/launch-wizard/2018-05-10/api-2.json.php +++ b/src/data/launch-wizard/2018-05-10/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2018-05-10', 'endpointPrefix' => 'launchwizard', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'serviceFullName' => 'AWS Launch Wizard', 'serviceId' => 'Launch Wizard', 'signatureVersion' => 'v4', 'signingName' => 'launchwizard', 'uid' => 'launch-wizard-2018-05-10', ], 'operations' => [ 'CreateDeployment' => [ 'name' => 'CreateDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/createDeployment', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateDeploymentInput', ], 'output' => [ 'shape' => 'CreateDeploymentOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DeleteDeployment' => [ 'name' => 'DeleteDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/deleteDeployment', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteDeploymentInput', ], 'output' => [ 'shape' => 'DeleteDeploymentOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'GetDeployment' => [ 'name' => 'GetDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/getDeployment', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetDeploymentInput', ], 'output' => [ 'shape' => 'GetDeploymentOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetWorkload' => [ 'name' => 'GetWorkload', 'http' => [ 'method' => 'POST', 'requestUri' => '/getWorkload', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetWorkloadInput', ], 'output' => [ 'shape' => 'GetWorkloadOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListDeploymentEvents' => [ 'name' => 'ListDeploymentEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/listDeploymentEvents', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDeploymentEventsInput', ], 'output' => [ 'shape' => 'ListDeploymentEventsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListDeployments' => [ 'name' => 'ListDeployments', 'http' => [ 'method' => 'POST', 'requestUri' => '/listDeployments', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDeploymentsInput', ], 'output' => [ 'shape' => 'ListDeploymentsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListWorkloadDeploymentPatterns' => [ 'name' => 'ListWorkloadDeploymentPatterns', 'http' => [ 'method' => 'POST', 'requestUri' => '/listWorkloadDeploymentPatterns', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListWorkloadDeploymentPatternsInput', ], 'output' => [ 'shape' => 'ListWorkloadDeploymentPatternsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListWorkloads' => [ 'name' => 'ListWorkloads', 'http' => [ 'method' => 'POST', 'requestUri' => '/listWorkloads', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListWorkloadsInput', ], 'output' => [ 'shape' => 'ListWorkloadsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], ], ], ], 'shapes' => [ 'Boolean' => [ 'type' => 'boolean', 'box' => true, ], 'CreateDeploymentInput' => [ 'type' => 'structure', 'required' => [ 'deploymentPatternName', 'name', 'specifications', 'workloadName', ], 'members' => [ 'deploymentPatternName' => [ 'shape' => 'DeploymentPatternName', ], 'dryRun' => [ 'shape' => 'Boolean', ], 'name' => [ 'shape' => 'DeploymentName', ], 'specifications' => [ 'shape' => 'DeploymentSpecifications', ], 'workloadName' => [ 'shape' => 'WorkloadName', ], ], ], 'CreateDeploymentOutput' => [ 'type' => 'structure', 'members' => [ 'deploymentId' => [ 'shape' => 'DeploymentId', ], ], ], 'DeleteDeploymentInput' => [ 'type' => 'structure', 'required' => [ 'deploymentId', ], 'members' => [ 'deploymentId' => [ 'shape' => 'DeploymentId', ], ], ], 'DeleteDeploymentOutput' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'DeploymentStatus', ], 'statusReason' => [ 'shape' => 'String', ], ], ], 'DeploymentData' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'Timestamp', ], 'deletedAt' => [ 'shape' => 'Timestamp', ], 'id' => [ 'shape' => 'DeploymentId', ], 'name' => [ 'shape' => 'String', ], 'patternName' => [ 'shape' => 'DeploymentPatternName', ], 'resourceGroup' => [ 'shape' => 'String', ], 'specifications' => [ 'shape' => 'DeploymentSpecifications', ], 'status' => [ 'shape' => 'DeploymentStatus', ], 'workloadName' => [ 'shape' => 'WorkloadName', ], ], ], 'DeploymentDataSummary' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'Timestamp', ], 'id' => [ 'shape' => 'DeploymentId', ], 'name' => [ 'shape' => 'String', ], 'patternName' => [ 'shape' => 'DeploymentPatternName', ], 'status' => [ 'shape' => 'DeploymentStatus', ], 'workloadName' => [ 'shape' => 'WorkloadName', ], ], ], 'DeploymentDataSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentDataSummary', ], ], 'DeploymentEventDataSummary' => [ 'type' => 'structure', 'members' => [ 'description' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'EventStatus', ], 'statusReason' => [ 'shape' => 'String', ], 'timestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeploymentEventDataSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentEventDataSummary', ], ], 'DeploymentFilter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'DeploymentFilterKey', ], 'values' => [ 'shape' => 'DeploymentFilterValues', ], ], ], 'DeploymentFilterKey' => [ 'type' => 'string', 'enum' => [ 'WORKLOAD_NAME', 'DEPLOYMENT_STATUS', ], ], 'DeploymentFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentFilter', ], 'min' => 1, ], 'DeploymentFilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentFilterValuesMemberString', ], ], 'DeploymentFilterValuesMemberString' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'DeploymentId' => [ 'type' => 'string', 'max' => 128, 'min' => 2, 'pattern' => '^[a-zA-Z0-9-]+$', ], 'DeploymentName' => [ 'type' => 'string', 'max' => 25, 'min' => 1, 'pattern' => '^[A-Za-z0-9_\\s\\.-]+$', ], 'DeploymentPatternName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-]+$', ], 'DeploymentSpecifications' => [ 'type' => 'map', 'key' => [ 'shape' => 'KeyString', ], 'value' => [ 'shape' => 'ValueString', ], 'max' => 100, 'min' => 1, 'sensitive' => true, ], 'DeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETED', 'CREATING', 'DELETE_IN_PROGRESS', 'DELETE_INITIATING', 'DELETE_FAILED', 'DELETED', 'FAILED', 'IN_PROGRESS', 'VALIDATING', ], ], 'EventStatus' => [ 'type' => 'string', 'enum' => [ 'CANCELED', 'CANCELING', 'COMPLETED', 'CREATED', 'FAILED', 'IN_PROGRESS', 'PENDING', 'TIMED_OUT', ], ], 'GetDeploymentInput' => [ 'type' => 'structure', 'required' => [ 'deploymentId', ], 'members' => [ 'deploymentId' => [ 'shape' => 'DeploymentId', ], ], ], 'GetDeploymentOutput' => [ 'type' => 'structure', 'members' => [ 'deployment' => [ 'shape' => 'DeploymentData', ], ], ], 'GetWorkloadInput' => [ 'type' => 'structure', 'required' => [ 'workloadName', ], 'members' => [ 'workloadName' => [ 'shape' => 'WorkloadName', ], ], ], 'GetWorkloadOutput' => [ 'type' => 'structure', 'members' => [ 'workload' => [ 'shape' => 'WorkloadData', ], ], ], 'InternalServerException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'KeyString' => [ 'type' => 'string', 'max' => 256, 'min' => 3, 'pattern' => '^[a-zA-Z0-9-:]+$', ], 'ListDeploymentEventsInput' => [ 'type' => 'structure', 'required' => [ 'deploymentId', ], 'members' => [ 'deploymentId' => [ 'shape' => 'DeploymentId', ], 'maxResults' => [ 'shape' => 'MaxDeploymentEventResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeploymentEventsOutput' => [ 'type' => 'structure', 'members' => [ 'deploymentEvents' => [ 'shape' => 'DeploymentEventDataSummaryList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeploymentsInput' => [ 'type' => 'structure', 'members' => [ 'filters' => [ 'shape' => 'DeploymentFilterList', ], 'maxResults' => [ 'shape' => 'MaxDeploymentResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeploymentsOutput' => [ 'type' => 'structure', 'members' => [ 'deployments' => [ 'shape' => 'DeploymentDataSummaryList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkloadDeploymentPatternsInput' => [ 'type' => 'structure', 'required' => [ 'workloadName', ], 'members' => [ 'maxResults' => [ 'shape' => 'MaxWorkloadDeploymentPatternResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'workloadName' => [ 'shape' => 'WorkloadName', ], ], ], 'ListWorkloadDeploymentPatternsOutput' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'workloadDeploymentPatterns' => [ 'shape' => 'WorkloadDeploymentPatternDataSummaryList', ], ], ], 'ListWorkloadsInput' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'MaxWorkloadResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkloadsOutput' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'workloads' => [ 'shape' => 'WorkloadDataSummaryList', ], ], ], 'MaxDeploymentEventResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MaxDeploymentResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MaxWorkloadDeploymentPatternResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MaxWorkloadResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'NextToken' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'ResourceLimitException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], 'exception' => true, ], 'String' => [ 'type' => 'string', ], 'Timestamp' => [ 'type' => 'timestamp', ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ValueString' => [ 'type' => 'string', 'max' => 1500, 'min' => 1, ], 'WorkloadData' => [ 'type' => 'structure', 'members' => [ 'description' => [ 'shape' => 'String', ], 'displayName' => [ 'shape' => 'String', ], 'documentationUrl' => [ 'shape' => 'String', ], 'iconUrl' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'WorkloadStatus', ], 'statusMessage' => [ 'shape' => 'String', ], 'workloadName' => [ 'shape' => 'WorkloadName', ], ], ], 'WorkloadDataSummary' => [ 'type' => 'structure', 'members' => [ 'displayName' => [ 'shape' => 'String', ], 'workloadName' => [ 'shape' => 'WorkloadName', ], ], ], 'WorkloadDataSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkloadDataSummary', ], ], 'WorkloadDeploymentPatternDataSummary' => [ 'type' => 'structure', 'members' => [ 'deploymentPatternName' => [ 'shape' => 'DeploymentPatternName', ], 'description' => [ 'shape' => 'String', ], 'displayName' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'WorkloadDeploymentPatternStatus', ], 'statusMessage' => [ 'shape' => 'String', ], 'workloadName' => [ 'shape' => 'WorkloadName', ], 'workloadVersionName' => [ 'shape' => 'WorkloadVersionName', ], ], ], 'WorkloadDeploymentPatternDataSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkloadDeploymentPatternDataSummary', ], ], 'WorkloadDeploymentPatternStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', 'DISABLED', 'DELETED', ], ], 'WorkloadName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[a-zA-Z0-9-]+$', ], 'WorkloadStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', 'DISABLED', 'DELETED', ], ], 'WorkloadVersionName' => [ 'type' => 'string', 'max' => 30, 'min' => 5, 'pattern' => '^[a-zA-Z0-9-]+$', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2018-05-10', 'endpointPrefix' => 'launchwizard', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'protocols' => [ 'rest-json', ], 'serviceFullName' => 'AWS Launch Wizard', 'serviceId' => 'Launch Wizard', 'signatureVersion' => 'v4', 'signingName' => 'launchwizard', 'uid' => 'launch-wizard-2018-05-10', ], 'operations' => [ 'CreateDeployment' => [ 'name' => 'CreateDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/createDeployment', 'responseCode' => 200, ], 'input' => [ 'shape' => 'CreateDeploymentInput', ], 'output' => [ 'shape' => 'CreateDeploymentOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'DeleteDeployment' => [ 'name' => 'DeleteDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/deleteDeployment', 'responseCode' => 200, ], 'input' => [ 'shape' => 'DeleteDeploymentInput', ], 'output' => [ 'shape' => 'DeleteDeploymentOutput', ], 'errors' => [ [ 'shape' => 'ResourceLimitException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], 'GetDeployment' => [ 'name' => 'GetDeployment', 'http' => [ 'method' => 'POST', 'requestUri' => '/getDeployment', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetDeploymentInput', ], 'output' => [ 'shape' => 'GetDeploymentOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetWorkload' => [ 'name' => 'GetWorkload', 'http' => [ 'method' => 'POST', 'requestUri' => '/getWorkload', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetWorkloadInput', ], 'output' => [ 'shape' => 'GetWorkloadOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'GetWorkloadDeploymentPattern' => [ 'name' => 'GetWorkloadDeploymentPattern', 'http' => [ 'method' => 'POST', 'requestUri' => '/getWorkloadDeploymentPattern', 'responseCode' => 200, ], 'input' => [ 'shape' => 'GetWorkloadDeploymentPatternInput', ], 'output' => [ 'shape' => 'GetWorkloadDeploymentPatternOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListDeploymentEvents' => [ 'name' => 'ListDeploymentEvents', 'http' => [ 'method' => 'POST', 'requestUri' => '/listDeploymentEvents', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDeploymentEventsInput', ], 'output' => [ 'shape' => 'ListDeploymentEventsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListDeployments' => [ 'name' => 'ListDeployments', 'http' => [ 'method' => 'POST', 'requestUri' => '/listDeployments', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListDeploymentsInput', ], 'output' => [ 'shape' => 'ListDeploymentsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], ], ], 'ListTagsForResource' => [ 'name' => 'ListTagsForResource', 'http' => [ 'method' => 'GET', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListTagsForResourceInput', ], 'output' => [ 'shape' => 'ListTagsForResourceOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListWorkloadDeploymentPatterns' => [ 'name' => 'ListWorkloadDeploymentPatterns', 'http' => [ 'method' => 'POST', 'requestUri' => '/listWorkloadDeploymentPatterns', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListWorkloadDeploymentPatternsInput', ], 'output' => [ 'shape' => 'ListWorkloadDeploymentPatternsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'ListWorkloads' => [ 'name' => 'ListWorkloads', 'http' => [ 'method' => 'POST', 'requestUri' => '/listWorkloads', 'responseCode' => 200, ], 'input' => [ 'shape' => 'ListWorkloadsInput', ], 'output' => [ 'shape' => 'ListWorkloadsOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'TagResourceInput', ], 'output' => [ 'shape' => 'TagResourceOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/tags/{resourceArn}', 'responseCode' => 200, ], 'input' => [ 'shape' => 'UntagResourceInput', ], 'output' => [ 'shape' => 'UntagResourceOutput', ], 'errors' => [ [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ResourceNotFoundException', ], ], 'idempotent' => true, ], ], 'shapes' => [ 'AllowedValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValueString', ], ], 'Boolean' => [ 'type' => 'boolean', 'box' => true, ], 'CreateDeploymentInput' => [ 'type' => 'structure', 'required' => [ 'deploymentPatternName', 'name', 'specifications', 'workloadName', ], 'members' => [ 'deploymentPatternName' => [ 'shape' => 'DeploymentPatternName', ], 'dryRun' => [ 'shape' => 'Boolean', ], 'name' => [ 'shape' => 'DeploymentName', ], 'specifications' => [ 'shape' => 'DeploymentSpecifications', ], 'tags' => [ 'shape' => 'Tags', ], 'workloadName' => [ 'shape' => 'WorkloadName', ], ], ], 'CreateDeploymentOutput' => [ 'type' => 'structure', 'members' => [ 'deploymentId' => [ 'shape' => 'DeploymentId', ], ], ], 'DeleteDeploymentInput' => [ 'type' => 'structure', 'required' => [ 'deploymentId', ], 'members' => [ 'deploymentId' => [ 'shape' => 'DeploymentId', ], ], ], 'DeleteDeploymentOutput' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'DeploymentStatus', ], 'statusReason' => [ 'shape' => 'String', ], ], ], 'DeploymentConditionalField' => [ 'type' => 'structure', 'members' => [ 'comparator' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], ], 'DeploymentData' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'Timestamp', ], 'deletedAt' => [ 'shape' => 'Timestamp', ], 'deploymentArn' => [ 'shape' => 'String', ], 'id' => [ 'shape' => 'DeploymentId', ], 'name' => [ 'shape' => 'String', ], 'patternName' => [ 'shape' => 'DeploymentPatternName', ], 'resourceGroup' => [ 'shape' => 'String', ], 'specifications' => [ 'shape' => 'DeploymentSpecifications', ], 'status' => [ 'shape' => 'DeploymentStatus', ], 'tags' => [ 'shape' => 'Tags', ], 'workloadName' => [ 'shape' => 'WorkloadName', ], ], ], 'DeploymentDataSummary' => [ 'type' => 'structure', 'members' => [ 'createdAt' => [ 'shape' => 'Timestamp', ], 'id' => [ 'shape' => 'DeploymentId', ], 'name' => [ 'shape' => 'String', ], 'patternName' => [ 'shape' => 'DeploymentPatternName', ], 'status' => [ 'shape' => 'DeploymentStatus', ], 'workloadName' => [ 'shape' => 'WorkloadName', ], ], ], 'DeploymentDataSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentDataSummary', ], ], 'DeploymentEventDataSummary' => [ 'type' => 'structure', 'members' => [ 'description' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'EventStatus', ], 'statusReason' => [ 'shape' => 'String', ], 'timestamp' => [ 'shape' => 'Timestamp', ], ], ], 'DeploymentEventDataSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentEventDataSummary', ], ], 'DeploymentFilter' => [ 'type' => 'structure', 'members' => [ 'name' => [ 'shape' => 'DeploymentFilterKey', ], 'values' => [ 'shape' => 'DeploymentFilterValues', ], ], ], 'DeploymentFilterKey' => [ 'type' => 'string', 'enum' => [ 'WORKLOAD_NAME', 'DEPLOYMENT_STATUS', ], ], 'DeploymentFilterList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentFilter', ], 'min' => 1, ], 'DeploymentFilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentFilterValuesMemberString', ], ], 'DeploymentFilterValuesMemberString' => [ 'type' => 'string', 'max' => 100, 'min' => 1, ], 'DeploymentId' => [ 'type' => 'string', 'max' => 128, 'min' => 2, 'pattern' => '^[a-zA-Z0-9-]+$', ], 'DeploymentName' => [ 'type' => 'string', 'max' => 50, 'min' => 1, 'pattern' => '^[A-Za-z0-9_\\.-]+$', ], 'DeploymentPatternName' => [ 'type' => 'string', 'max' => 256, 'min' => 1, 'pattern' => '^[A-Za-z0-9][a-zA-Z0-9-]*$', ], 'DeploymentSpecifications' => [ 'type' => 'map', 'key' => [ 'shape' => 'KeyString', ], 'value' => [ 'shape' => 'ValueString', ], 'max' => 100, 'min' => 1, 'sensitive' => true, ], 'DeploymentSpecificationsData' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeploymentSpecificationsField', ], 'max' => 100, 'min' => 1, ], 'DeploymentSpecificationsField' => [ 'type' => 'structure', 'members' => [ 'allowedValues' => [ 'shape' => 'AllowedValues', ], 'conditionals' => [ 'shape' => 'SpecificationsConditionalData', ], 'description' => [ 'shape' => 'String', ], 'name' => [ 'shape' => 'String', ], 'required' => [ 'shape' => 'String', ], ], ], 'DeploymentStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETED', 'CREATING', 'DELETE_IN_PROGRESS', 'DELETE_INITIATING', 'DELETE_FAILED', 'DELETED', 'FAILED', 'IN_PROGRESS', 'VALIDATING', ], ], 'EventStatus' => [ 'type' => 'string', 'enum' => [ 'CANCELED', 'CANCELING', 'COMPLETED', 'CREATED', 'FAILED', 'IN_PROGRESS', 'PENDING', 'TIMED_OUT', ], ], 'GetDeploymentInput' => [ 'type' => 'structure', 'required' => [ 'deploymentId', ], 'members' => [ 'deploymentId' => [ 'shape' => 'DeploymentId', ], ], ], 'GetDeploymentOutput' => [ 'type' => 'structure', 'members' => [ 'deployment' => [ 'shape' => 'DeploymentData', ], ], ], 'GetWorkloadDeploymentPatternInput' => [ 'type' => 'structure', 'required' => [ 'deploymentPatternName', 'workloadName', ], 'members' => [ 'deploymentPatternName' => [ 'shape' => 'DeploymentPatternName', ], 'workloadName' => [ 'shape' => 'WorkloadName', ], ], ], 'GetWorkloadDeploymentPatternOutput' => [ 'type' => 'structure', 'members' => [ 'workloadDeploymentPattern' => [ 'shape' => 'WorkloadDeploymentPatternData', ], ], ], 'GetWorkloadInput' => [ 'type' => 'structure', 'required' => [ 'workloadName', ], 'members' => [ 'workloadName' => [ 'shape' => 'WorkloadName', ], ], ], 'GetWorkloadOutput' => [ 'type' => 'structure', 'members' => [ 'workload' => [ 'shape' => 'WorkloadData', ], ], ], 'InternalServerException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'KeyString' => [ 'type' => 'string', 'max' => 256, 'min' => 3, 'pattern' => '^[a-zA-Z0-9-:]+$', ], 'ListDeploymentEventsInput' => [ 'type' => 'structure', 'required' => [ 'deploymentId', ], 'members' => [ 'deploymentId' => [ 'shape' => 'DeploymentId', ], 'maxResults' => [ 'shape' => 'MaxDeploymentEventResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeploymentEventsOutput' => [ 'type' => 'structure', 'members' => [ 'deploymentEvents' => [ 'shape' => 'DeploymentEventDataSummaryList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeploymentsInput' => [ 'type' => 'structure', 'members' => [ 'filters' => [ 'shape' => 'DeploymentFilterList', ], 'maxResults' => [ 'shape' => 'MaxDeploymentResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListDeploymentsOutput' => [ 'type' => 'structure', 'members' => [ 'deployments' => [ 'shape' => 'DeploymentDataSummaryList', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceInput' => [ 'type' => 'structure', 'required' => [ 'resourceArn', ], 'members' => [ 'resourceArn' => [ 'shape' => 'String', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceOutput' => [ 'type' => 'structure', 'members' => [ 'tags' => [ 'shape' => 'Tags', ], ], ], 'ListWorkloadDeploymentPatternsInput' => [ 'type' => 'structure', 'required' => [ 'workloadName', ], 'members' => [ 'maxResults' => [ 'shape' => 'MaxWorkloadDeploymentPatternResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], 'workloadName' => [ 'shape' => 'WorkloadName', ], ], ], 'ListWorkloadDeploymentPatternsOutput' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'workloadDeploymentPatterns' => [ 'shape' => 'WorkloadDeploymentPatternDataSummaryList', ], ], ], 'ListWorkloadsInput' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'MaxWorkloadResults', ], 'nextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListWorkloadsOutput' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'NextToken', ], 'workloads' => [ 'shape' => 'WorkloadDataSummaryList', ], ], ], 'MaxDeploymentEventResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MaxDeploymentResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MaxWorkloadDeploymentPatternResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'MaxWorkloadResults' => [ 'type' => 'integer', 'box' => true, 'max' => 100, 'min' => 1, ], 'NextToken' => [ 'type' => 'string', 'max' => 1024, 'min' => 1, ], 'ResourceLimitException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 404, 'senderFault' => true, ], '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', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tags' => [ 'shape' => 'Tags', ], ], ], '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', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceOutput' => [ 'type' => 'structure', 'members' => [], ], 'ValidationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'String', ], ], 'error' => [ 'httpStatusCode' => 400, 'senderFault' => true, ], 'exception' => true, ], 'ValueString' => [ 'type' => 'string', 'max' => 1500, 'min' => 1, ], 'WorkloadData' => [ 'type' => 'structure', 'members' => [ 'description' => [ 'shape' => 'String', ], 'displayName' => [ 'shape' => 'String', ], 'documentationUrl' => [ 'shape' => 'String', ], 'iconUrl' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'WorkloadStatus', ], 'statusMessage' => [ 'shape' => 'String', ], 'workloadName' => [ 'shape' => 'WorkloadName', ], ], ], 'WorkloadDataSummary' => [ 'type' => 'structure', 'members' => [ 'displayName' => [ 'shape' => 'String', ], 'workloadName' => [ 'shape' => 'WorkloadName', ], ], ], 'WorkloadDataSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkloadDataSummary', ], ], 'WorkloadDeploymentPatternData' => [ 'type' => 'structure', 'members' => [ 'deploymentPatternName' => [ 'shape' => 'DeploymentPatternName', ], 'description' => [ 'shape' => 'String', ], 'displayName' => [ 'shape' => 'String', ], 'specifications' => [ 'shape' => 'DeploymentSpecificationsData', ], 'status' => [ 'shape' => 'WorkloadDeploymentPatternStatus', ], 'statusMessage' => [ 'shape' => 'String', ], 'workloadName' => [ 'shape' => 'WorkloadName', ], 'workloadVersionName' => [ 'shape' => 'WorkloadVersionName', ], ], ], 'WorkloadDeploymentPatternDataSummary' => [ 'type' => 'structure', 'members' => [ 'deploymentPatternName' => [ 'shape' => 'DeploymentPatternName', ], 'description' => [ 'shape' => 'String', ], 'displayName' => [ 'shape' => 'String', ], 'status' => [ 'shape' => 'WorkloadDeploymentPatternStatus', ], 'statusMessage' => [ 'shape' => 'String', ], 'workloadName' => [ 'shape' => 'WorkloadName', ], 'workloadVersionName' => [ 'shape' => 'WorkloadVersionName', ], ], ], 'WorkloadDeploymentPatternDataSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'WorkloadDeploymentPatternDataSummary', ], ], 'WorkloadDeploymentPatternStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', 'DISABLED', 'DELETED', ], ], 'WorkloadName' => [ 'type' => 'string', 'max' => 100, 'min' => 1, 'pattern' => '^[A-Za-z][a-zA-Z0-9-_]*$', ], 'WorkloadStatus' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'INACTIVE', 'DISABLED', 'DELETED', ], ], 'WorkloadVersionName' => [ 'type' => 'string', 'max' => 30, 'min' => 5, 'pattern' => '^[A-Za-z0-9][a-zA-Z0-9-]*$', ], ],]; diff --git a/src/data/launch-wizard/2018-05-10/docs-2.json b/src/data/launch-wizard/2018-05-10/docs-2.json index b578f87352..8175c00e52 100644 --- a/src/data/launch-wizard/2018-05-10/docs-2.json +++ b/src/data/launch-wizard/2018-05-10/docs-2.json @@ -6,12 +6,22 @@ "DeleteDeployment": "Deletes a deployment.
", "GetDeployment": "Returns information about the deployment.
", "GetWorkload": "Returns information about a workload.
", + "GetWorkloadDeploymentPattern": "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": "Lists the events of a deployment.
", "ListDeployments": "Lists the deployments that have been created.
", - "ListWorkloadDeploymentPatterns": "Lists the workload deployment patterns.
", - "ListWorkloads": "Lists the workloads.
" + "ListTagsForResource": "Lists the tags associated with a specified resource.
", + "ListWorkloadDeploymentPatterns": "Lists the workload deployment patterns for a given workload name. You can use the ListWorkloads operation to discover the available workload names.
", + "ListWorkloads": "Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload.
", + "TagResource": "Adds the specified tags to the given resource.
", + "UntagResource": "Removes the specified tags from the given resource.
" }, "shapes": { + "AllowedValues": { + "base": null, + "refs": { + "DeploymentSpecificationsField$allowedValues": "The allowed values of the deployment specification.
" + } + }, "Boolean": { "base": null, "refs": { @@ -38,6 +48,12 @@ "refs": { } }, + "DeploymentConditionalField": { + "base": "A field that details a condition of the specifications for a deployment.
", + "refs": { + "SpecificationsConditionalData$member": null + } + }, "DeploymentData": { "base": "The data associated with a deployment.
", "refs": { @@ -83,7 +99,7 @@ "DeploymentFilterList": { "base": null, "refs": { - "ListDeploymentsInput$filters": "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 name of the deployment pattern supported by a given workload. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.
The pattern name of the deployment.
", "DeploymentDataSummary$patternName": "The name of the workload deployment pattern.
", + "GetWorkloadDeploymentPatternInput$deploymentPatternName": "The name of the deployment pattern.
", + "WorkloadDeploymentPatternData$deploymentPatternName": "The name of the deployment pattern.
", "WorkloadDeploymentPatternDataSummary$deploymentPatternName": "The name of a workload deployment pattern.
" } }, "DeploymentSpecifications": { "base": null, "refs": { - "CreateDeploymentInput$specifications": "The settings specified for the deployment. For more information on the specifications required for creating a deployment, see Workload specifications.
", - "DeploymentData$specifications": "The specifications of the deployment. For more information on specifications for each deployment, see Workload specifications.
" + "CreateDeploymentInput$specifications": "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 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 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.
A field that details a specification of a deployment pattern.
", + "refs": { + "DeploymentSpecificationsData$member": null } }, "DeploymentStatus": { @@ -155,6 +185,16 @@ "refs": { } }, + "GetWorkloadDeploymentPatternInput": { + "base": null, + "refs": { + } + }, + "GetWorkloadDeploymentPatternOutput": { + "base": null, + "refs": { + } + }, "GetWorkloadInput": { "base": null, "refs": { @@ -196,6 +236,16 @@ "refs": { } }, + "ListTagsForResourceInput": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceOutput": { + "base": null, + "refs": { + } + }, "ListWorkloadDeploymentPatternsInput": { "base": null, "refs": { @@ -263,19 +313,35 @@ "refs": { } }, + "SpecificationsConditionalData": { + "base": null, + "refs": { + "DeploymentSpecificationsField$conditionals": "The conditionals used for the deployment specification.
" + } + }, "String": { "base": null, "refs": { "DeleteDeploymentOutput$statusReason": "The reason for the deployment status.
", + "DeploymentConditionalField$comparator": "The comparator of the condition.
Valid values: Equal | NotEqual
The name of the deployment condition.
", + "DeploymentConditionalField$value": "The value of the condition.
", + "DeploymentData$deploymentArn": "The Amazon Resource Name (ARN) of the deployment.
", "DeploymentData$name": "The name of the deployment.
", "DeploymentData$resourceGroup": "The resource group of the deployment.
", "DeploymentDataSummary$name": "The name of the deployment
", "DeploymentEventDataSummary$description": "The description of the deployment event.
", "DeploymentEventDataSummary$name": "The name of the deployment event.
", "DeploymentEventDataSummary$statusReason": "The reason of the deployment event status.
", + "DeploymentSpecificationsField$description": "The description of the deployment specification.
", + "DeploymentSpecificationsField$name": "The name of the deployment specification.
", + "DeploymentSpecificationsField$required": "Indicates if the deployment specification is required.
", "InternalServerException$message": null, + "ListTagsForResourceInput$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "ResourceLimitException$message": null, "ResourceNotFoundException$message": null, + "TagResourceInput$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", + "UntagResourceInput$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "ValidationException$message": null, "WorkloadData$description": "The description of a workload.
", "WorkloadData$displayName": "The display name of a workload.
", @@ -283,11 +349,52 @@ "WorkloadData$iconUrl": "The URL of a workload icon.
", "WorkloadData$statusMessage": "The message about a workload's status.
", "WorkloadDataSummary$displayName": "The display name of the workload data.
", + "WorkloadDeploymentPatternData$description": "The description of the deployment pattern.
", + "WorkloadDeploymentPatternData$displayName": "The display name of the deployment pattern.
", + "WorkloadDeploymentPatternData$statusMessage": "The status message of the deployment pattern.
", "WorkloadDeploymentPatternDataSummary$description": "The description of a workload deployment pattern.
", "WorkloadDeploymentPatternDataSummary$displayName": "The display name of a workload deployment pattern.
", "WorkloadDeploymentPatternDataSummary$statusMessage": "A message about a workload deployment pattern's status.
" } }, + "TagKey": { + "base": null, + "refs": { + "TagKeyList$member": null, + "Tags$key": null + } + }, + "TagKeyList": { + "base": null, + "refs": { + "UntagResourceInput$tagKeys": "Keys identifying the tags to remove.
" + } + }, + "TagResourceInput": { + "base": null, + "refs": { + } + }, + "TagResourceOutput": { + "base": null, + "refs": { + } + }, + "TagValue": { + "base": null, + "refs": { + "Tags$value": null + } + }, + "Tags": { + "base": null, + "refs": { + "CreateDeploymentInput$tags": "The tags to add to the deployment.
", + "DeploymentData$tags": "Information about the tags attached to a deployment.
", + "ListTagsForResourceOutput$tags": "Information about the tags.
", + "TagResourceInput$tags": "One or more tags to attach to the resource.
" + } + }, "Timestamp": { "base": null, "refs": { @@ -297,6 +404,16 @@ "DeploymentEventDataSummary$timestamp": "The timestamp of the deployment event.
" } }, + "UntagResourceInput": { + "base": null, + "refs": { + } + }, + "UntagResourceOutput": { + "base": null, + "refs": { + } + }, "ValidationException": { "base": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "refs": { @@ -305,6 +422,7 @@ "ValueString": { "base": null, "refs": { + "AllowedValues$member": null, "DeploymentSpecifications$value": null } }, @@ -326,6 +444,12 @@ "ListWorkloadsOutput$workloads": "Information about the workloads.
" } }, + "WorkloadDeploymentPatternData": { + "base": "The data that details a workload deployment pattern.
", + "refs": { + "GetWorkloadDeploymentPatternOutput$workloadDeploymentPattern": "Details about the workload deployment pattern.
" + } + }, "WorkloadDeploymentPatternDataSummary": { "base": "Describes a workload deployment pattern.
", "refs": { @@ -341,19 +465,22 @@ "WorkloadDeploymentPatternStatus": { "base": null, "refs": { + "WorkloadDeploymentPatternData$status": "The status of the deployment pattern.
", "WorkloadDeploymentPatternDataSummary$status": "The status of a workload deployment pattern.
" } }, "WorkloadName": { "base": null, "refs": { - "CreateDeploymentInput$workloadName": "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 name of the workload.
", "DeploymentDataSummary$workloadName": "The name of the workload.
", + "GetWorkloadDeploymentPatternInput$workloadName": "The name of the workload.
", "GetWorkloadInput$workloadName": "The name of the workload.
", "ListWorkloadDeploymentPatternsInput$workloadName": "The name of the workload.
", "WorkloadData$workloadName": "The name of the workload.
", "WorkloadDataSummary$workloadName": "The name of the workload.
", + "WorkloadDeploymentPatternData$workloadName": "The workload name of the deployment pattern.
", "WorkloadDeploymentPatternDataSummary$workloadName": "The name of the workload.
" } }, @@ -366,6 +493,7 @@ "WorkloadVersionName": { "base": null, "refs": { + "WorkloadDeploymentPatternData$workloadVersionName": "The workload version name of the deployment pattern.
", "WorkloadDeploymentPatternDataSummary$workloadVersionName": "The name of the workload deployment pattern version.
" } } diff --git a/src/data/launch-wizard/2018-05-10/docs-2.json.php b/src/data/launch-wizard/2018-05-10/docs-2.json.php index 1a85b5f84a..0a9ff9d074 100644 --- a/src/data/launch-wizard/2018-05-10/docs-2.json.php +++ b/src/data/launch-wizard/2018-05-10/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '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.
', 'operations' => [ 'CreateDeployment' => 'Creates a deployment for the given workload. Deployments created by this operation are not available in the Launch Wizard console to use the Clone deployment action on.
Deletes a deployment.
', 'GetDeployment' => 'Returns information about the deployment.
', 'GetWorkload' => 'Returns information about a workload.
', 'ListDeploymentEvents' => 'Lists the events of a deployment.
', 'ListDeployments' => 'Lists the deployments that have been created.
', 'ListWorkloadDeploymentPatterns' => 'Lists the workload deployment patterns.
', 'ListWorkloads' => 'Lists the workloads.
', ], 'shapes' => [ 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CreateDeploymentInput$dryRun' => 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The data associated with a deployment.
', 'refs' => [ 'GetDeploymentOutput$deployment' => 'An object that details the deployment.
', ], ], 'DeploymentDataSummary' => [ 'base' => 'A summary of the deployment data.
', 'refs' => [ 'DeploymentDataSummaryList$member' => NULL, ], ], 'DeploymentDataSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDeploymentsOutput$deployments' => 'Lists the deployments.
', ], ], 'DeploymentEventDataSummary' => [ 'base' => 'A summary of the deployment event data.
', 'refs' => [ 'DeploymentEventDataSummaryList$member' => NULL, ], ], 'DeploymentEventDataSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDeploymentEventsOutput$deploymentEvents' => 'Lists the deployment events.
', ], ], 'DeploymentFilter' => [ 'base' => 'A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria.
', 'refs' => [ 'DeploymentFilterList$member' => NULL, ], ], 'DeploymentFilterKey' => [ 'base' => NULL, 'refs' => [ 'DeploymentFilter$name' => 'The name of the filter. Filter names are case-sensitive.
', ], ], 'DeploymentFilterList' => [ 'base' => NULL, 'refs' => [ 'ListDeploymentsInput$filters' => 'Filters to scope the results. The following filters are supported:
WORKLOAD_NAME
DEPLOYMENT_STATUS
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
The ID of the deployment.
', 'DeleteDeploymentInput$deploymentId' => 'The ID of the deployment.
', 'DeploymentData$id' => 'The ID of the deployment.
', 'DeploymentDataSummary$id' => 'The ID of the deployment.
', 'GetDeploymentInput$deploymentId' => 'The ID of the deployment.
', 'ListDeploymentEventsInput$deploymentId' => 'The ID of the deployment.
', ], ], 'DeploymentName' => [ 'base' => NULL, 'refs' => [ 'CreateDeploymentInput$name' => 'The name of the deployment.
', ], ], 'DeploymentPatternName' => [ 'base' => NULL, 'refs' => [ 'CreateDeploymentInput$deploymentPatternName' => 'The name of the deployment pattern supported by a given workload. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.
The pattern name of the deployment.
', 'DeploymentDataSummary$patternName' => 'The name of the workload deployment pattern.
', 'WorkloadDeploymentPatternDataSummary$deploymentPatternName' => 'The name of a workload deployment pattern.
', ], ], 'DeploymentSpecifications' => [ 'base' => NULL, 'refs' => [ 'CreateDeploymentInput$specifications' => 'The settings specified for the deployment. For more information on the specifications required for creating a deployment, see Workload specifications.
', 'DeploymentData$specifications' => 'The specifications of the deployment. For more information on specifications for each deployment, see Workload specifications.
', ], ], 'DeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'DeleteDeploymentOutput$status' => 'The status of the deployment.
', 'DeploymentData$status' => 'The status of the deployment.
', 'DeploymentDataSummary$status' => 'The status of the deployment.
', ], ], 'EventStatus' => [ 'base' => NULL, 'refs' => [ 'DeploymentEventDataSummary$status' => 'The status of the deployment event.
', ], ], 'GetDeploymentInput' => [ 'base' => NULL, 'refs' => [], ], 'GetDeploymentOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkloadInput' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkloadOutput' => [ 'base' => NULL, 'refs' => [], ], 'InternalServerException' => [ 'base' => 'An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.
', 'refs' => [], ], 'KeyString' => [ 'base' => NULL, 'refs' => [ 'DeploymentSpecifications$key' => NULL, ], ], 'ListDeploymentEventsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListDeploymentEventsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListDeploymentsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListDeploymentsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkloadDeploymentPatternsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkloadDeploymentPatternsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkloadsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkloadsOutput' => [ 'base' => NULL, 'refs' => [], ], 'MaxDeploymentEventResults' => [ 'base' => NULL, 'refs' => [ 'ListDeploymentEventsInput$maxResults' => 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
', ], ], 'MaxDeploymentResults' => [ 'base' => NULL, 'refs' => [ 'ListDeploymentsInput$maxResults' => 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
', ], ], 'MaxWorkloadDeploymentPatternResults' => [ 'base' => NULL, 'refs' => [ 'ListWorkloadDeploymentPatternsInput$maxResults' => 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
', ], ], 'MaxWorkloadResults' => [ 'base' => NULL, 'refs' => [ 'ListWorkloadsInput$maxResults' => 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListDeploymentEventsInput$nextToken' => 'The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
', 'ListDeploymentEventsOutput$nextToken' => 'The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
', 'ListDeploymentsOutput$nextToken' => 'The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
', 'ListWorkloadDeploymentPatternsOutput$nextToken' => 'The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
', 'ListWorkloadsOutput$nextToken' => 'The token to include in another request to get the next page of items. This value is null when there are no more items to return.
You have exceeded an Launch Wizard resource limit. For example, you might have too many deployments in progress.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'The specified workload or deployment resource can\'t be found.
', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'DeleteDeploymentOutput$statusReason' => 'The reason for the deployment status.
', 'DeploymentData$name' => 'The name of the deployment.
', 'DeploymentData$resourceGroup' => 'The resource group of the deployment.
', 'DeploymentDataSummary$name' => 'The name of the deployment
', 'DeploymentEventDataSummary$description' => 'The description of the deployment event.
', 'DeploymentEventDataSummary$name' => 'The name of the deployment event.
', 'DeploymentEventDataSummary$statusReason' => 'The reason of the deployment event status.
', 'InternalServerException$message' => NULL, 'ResourceLimitException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'ValidationException$message' => NULL, 'WorkloadData$description' => 'The description of a workload.
', 'WorkloadData$displayName' => 'The display name of a workload.
', 'WorkloadData$documentationUrl' => 'The URL of a workload document.
', 'WorkloadData$iconUrl' => 'The URL of a workload icon.
', 'WorkloadData$statusMessage' => 'The message about a workload\'s status.
', 'WorkloadDataSummary$displayName' => 'The display name of the workload data.
', 'WorkloadDeploymentPatternDataSummary$description' => 'The description of a workload deployment pattern.
', 'WorkloadDeploymentPatternDataSummary$displayName' => 'The display name of a workload deployment pattern.
', 'WorkloadDeploymentPatternDataSummary$statusMessage' => 'A message about a workload deployment pattern\'s status.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'DeploymentData$createdAt' => 'The time the deployment was created.
', 'DeploymentData$deletedAt' => 'The time the deployment was deleted.
', 'DeploymentDataSummary$createdAt' => 'The time the deployment was created.
', 'DeploymentEventDataSummary$timestamp' => 'The timestamp of the deployment event.
', ], ], 'ValidationException' => [ 'base' => 'The input fails to satisfy the constraints specified by an Amazon Web Services service.
', 'refs' => [], ], 'ValueString' => [ 'base' => NULL, 'refs' => [ 'DeploymentSpecifications$value' => NULL, ], ], 'WorkloadData' => [ 'base' => 'Describes a workload.
', 'refs' => [ 'GetWorkloadOutput$workload' => 'Information about the workload.
', ], ], 'WorkloadDataSummary' => [ 'base' => 'Describes workload data.
', 'refs' => [ 'WorkloadDataSummaryList$member' => NULL, ], ], 'WorkloadDataSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListWorkloadsOutput$workloads' => 'Information about the workloads.
', ], ], 'WorkloadDeploymentPatternDataSummary' => [ 'base' => 'Describes a workload deployment pattern.
', 'refs' => [ 'WorkloadDeploymentPatternDataSummaryList$member' => NULL, ], ], 'WorkloadDeploymentPatternDataSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListWorkloadDeploymentPatternsOutput$workloadDeploymentPatterns' => 'Describes the workload deployment patterns.
', ], ], 'WorkloadDeploymentPatternStatus' => [ 'base' => NULL, 'refs' => [ 'WorkloadDeploymentPatternDataSummary$status' => 'The status of a workload deployment pattern.
', ], ], 'WorkloadName' => [ 'base' => NULL, 'refs' => [ 'CreateDeploymentInput$workloadName' => 'The name of the workload. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.
The name of the workload.
', 'DeploymentDataSummary$workloadName' => 'The name of the workload.
', 'GetWorkloadInput$workloadName' => 'The name of the workload.
', 'ListWorkloadDeploymentPatternsInput$workloadName' => 'The name of the workload.
', 'WorkloadData$workloadName' => 'The name of the workload.
', 'WorkloadDataSummary$workloadName' => 'The name of the workload.
', 'WorkloadDeploymentPatternDataSummary$workloadName' => 'The name of the workload.
', ], ], 'WorkloadStatus' => [ 'base' => NULL, 'refs' => [ 'WorkloadData$status' => 'The status of a workload.
', ], ], 'WorkloadVersionName' => [ 'base' => NULL, 'refs' => [ 'WorkloadDeploymentPatternDataSummary$workloadVersionName' => 'The name of the workload deployment pattern version.
', ], ], ],]; +return [ 'version' => '2.0', 'service' => '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.
', 'operations' => [ 'CreateDeployment' => 'Creates a deployment for the given workload. Deployments created by this operation are not available in the Launch Wizard console to use the Clone deployment action on.
Deletes a deployment.
', 'GetDeployment' => 'Returns information about the deployment.
', 'GetWorkload' => 'Returns information about a workload.
', 'GetWorkloadDeploymentPattern' => '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' => 'Lists the events of a deployment.
', 'ListDeployments' => 'Lists the deployments that have been created.
', 'ListTagsForResource' => 'Lists the tags associated with a specified resource.
', 'ListWorkloadDeploymentPatterns' => 'Lists the workload deployment patterns for a given workload name. You can use the ListWorkloads operation to discover the available workload names.
', 'ListWorkloads' => 'Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload.
', 'TagResource' => 'Adds the specified tags to the given resource.
', 'UntagResource' => 'Removes the specified tags from the given resource.
', ], 'shapes' => [ 'AllowedValues' => [ 'base' => NULL, 'refs' => [ 'DeploymentSpecificationsField$allowedValues' => 'The allowed values of the deployment specification.
', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'CreateDeploymentInput$dryRun' => 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
A field that details a condition of the specifications for a deployment.
', 'refs' => [ 'SpecificationsConditionalData$member' => NULL, ], ], 'DeploymentData' => [ 'base' => 'The data associated with a deployment.
', 'refs' => [ 'GetDeploymentOutput$deployment' => 'An object that details the deployment.
', ], ], 'DeploymentDataSummary' => [ 'base' => 'A summary of the deployment data.
', 'refs' => [ 'DeploymentDataSummaryList$member' => NULL, ], ], 'DeploymentDataSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDeploymentsOutput$deployments' => 'Lists the deployments.
', ], ], 'DeploymentEventDataSummary' => [ 'base' => 'A summary of the deployment event data.
', 'refs' => [ 'DeploymentEventDataSummaryList$member' => NULL, ], ], 'DeploymentEventDataSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListDeploymentEventsOutput$deploymentEvents' => 'Lists the deployment events.
', ], ], 'DeploymentFilter' => [ 'base' => 'A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria.
', 'refs' => [ 'DeploymentFilterList$member' => NULL, ], ], 'DeploymentFilterKey' => [ 'base' => NULL, 'refs' => [ 'DeploymentFilter$name' => 'The name of the filter. Filter names are case-sensitive.
', ], ], 'DeploymentFilterList' => [ 'base' => NULL, 'refs' => [ 'ListDeploymentsInput$filters' => '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 filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
The ID of the deployment.
', 'DeleteDeploymentInput$deploymentId' => 'The ID of the deployment.
', 'DeploymentData$id' => 'The ID of the deployment.
', 'DeploymentDataSummary$id' => 'The ID of the deployment.
', 'GetDeploymentInput$deploymentId' => 'The ID of the deployment.
', 'ListDeploymentEventsInput$deploymentId' => 'The ID of the deployment.
', ], ], 'DeploymentName' => [ 'base' => NULL, 'refs' => [ 'CreateDeploymentInput$name' => 'The name of the deployment.
', ], ], 'DeploymentPatternName' => [ 'base' => NULL, 'refs' => [ 'CreateDeploymentInput$deploymentPatternName' => 'The name of the deployment pattern supported by a given workload. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.
The pattern name of the deployment.
', 'DeploymentDataSummary$patternName' => 'The name of the workload deployment pattern.
', 'GetWorkloadDeploymentPatternInput$deploymentPatternName' => 'The name of the deployment pattern.
', 'WorkloadDeploymentPatternData$deploymentPatternName' => 'The name of the deployment pattern.
', 'WorkloadDeploymentPatternDataSummary$deploymentPatternName' => 'The name of a workload deployment pattern.
', ], ], 'DeploymentSpecifications' => [ 'base' => NULL, 'refs' => [ 'CreateDeploymentInput$specifications' => '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 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 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.
A field that details a specification of a deployment pattern.
', 'refs' => [ 'DeploymentSpecificationsData$member' => NULL, ], ], 'DeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'DeleteDeploymentOutput$status' => 'The status of the deployment.
', 'DeploymentData$status' => 'The status of the deployment.
', 'DeploymentDataSummary$status' => 'The status of the deployment.
', ], ], 'EventStatus' => [ 'base' => NULL, 'refs' => [ 'DeploymentEventDataSummary$status' => 'The status of the deployment event.
', ], ], 'GetDeploymentInput' => [ 'base' => NULL, 'refs' => [], ], 'GetDeploymentOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkloadDeploymentPatternInput' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkloadDeploymentPatternOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkloadInput' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkloadOutput' => [ 'base' => NULL, 'refs' => [], ], 'InternalServerException' => [ 'base' => 'An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.
', 'refs' => [], ], 'KeyString' => [ 'base' => NULL, 'refs' => [ 'DeploymentSpecifications$key' => NULL, ], ], 'ListDeploymentEventsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListDeploymentEventsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListDeploymentsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListDeploymentsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkloadDeploymentPatternsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkloadDeploymentPatternsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkloadsInput' => [ 'base' => NULL, 'refs' => [], ], 'ListWorkloadsOutput' => [ 'base' => NULL, 'refs' => [], ], 'MaxDeploymentEventResults' => [ 'base' => NULL, 'refs' => [ 'ListDeploymentEventsInput$maxResults' => 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
', ], ], 'MaxDeploymentResults' => [ 'base' => NULL, 'refs' => [ 'ListDeploymentsInput$maxResults' => 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
', ], ], 'MaxWorkloadDeploymentPatternResults' => [ 'base' => NULL, 'refs' => [ 'ListWorkloadDeploymentPatternsInput$maxResults' => 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
', ], ], 'MaxWorkloadResults' => [ 'base' => NULL, 'refs' => [ 'ListWorkloadsInput$maxResults' => 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListDeploymentEventsInput$nextToken' => 'The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
', 'ListDeploymentEventsOutput$nextToken' => 'The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
', 'ListDeploymentsOutput$nextToken' => 'The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
', 'ListWorkloadDeploymentPatternsOutput$nextToken' => 'The token to include in another request to get the next page of items. This value is null when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
', 'ListWorkloadsOutput$nextToken' => 'The token to include in another request to get the next page of items. This value is null when there are no more items to return.
You have exceeded an Launch Wizard resource limit. For example, you might have too many deployments in progress.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'The specified workload or deployment resource can\'t be found.
', 'refs' => [], ], 'SpecificationsConditionalData' => [ 'base' => NULL, 'refs' => [ 'DeploymentSpecificationsField$conditionals' => 'The conditionals used for the deployment specification.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'DeleteDeploymentOutput$statusReason' => 'The reason for the deployment status.
', 'DeploymentConditionalField$comparator' => 'The comparator of the condition.
Valid values: Equal | NotEqual
The name of the deployment condition.
', 'DeploymentConditionalField$value' => 'The value of the condition.
', 'DeploymentData$deploymentArn' => 'The Amazon Resource Name (ARN) of the deployment.
', 'DeploymentData$name' => 'The name of the deployment.
', 'DeploymentData$resourceGroup' => 'The resource group of the deployment.
', 'DeploymentDataSummary$name' => 'The name of the deployment
', 'DeploymentEventDataSummary$description' => 'The description of the deployment event.
', 'DeploymentEventDataSummary$name' => 'The name of the deployment event.
', 'DeploymentEventDataSummary$statusReason' => 'The reason of the deployment event status.
', 'DeploymentSpecificationsField$description' => 'The description of the deployment specification.
', 'DeploymentSpecificationsField$name' => 'The name of the deployment specification.
', 'DeploymentSpecificationsField$required' => 'Indicates if the deployment specification is required.
', 'InternalServerException$message' => NULL, 'ListTagsForResourceInput$resourceArn' => 'The Amazon Resource Name (ARN) of the resource.
', 'ResourceLimitException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'TagResourceInput$resourceArn' => 'The Amazon Resource Name (ARN) of the resource.
', 'UntagResourceInput$resourceArn' => 'The Amazon Resource Name (ARN) of the resource.
', 'ValidationException$message' => NULL, 'WorkloadData$description' => 'The description of a workload.
', 'WorkloadData$displayName' => 'The display name of a workload.
', 'WorkloadData$documentationUrl' => 'The URL of a workload document.
', 'WorkloadData$iconUrl' => 'The URL of a workload icon.
', 'WorkloadData$statusMessage' => 'The message about a workload\'s status.
', 'WorkloadDataSummary$displayName' => 'The display name of the workload data.
', 'WorkloadDeploymentPatternData$description' => 'The description of the deployment pattern.
', 'WorkloadDeploymentPatternData$displayName' => 'The display name of the deployment pattern.
', 'WorkloadDeploymentPatternData$statusMessage' => 'The status message of the deployment pattern.
', 'WorkloadDeploymentPatternDataSummary$description' => 'The description of a workload deployment pattern.
', 'WorkloadDeploymentPatternDataSummary$displayName' => 'The display name of a workload deployment pattern.
', 'WorkloadDeploymentPatternDataSummary$statusMessage' => 'A message about a workload deployment pattern\'s status.
', ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'TagKeyList$member' => NULL, 'Tags$key' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceInput$tagKeys' => 'Keys identifying the tags to remove.
', ], ], 'TagResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tags$value' => NULL, ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'CreateDeploymentInput$tags' => 'The tags to add to the deployment.
', 'DeploymentData$tags' => 'Information about the tags attached to a deployment.
', 'ListTagsForResourceOutput$tags' => 'Information about the tags.
', 'TagResourceInput$tags' => 'One or more tags to attach to the resource.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'DeploymentData$createdAt' => 'The time the deployment was created.
', 'DeploymentData$deletedAt' => 'The time the deployment was deleted.
', 'DeploymentDataSummary$createdAt' => 'The time the deployment was created.
', 'DeploymentEventDataSummary$timestamp' => 'The timestamp of the deployment event.
', ], ], 'UntagResourceInput' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceOutput' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => 'The input fails to satisfy the constraints specified by an Amazon Web Services service.
', 'refs' => [], ], 'ValueString' => [ 'base' => NULL, 'refs' => [ 'AllowedValues$member' => NULL, 'DeploymentSpecifications$value' => NULL, ], ], 'WorkloadData' => [ 'base' => 'Describes a workload.
', 'refs' => [ 'GetWorkloadOutput$workload' => 'Information about the workload.
', ], ], 'WorkloadDataSummary' => [ 'base' => 'Describes workload data.
', 'refs' => [ 'WorkloadDataSummaryList$member' => NULL, ], ], 'WorkloadDataSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListWorkloadsOutput$workloads' => 'Information about the workloads.
', ], ], 'WorkloadDeploymentPatternData' => [ 'base' => 'The data that details a workload deployment pattern.
', 'refs' => [ 'GetWorkloadDeploymentPatternOutput$workloadDeploymentPattern' => 'Details about the workload deployment pattern.
', ], ], 'WorkloadDeploymentPatternDataSummary' => [ 'base' => 'Describes a workload deployment pattern.
', 'refs' => [ 'WorkloadDeploymentPatternDataSummaryList$member' => NULL, ], ], 'WorkloadDeploymentPatternDataSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListWorkloadDeploymentPatternsOutput$workloadDeploymentPatterns' => 'Describes the workload deployment patterns.
', ], ], 'WorkloadDeploymentPatternStatus' => [ 'base' => NULL, 'refs' => [ 'WorkloadDeploymentPatternData$status' => 'The status of the deployment pattern.
', 'WorkloadDeploymentPatternDataSummary$status' => 'The status of a workload deployment pattern.
', ], ], 'WorkloadName' => [ 'base' => NULL, 'refs' => [ 'CreateDeploymentInput$workloadName' => 'The name of the workload. You can use the ListWorkloads operation to discover supported values for this parameter.
The name of the workload.
', 'DeploymentDataSummary$workloadName' => 'The name of the workload.
', 'GetWorkloadDeploymentPatternInput$workloadName' => 'The name of the workload.
', 'GetWorkloadInput$workloadName' => 'The name of the workload.
', 'ListWorkloadDeploymentPatternsInput$workloadName' => 'The name of the workload.
', 'WorkloadData$workloadName' => 'The name of the workload.
', 'WorkloadDataSummary$workloadName' => 'The name of the workload.
', 'WorkloadDeploymentPatternData$workloadName' => 'The workload name of the deployment pattern.
', 'WorkloadDeploymentPatternDataSummary$workloadName' => 'The name of the workload.
', ], ], 'WorkloadStatus' => [ 'base' => NULL, 'refs' => [ 'WorkloadData$status' => 'The status of a workload.
', ], ], 'WorkloadVersionName' => [ 'base' => NULL, 'refs' => [ 'WorkloadDeploymentPatternData$workloadVersionName' => 'The workload version name of the deployment pattern.
', 'WorkloadDeploymentPatternDataSummary$workloadVersionName' => 'The name of the workload deployment pattern version.
', ], ], ],]; diff --git a/src/data/launch-wizard/2018-05-10/endpoint-tests-1.json b/src/data/launch-wizard/2018-05-10/endpoint-tests-1.json index 850ed0a8fd..33502c9dc8 100644 --- a/src/data/launch-wizard/2018-05-10/endpoint-tests-1.json +++ b/src/data/launch-wizard/2018-05-10/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" diff --git a/src/data/launch-wizard/2018-05-10/endpoint-tests-1.json.php b/src/data/launch-wizard/2018-05-10/endpoint-tests-1.json.php index 262c9404ee..cf163988ce 100644 --- a/src/data/launch-wizard/2018-05-10/endpoint-tests-1.json.php +++ b/src/data/launch-wizard/2018-05-10/endpoint-tests-1.json.php @@ -1,3 +1,3 @@ [ [ 'documentation' => 'For region us-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard-fips.us-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard-fips.us-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard.us-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard.us-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard-fips.cn-north-1.api.amazonwebservices.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard-fips.cn-north-1.amazonaws.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard.cn-north-1.api.amazonwebservices.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard.cn-north-1.amazonaws.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard-fips.us-gov-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard-fips.us-gov-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard.us-gov-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard.us-gov-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard-fips.us-iso-east-1.c2s.ic.gov', ], ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'error' => 'DualStack is enabled but this partition does not support DualStack', ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard.us-iso-east-1.c2s.ic.gov', ], ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard-fips.us-isob-east-1.sc2s.sgov.gov', ], ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'error' => 'DualStack is enabled but this partition does not support DualStack', ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard.us-isob-east-1.sc2s.sgov.gov', ], ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For custom endpoint with region set and fips disabled and dualstack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://example.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with region not set and fips disabled and dualstack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://example.com', ], ], 'params' => [ 'UseFIPS' => false, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with fips enabled and dualstack disabled', 'expect' => [ 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with fips disabled and dualstack enabled', 'expect' => [ 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => true, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'Missing region', 'expect' => [ 'error' => 'Invalid Configuration: Missing Region', ], ], [ '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',]; +return [ 'testCases' => [ [ 'documentation' => 'For region us-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard-fips.us-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard-fips.us-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard.us-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard.us-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard-fips.cn-north-1.api.amazonwebservices.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard-fips.cn-north-1.amazonaws.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard.cn-north-1.api.amazonwebservices.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region cn-north-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard.cn-north-1.amazonaws.com.cn', ], ], 'params' => [ 'Region' => 'cn-north-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard-fips.us-gov-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard-fips.us-gov-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard.us-gov-east-1.api.aws', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-gov-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard.us-gov-east-1.amazonaws.com', ], ], 'params' => [ 'Region' => 'us-gov-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard-fips.us-iso-east-1.c2s.ic.gov', ], ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'error' => 'DualStack is enabled but this partition does not support DualStack', ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-iso-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard.us-iso-east-1.c2s.ic.gov', ], ], 'params' => [ 'Region' => 'us-iso-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS enabled and DualStack enabled', 'expect' => [ 'error' => 'FIPS and DualStack are enabled, but this partition does not support one or both', ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => true, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS enabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard-fips.us-isob-east-1.sc2s.sgov.gov', ], ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => true, 'UseDualStack' => false, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS disabled and DualStack enabled', 'expect' => [ 'error' => 'DualStack is enabled but this partition does not support DualStack', ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => false, 'UseDualStack' => true, ], ], [ 'documentation' => 'For region us-isob-east-1 with FIPS disabled and DualStack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://launchwizard.us-isob-east-1.sc2s.sgov.gov', ], ], 'params' => [ 'Region' => 'us-isob-east-1', 'UseFIPS' => false, 'UseDualStack' => false, ], ], [ 'documentation' => 'For custom endpoint with region set and fips disabled and dualstack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://example.com', ], ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with region not set and fips disabled and dualstack disabled', 'expect' => [ 'endpoint' => [ 'url' => 'https://example.com', ], ], 'params' => [ 'UseFIPS' => false, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with fips enabled and dualstack disabled', 'expect' => [ 'error' => 'Invalid Configuration: FIPS and custom endpoint are not supported', ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => true, 'UseDualStack' => false, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'For custom endpoint with fips disabled and dualstack enabled', 'expect' => [ 'error' => 'Invalid Configuration: Dualstack and custom endpoint are not supported', ], 'params' => [ 'Region' => 'us-east-1', 'UseFIPS' => false, 'UseDualStack' => true, 'Endpoint' => 'https://example.com', ], ], [ 'documentation' => 'Missing region', 'expect' => [ 'error' => 'Invalid Configuration: Missing Region', ], ], ], 'version' => '1.0',];